lebeg commented on a change in pull request #12388: Installation instructions consolidation URL: https://github.com/apache/incubator-mxnet/pull/12388#discussion_r213951071
########## File path: docs/install/build_from_source.md ########## @@ -350,143 +178,56 @@ make -j"$(nproc)" nosetests --verbose tests/python/gpu/test_nccl.py ``` -## Recommendation for best performance +**Recommendation to get the best performance out of NCCL:** It is recommended to set environment variable NCCL_LAUNCH_MODE to PARALLEL when using NCCL version 2.1 or newer. -</div> - -## Build the C++ package -The C++ package has the same prerequisites as the MXNet library, you should also have `python` installed. (Both `python` 2 and 3 are supported) - -To enable C++ package, just add `USE_CPP_PACKAGE=1` in the build options when building the MXNet shared library. - -## Build the R package +### Build MXNet with Language Packages +* To enable C++ package, just add `USE_CPP_PACKAGE=1` when you run `make` or `cmake`. -The R package requires `R` to be installed. -<div class="ubuntu"> - -Follow the below instructions to install the latest R on Ubuntu 14.04 (trusty) and also the libraries used -to build other R package dependencies. +### Usage Examples +* `-j` runs multiple jobs against multi-core CPUs. Example using all cores on Linux: ```bash -echo "deb http://cran.rstudio.com/bin/linux/ubuntu trusty/" >> /etc/apt/sources.list -gpg --keyserver keyserver.ubuntu.com --recv-key E084DAB9 -gpg -a --export E084DAB9 | apt-key add - - -apt-get update -apt-get install -y r-base r-base-dev libxml2-dev libxt-dev libssl-dev +make -j$(nproc) ``` -</div> - -Install the required R package dependencies: +* Build without using OpenCV: ```bash -cd R-package -Rscript -e "install.packages('devtools', repo = 'https://cran.rstudio.com')" -Rscript -e "library(devtools); library(methods); options(repos=c(CRAN='https://cran.rstudio.com')); install_deps(dependencies = TRUE)" +make USE_OPENCV=0 ``` -Next, build and install the MXNet R package: +* Build with both OpenBLAS, GPU, and OpenCV support: ```bash -cd .. -make rpkg +make -j USE_BLAS=openblas USE_CUDA=1 USE_CUDA_PATH=/usr/local/cuda USE_CUDNN=1 ``` -## Build the Scala package - -Both JDK and Maven are required to build the Scala package. - -<div class="ubuntu"> +* Build on **macOS** with the default BLAS library and clang installed with `xcode` (OPENMP is disabled because it is not supported in default by clang): Review comment: Build on **macOS** with the default BLAS library and Clang installed with `xcode` (OpenMP is disabled because it is not supported by default by Apple version of Clang): ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
