doc updates - build options

This commit is contained in:
Dan Timson
2019-02-22 12:02:46 +00:00
parent 16e870ce11
commit 331de2a1d3
2 changed files with 26 additions and 2 deletions
+7 -2
View File
@@ -148,7 +148,7 @@ information:
$ cmake -D DEBUG=ON -D PROFILE=ON ../
Options are specified with the -D flag. A list of options allowed:
Options are specified with the -D flag. The allowed options include:
DEBUG=(ON/OFF): compile with debugging symbols
PROFILE=(ON/OFF): compile with profiling symbols
@@ -159,11 +159,16 @@ Options are specified with the -D flag. A list of options allowed:
BUILD_CLI_EXECUTABLES=(ON/OFF): whether or not to build command-line programs
BUILD_PYTHON_BINDINGS=(ON/OFF): whether or not to build Python bindings
BUILD_TESTS=(ON/OFF): whether or not to build tests
BUILD_SHARED_LIBS=(ON/OFF): compile shared libraries as opposed to
static libraries
DOWNLOAD_ENSMALLEN=(ON/OFF): If ensmallen is not found, download it
ENSMALLEN_INCLUDE_DIR=(/path/to/ensmallen/include): path to include directory
for ensmallen
USE_OPENMP=(ON/OFF): whether or not to use OpenMP if available
Other tools can also be used to configure CMake, but those are not documented
here. See [this section of the build guide](http://www.mlpack.org/docs/mlpack-git/doxygen/build.html#build_config)
for more details.
for more details, including a full list of options, and their default values.
By default, command-line programs will be built, and if the Python dependencies
(Cython, setuptools, numpy, pandas) are available, then Python bindings will
+19
View File
@@ -138,10 +138,18 @@ The full list of options mlpack allows:
(default ON)
- BUILD_PYTHON_BINDINGS=(ON/OFF): compile the bindings for Python, if the
necessary Python libraries are available (default ON except on Windows)
- MATLAB_BINDINGS=(ON/OFF): Compile MATLAB bindings if MATLAB is found
(default OFF)
- BUILD_SHARED_LIBS=(ON/OFF): compile shared libraries as opposed to
static libraries (default ON)
- TEST_VERBOSE=(ON/OFF): run test cases in \c mlpack_test with verbose output
(default OFF)
- DOWNLOAD_ENSMALLEN=(ON/OFF): If ensmallen is not found, download it
(default ON)
- BUILD_WITH_COVERAGE=(ON/OFF): Build with support for code coverage tools
(gcc only) (default OFF)
- BUILD_MARKDOWN_BINDINGS=(ON/OFF): Build Markdown bindings for website
documentation (default OFF)
- MATHJAX=(ON/OFF): use MathJax for generated Doxygen documentation (default
OFF)
- FORCE_CXX11=(ON/OFF): assume that the compiler supports C++11 instead of
@@ -153,6 +161,17 @@ The full list of options mlpack allows:
Each option can be specified to CMake with the '-D' flag. Other tools can also
be used to configure CMake, but those are not documented here.
In addition, the following directories may be specified, to find include files
and libraries. These also use the '-D' flag.
- ARMADILLO_INCLUDE_DIR=(/path/to/armadillo/include/): path to Armadillo headers
- ARMADILLO_LIBRARY=(/path/to/armadillo/libarmadillo.so): location of Armadillo
library
- BOOST_ROOT=(/path/to/boost/): path to root of boost installation
- ENSMALLEN_INCLUDE_DIR=(/path/to/ensmallen/include): path to include directory
for ensmallen
- MATHJAX_ROOT=(/path/to/mathjax): path to root of MathJax installation
@section build_build Building mlpack
Once CMake is configured, building the library is as simple as typing 'make'.