Update documentation for header-only changes.

This commit is contained in:
Ryan Curtin
2022-07-31 13:54:41 -04:00
parent 683a93d8a4
commit 260aebb11d
4 changed files with 17 additions and 39 deletions
+11 -27
View File
@@ -26,12 +26,12 @@ src="https://cdn.rawgit.com/mlpack/mlpack.org/e7d36ed8/mlpack-black.svg" style="
</em>
</p>
**mlpack** is an intuitive, fast, and flexible C++ machine learning library with
bindings to other languages. It is meant to be a machine learning analog to
LAPACK, and aims to implement a wide array of machine learning methods and
functions as a "swiss army knife" for machine learning researchers. In addition
to its powerful C++ interface, mlpack also provides command-line programs,
Python bindings, Julia bindings, Go bindings and R bindings.
**mlpack** is an intuitive, fast, and flexible header-only C++ machine learning
library with bindings to other languages. It is meant to be a machine learning
analog to LAPACK, and aims to implement a wide array of machine learning methods
and functions as a "swiss army knife" for machine learning researchers. In
addition to its powerful C++ interface, mlpack also provides command-line
programs, Python bindings, Julia bindings, Go bindings and R bindings.
[//]: # (numfocus-fiscal-sponsor-attribution)
@@ -226,8 +226,8 @@ Options are specified with the -D flag. The allowed options include:
BUILD_DOCS=(ON/OFF): build Doxygen documentation, if Doxygen is available
(default ON)
For example, to build mlpack library and CLI bindings statically the following
command can be used:
For example, to build mlpack's CLI bindings statically the following command can
be used:
$ cmake -D BUILD_SHARED_LIBS=OFF ../
@@ -269,31 +269,15 @@ to those three directories), and simply type
$ make install
You can now run the executables by name; you can link against mlpack with
`-lmlpack`
and the mlpack headers are found in
You can now run the executables by name; the mlpack headers are found in
`/usr/local/include/mlpack/`
and if Python bindings were built, you can access them with the `mlpack`
package in Python.
If running the programs (i.e. `$ mlpack_knn -h`) gives an error of the form
error while loading shared libraries: libmlpack.so.2: cannot open shared object file: No such file or directory
then be sure that the runtime linker is searching the directory where
`libmlpack.so` was installed (probably `/usr/local/lib/` unless you set it
manually). One way to do this, on Linux, is to ensure that the
`LD_LIBRARY_PATH` environment variable has the directory that contains
`libmlpack.so`. Using bash, this can be set easily:
export LD_LIBRARY_PATH="/usr/local/lib/:$LD_LIBRARY_PATH"
(or whatever directory `libmlpack.so` is installed in.)
### 5. Running mlpack programs
After building mlpack, the executables will reside in `build/bin/`. You can call
them from there, or you can install the library and (depending on system
After building mlpack, the executables will reside in `build/bin/`. You can
call them from there, or you can install the library and (depending on system
settings) they should be added to your PATH and you can call them directly. The
documentation below assumes the executables are in your PATH.
@@ -109,11 +109,10 @@
<Link>
<SubSystem>Console</SubSystem>
<GenerateDebugInformation>true</GenerateDebugInformation>
<AdditionalDependencies>C:\mlpack\mlpack-3.4.2\build\Debug\mlpack.lib;%(AdditionalDependencies)</AdditionalDependencies>
<AdditionalDependencies>%(AdditionalDependencies)</AdditionalDependencies>
</Link>
<PostBuildEvent>
<Command>xcopy /y "C:\mlpack\mlpack-3.4.2\build\Debug\mlpack.dll" $(OutDir)
xcopy /y "C:\mlpack\mlpack-3.4.2\packages\OpenBLAS.0.2.14.1\lib\native\bin\x64\*.dll" $(OutDir)
<Command>xcopy /y "C:\mlpack\mlpack-3.4.2\packages\OpenBLAS.0.2.14.1\lib\native\bin\x64\*.dll" $(OutDir)
xcopy /y "$(ProjectDir)..\..\..\..\src\mlpack\tests\data\german.csv" "$(ProjectDir)data\german.csv*"</Command>
</PostBuildEvent>
</ItemDefinitionGroup>
+3 -3
View File
@@ -6,7 +6,7 @@ This document discusses how to build mlpack from source. These build directions
will work for any Linux-like shell environment (for example Ubuntu, macOS,
FreeBSD etc). However, mlpack is in the repositories of many Linux distributions
and so it may be easier to use the package manager for your system. For example,
on Ubuntu, you can install the mlpack library and command-line executables (e.g.
on Ubuntu, you can install the mlpack headers and command-line executables (e.g.
mlpack_pca, mlpack_kmeans, etc.) with the following command:
@code
@@ -19,8 +19,8 @@ On Fedora or Red Hat(EPEL):
$ sudo dnf install mlpack-devel mlpack-bin
@endcode
For installing only the header files and library for building C++ applications
on top of mlpack, one could use:
For installing only the header files for building C++ applications on top of
mlpack, one could use:
@code
$ sudo apt-get install libmlpack-dev
+1 -6
View File
@@ -28,15 +28,10 @@ mlpack and dependencies in Release Mode).
- Under C/C++ > General > Additional Include Directories add:
@code
- C:\mlpack\armadillo-9.800.3\include
- C:\mlpack\mlpack-3.4.2\build\include
@endcode
- Under Linker > Input > Additional Dependencies add:
@code
- C:\mlpack\mlpack-3.4.2\build\Debug\mlpack.lib
- C:\mlpack\mlpack-3.4.2\src
@endcode
- Under Build Events > Post-Build Event > Command Line add:
@code
- xcopy /y "C:\mlpack\mlpack-3.4.2\build\Debug\mlpack.dll" $(OutDir)
- xcopy /y "C:\mlpack\mlpack-3.4.2\packages\OpenBLAS.0.2.14.1\lib\native\bin\x64\*.dll" $(OutDir)
@endcode