Merge branch 'readme-fix' of https://www.github.com/rcurtin/mlpack into rcurtin-readme-fix
This commit is contained in:
Ryan Curtin
+1
-1
@@ -1,5 +1,5 @@
|
||||
### mlpack 3.0.4
|
||||
###### ????-??-??
|
||||
###### 2018-11-13
|
||||
* Bump minimum CMake version to 3.3.2.
|
||||
|
||||
* CMake fixes for Ninja generator by Marc Espie.
|
||||
|
||||
@@ -22,7 +22,7 @@ src="https://cdn.rawgit.com/mlpack/mlpack.org/e7d36ed8/mlpack-black.svg" style="
|
||||
<p align="center">
|
||||
<em>
|
||||
Download:
|
||||
<a href="http://www.mlpack.org/files/mlpack-3.0.3.tar.gz">current stable version (3.0.3)</a>
|
||||
<a href="http://www.mlpack.org/files/mlpack-3.0.4.tar.gz">current stable version (3.0.4)</a>
|
||||
</em>
|
||||
</p>
|
||||
|
||||
|
||||
@@ -104,16 +104,16 @@
|
||||
<SDLCheck>true</SDLCheck>
|
||||
<PreprocessorDefinitions>_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
|
||||
<ConformanceMode>false</ConformanceMode>
|
||||
<AdditionalIncludeDirectories>C:\boost\boost_1_66_0;C:\mlpack\armadillo-8.500.1\include;C:\mlpack\mlpack-3.0.3\build\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
|
||||
<AdditionalIncludeDirectories>C:\boost\boost_1_66_0;C:\mlpack\armadillo-8.500.1\include;C:\mlpack\mlpack-3.0.4\build\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
|
||||
</ClCompile>
|
||||
<Link>
|
||||
<SubSystem>Console</SubSystem>
|
||||
<GenerateDebugInformation>true</GenerateDebugInformation>
|
||||
<AdditionalDependencies>C:\mlpack\mlpack-3.0.3\build\Debug\mlpack.lib;C:\boost\boost_1_66_0\lib64-msvc-14.1\libboost_serialization-vc141-mt-gd-x64-1_66.lib;C:\boost\boost_1_66_0\lib64-msvc-14.1\libboost_program_options-vc141-mt-gd-x64-1_66.lib;%(AdditionalDependencies)</AdditionalDependencies>
|
||||
<AdditionalDependencies>C:\mlpack\mlpack-3.0.4\build\Debug\mlpack.lib;C:\boost\boost_1_66_0\lib64-msvc-14.1\libboost_serialization-vc141-mt-gd-x64-1_66.lib;C:\boost\boost_1_66_0\lib64-msvc-14.1\libboost_program_options-vc141-mt-gd-x64-1_66.lib;%(AdditionalDependencies)</AdditionalDependencies>
|
||||
</Link>
|
||||
<PostBuildEvent>
|
||||
<Command>xcopy /y "C:\mlpack\mlpack-3.0.3\build\Debug\mlpack.dll" $(OutDir)
|
||||
xcopy /y "C:\mlpack\mlpack-3.0.3\packages\OpenBLAS.0.2.14.1\lib\native\bin\x64\*.dll" $(OutDir)
|
||||
<Command>xcopy /y "C:\mlpack\mlpack-3.0.4\build\Debug\mlpack.dll" $(OutDir)
|
||||
xcopy /y "C:\mlpack\mlpack-3.0.4\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>
|
||||
|
||||
+6
-6
@@ -29,7 +29,7 @@ to build mlpack on Windows, see \ref build_windows (alternatively, you can read
|
||||
is based on older versions).
|
||||
|
||||
You can download the latest mlpack release from here:
|
||||
<a href="http://www.mlpack.org/files/mlpack-3.0.3.tar.gz">mlpack-3.0.3</a>
|
||||
<a href="http://www.mlpack.org/files/mlpack-3.0.4.tar.gz">mlpack-3.0.4</a>
|
||||
|
||||
@section build_simple Simple Linux build instructions
|
||||
|
||||
@@ -37,9 +37,9 @@ Assuming all dependencies are installed in the system, you can run the commands
|
||||
below directly to build and install mlpack.
|
||||
|
||||
@code
|
||||
$ wget http://www.mlpack.org/files/mlpack-3.0.3.tar.gz
|
||||
$ tar -xvzpf mlpack-3.0.3.tar.gz
|
||||
$ mkdir mlpack-3.0.3/build && cd mlpack-3.0.3/build
|
||||
$ wget http://www.mlpack.org/files/mlpack-3.0.4.tar.gz
|
||||
$ tar -xvzpf mlpack-3.0.4.tar.gz
|
||||
$ mkdir mlpack-3.0.4/build && cd mlpack-3.0.4/build
|
||||
$ cmake ../
|
||||
$ make -j4 # The -j is the number of cores you want to use for a build.
|
||||
$ sudo make install
|
||||
@@ -64,8 +64,8 @@ configure mlpack.
|
||||
First we should unpack the mlpack source and create a build directory.
|
||||
|
||||
@code
|
||||
$ tar -xvzpf mlpack-3.0.3.tar.gz
|
||||
$ cd mlpack-3.0.3
|
||||
$ tar -xvzpf mlpack-3.0.4.tar.gz
|
||||
$ cd mlpack-3.0.4
|
||||
$ mkdir build
|
||||
@endcode
|
||||
|
||||
|
||||
+13
-13
@@ -21,7 +21,7 @@ Those guides could be used in addition to this tutorial.
|
||||
This tutorial has been designed and tested using:
|
||||
- Windows 10
|
||||
- Visual Studio 2017 (toolset v141)
|
||||
- mlpack-3.0.3
|
||||
- mlpack-3.0.4
|
||||
- OpenBLAS.0.2.14.1
|
||||
- boost_1_66_0-msvc-14.1-64
|
||||
- armadillo-8.500.1
|
||||
@@ -39,10 +39,10 @@ and make sure you can use it from the Command Prompt (may need to add to the PAT
|
||||
|
||||
@section build_windows_instructions Windows build instructions
|
||||
|
||||
- Unzip mlpack to "C:\mlpack\mlpack-3.0.3"
|
||||
- Unzip mlpack to "C:\mlpack\mlpack-3.0.4"
|
||||
- Open Visual Studio and select: File > New > Project from Existing Code
|
||||
- Type of project: Visual C++
|
||||
- Project location: "C:\mlpack\mlpack-3.0.3"
|
||||
- Project location: "C:\mlpack\mlpack-3.0.4"
|
||||
- Project name: mlpack
|
||||
- Finish
|
||||
- We will use this Visual Studio project to get the OpenBLAS dependency in the next section
|
||||
@@ -77,7 +77,7 @@ This tutorial follows the second approach for simplicity.
|
||||
- Run cmake:
|
||||
|
||||
@code
|
||||
cmake -G "Visual Studio 15 2017 Win64" -DBLAS_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.3/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DLAPACK_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.3/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DCMAKE_PREFIX:FILEPATH="C:/mlpack/armadillo" -DBUILD_SHARED_LIBS=OFF ..
|
||||
cmake -G "Visual Studio 15 2017 Win64" -DBLAS_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.4/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DLAPACK_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.4/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DCMAKE_PREFIX:FILEPATH="C:/mlpack/armadillo" -DBUILD_SHARED_LIBS=OFF ..
|
||||
@endcode
|
||||
|
||||
@note If you are using different directory paths, a different configuration (e.g. Release)
|
||||
@@ -89,18 +89,18 @@ or a different VS version, update the cmake command accordingly.
|
||||
|
||||
@section build_windows_mlpack Building mlpack
|
||||
|
||||
- Create a "build" directory into "C:\mlpack\mlpack-3.0.3\"
|
||||
- Create a "build" directory into "C:\mlpack\mlpack-3.0.4\"
|
||||
- Use either the CMake GUI or the CMake command line to configure Armadillo.
|
||||
- To use the CMake GUI, open "CMake".
|
||||
- For "Where is the source code:" set `C:\mlpack\mlpack-3.0.3\`
|
||||
- For "Where to build the binaries:" set `C:\mlpack\mlpack-3.0.3\build`
|
||||
- For "Where is the source code:" set `C:\mlpack\mlpack-3.0.4\`
|
||||
- For "Where to build the binaries:" set `C:\mlpack\mlpack-3.0.4\build`
|
||||
- Click `Configure`
|
||||
- If there is an error and Armadillo is not found, try "Add Entry" with the
|
||||
following variables and reconfigure:
|
||||
- Name: `ARMADILLO_INCLUDE_DIR`; type `PATH`; value `C:/mlpack/armadillo-8.500.1/include/`
|
||||
- Name: `ARMADILLO_LIBRARY`; type `FILEPATH`; value `C:/mlpack/armadillo-8.500.1/build/Debug/armadillo.lib`
|
||||
- Name: `BLAS_LIBRARY`; type `FILEPATH`; value `C:/mlpack/mlpack-3.0.3/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a`
|
||||
- Name: `LAPACK_LIBRARY`; type `FILEPATH`; value `C:/mlpack/mlpack-3.0.3/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a`
|
||||
- Name: `BLAS_LIBRARY`; type `FILEPATH`; value `C:/mlpack/mlpack-3.0.4/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a`
|
||||
- Name: `LAPACK_LIBRARY`; type `FILEPATH`; value `C:/mlpack/mlpack-3.0.4/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a`
|
||||
- If there is an error and Boost is not found, try "Add Entry" with the
|
||||
following variables and reconfigure:
|
||||
- Name: `BOOST_INCLUDEDIR`; type `PATH`; value `C:/boost/boost_1_66_0/`
|
||||
@@ -116,16 +116,16 @@ or a different VS version, update the cmake command accordingly.
|
||||
- Name: `Boost_UNIT_TEST_FRAMEWORK_LIBRARY_RELEASE`; type `FILEPATH`; value should be `C:/boost/boost_1_66_0/lib64-msvc-14.1/boost_unit_test_framework-vc141-mt-x64-1_66.lib`
|
||||
- Once CMake has configured successfully, hit "Generate" to create the `.sln` file.
|
||||
- To use the CMake command line prompt:
|
||||
- Open the Command Prompt and navigate to "C:\mlpack\mlpack-3.0.3\build"
|
||||
- Open the Command Prompt and navigate to "C:\mlpack\mlpack-3.0.4\build"
|
||||
- Run cmake:
|
||||
|
||||
@code
|
||||
cmake -G "Visual Studio 15 2017 Win64" -DBLAS_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.3/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DLAPACK_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.3/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DARMADILLO_INCLUDE_DIR="C:/mlpack/armadillo-8.500.1/include" -DARMADILLO_LIBRARY:FILEPATH="C:/mlpack/armadillo-8.500.1/build/Debug/armadillo.lib" -DBOOST_INCLUDEDIR:PATH="C:/boost/boost_1_66_0/" -DBOOST_LIBRARYDIR:PATH="C:/boost/boost_1_66_0/lib64-msvc-14.1" -DDEBUG=OFF -DPROFILE=OFF ..
|
||||
cmake -G "Visual Studio 15 2017 Win64" -DBLAS_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.4/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DLAPACK_LIBRARY:FILEPATH="C:/mlpack/mlpack-3.0.4/packages/OpenBLAS.0.2.14.1/lib/native/lib/x64/libopenblas.dll.a" -DARMADILLO_INCLUDE_DIR="C:/mlpack/armadillo-8.500.1/include" -DARMADILLO_LIBRARY:FILEPATH="C:/mlpack/armadillo-8.500.1/build/Debug/armadillo.lib" -DBOOST_INCLUDEDIR:PATH="C:/boost/boost_1_66_0/" -DBOOST_LIBRARYDIR:PATH="C:/boost/boost_1_66_0/lib64-msvc-14.1" -DDEBUG=OFF -DPROFILE=OFF ..
|
||||
@endcode
|
||||
|
||||
- Once CMake configuration has successfully finished, open "C:\mlpack\mlpack-3.0.3\build\mlpack.sln"
|
||||
- Once CMake configuration has successfully finished, open "C:\mlpack\mlpack-3.0.4\build\mlpack.sln"
|
||||
- Build > Build Solution (this may be by default in Debug mode)
|
||||
- Once it has sucessfully finished, you will find the library files you need in: "C:\mlpack\mlpack-3.0.3\build\Debug" (or "C:\mlpack\mlpack-3.0.3\build\Release" if you changed to Release mode)
|
||||
- Once it has sucessfully finished, you will find the library files you need in: "C:\mlpack\mlpack-3.0.4\build\Debug" (or "C:\mlpack\mlpack-3.0.4\build\Release" if you changed to Release mode)
|
||||
|
||||
You are ready to create your first application, take a look at the @ref sample_ml_app "Sample C++ ML App"
|
||||
|
||||
|
||||
@@ -31,9 +31,9 @@ build and install mlpack. You can copy-paste the commands into your shell.
|
||||
@code{.sh}
|
||||
sudo apt-get install libboost-all-dev g++ cmake libarmadillo-dev python-pip wget
|
||||
sudo pip install cython setuptools distutils numpy pandas
|
||||
wget http://www.mlpack.org/files/mlpack-3.0.3.tar.gz
|
||||
tar -xvzpf mlpack-3.0.3.tar.gz
|
||||
mkdir -p mlpack-3.0.3/build/ && cd mlpack-3.0.3/build/
|
||||
wget http://www.mlpack.org/files/mlpack-3.0.4.tar.gz
|
||||
tar -xvzpf mlpack-3.0.4.tar.gz
|
||||
mkdir -p mlpack-3.0.4/build/ && cd mlpack-3.0.4/build/
|
||||
cmake ../ && make -j4 && sudo make install
|
||||
@endcode
|
||||
|
||||
|
||||
@@ -29,18 +29,18 @@ mlpack and dependencies in Release Mode).
|
||||
@code
|
||||
- C:\boost\boost_1_66_0
|
||||
- C:\mlpack\armadillo-8.500.1\include
|
||||
- C:\mlpack\mlpack-3.0.3\build\include
|
||||
- C:\mlpack\mlpack-3.0.4\build\include
|
||||
@endcode
|
||||
- Under Linker > Input > Additional Dependencies add:
|
||||
@code
|
||||
- C:\mlpack\mlpack-3.0.3\build\Debug\mlpack.lib
|
||||
- C:\mlpack\mlpack-3.0.4\build\Debug\mlpack.lib
|
||||
- C:\boost\boost_1_66_0\lib64-msvc-14.1\libboost_serialization-vc141-mt-gd-x64-1_66.lib
|
||||
- C:\boost\boost_1_66_0\lib64-msvc-14.1\libboost_program_options-vc141-mt-gd-x64-1_66.lib
|
||||
@endcode
|
||||
- Under Build Events > Post-Build Event > Command Line add:
|
||||
@code
|
||||
- xcopy /y "C:\mlpack\mlpack-3.0.3\build\Debug\mlpack.dll" $(OutDir)
|
||||
- xcopy /y "C:\mlpack\mlpack-3.0.3\packages\OpenBLAS.0.2.14.1\lib\native\bin\x64\*.dll" $(OutDir)
|
||||
- xcopy /y "C:\mlpack\mlpack-3.0.4\build\Debug\mlpack.dll" $(OutDir)
|
||||
- xcopy /y "C:\mlpack\mlpack-3.0.4\packages\OpenBLAS.0.2.14.1\lib\native\bin\x64\*.dll" $(OutDir)
|
||||
@endcode
|
||||
|
||||
@note Recent versions of Visual Studio set "Conformance Mode" enabled by default. This causes some issues with
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
// with higher number than the most recent release.
|
||||
#define MLPACK_VERSION_MAJOR 3
|
||||
#define MLPACK_VERSION_MINOR 0
|
||||
#define MLPACK_VERSION_PATCH 3
|
||||
#define MLPACK_VERSION_PATCH 5
|
||||
|
||||
// The name of the version (for use by --version).
|
||||
namespace mlpack {
|
||||
|
||||
Reference in New Issue
Block a user