SHOGUN  3.2.1
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
QUICKSTART.md
浏览该文件的文档.
1 SHOGUN-TOOLBOX Quickstart {#quickstart}
2 =========================
3 
4 This quickstart assumes that you have access to standard unix/linux tools,
5 cmake and a C/C++ compiler. It may be neccessary to install additional
6 libraries or header files to compile shogun or its interfaces.
7 
8 ## Build prerequisites
9 
10 * Minimal requirements: standard utils like cmake, gcc/g++/clang, ldd,
11  wget/curl, tar/bzip2, bash, grep, test, sed, cut, awk, ldd, uname, cat,
12  python-2.7
13 * Optional libraries to improve performance: lapack3-dev, atlas3-headers,
14  atlas3-base-dev, libeigen3-dev
15 * Depending on the enabled interfaces you may need: swig 2, r-base-dev,
16  liboctave-dev, openjdk-6-jdk/openjdk-7-jdk, jblas, jblas-dev,
17  python2.7-dev, python-numpy
18 
19 ## Download sources
20 
21 The following commands will get the prepared shogun source archives. Note
22 that some examples might depend on "shogun-data", which is approximately
23 250 MB of data to be downloaded. The additional data is not required for
24 shogun itself, so you may skip downloading them.
25 
26  $ cd "$HOME"
27  $ wget ftp://shogun-toolbox.org/shogun/releases/3.1/sources/shogun-3.1.1.tar.bz2
28  $ tar xjf shogun-3.1.1.tar.bz2
29 
30  $ wget ftp://shogun-toolbox.org/shogun/data/shogun-data-0.7.tar.bz2
31  $ tar xjf shogun-data-0.7.tar.bz2
32 
33  $ cd shogun-3.1.1
34  $ rm -rv data/
35  $ ln -s ../shogun-data-0.7 data
36 
37 ## Compile and install SHOGUN-TOOLBOX into home directory
38 
39 We assume that you want to install shogun in a subdirectory `shogun-install` of
40 your user home. Installing shogun to system-directories is possible as well,
41 but may require root/sudo privileges.
42 
43  $ cd "$HOME/shogun-3.1.1"
44 
45  $ mkdir build
46  $ cd build
47  $ cmake -DCMAKE_INSTALL_PREFIX="$HOME/shogun-install" ..
48 
49  $ make -j5 all
50  $ make install
51 
52 ## Run the examples
53 
54 Many toy examples on can be found within `share/shogun/examples/libshogun`.
55 In order to run them, you need to point `LD_LIBRARY_PATH` to the location
56 of the compiled library. If everything from above was successful, this
57 should work well:
58 
59  $ export LD_LIBRARY_PATH="$HOME/shogun-install/lib:$LD_LIBRARY_PATH"
60  $ cd "$HOME/shogun-install/share/shogun/examples/libshogun"
61  $ chmod +x ./so_multiclass_BMRM && ./so_multiclass_BMRM
62 
63 # You know what you're doing?
64 
65 A small cheat sheet of available cmake options. This list does not
66 claim to be comprehensive -- it's meant to be a quick reference for
67 those you know what they do.
68 
69 ## Enabling modular interfaces
70 * `-DPythonModular=ON`, `-DOctaveModular=ON`, `-DJavaModular=ON`,
71 * `-DPerlModular=ON`, `-DRubyModular=ON`, `-DCSharpModular=ON`,
72 * `-DRModular=ON`, `-DLuaModular=ON`
73 
74 ## Enabling static interfaces (legacy)
75 * `-DCmdLineStatic=ON`, `-DPythonStatic=ON`, `-DOctaveStatic=ON`
76 * `-DMatlabStatic=ON`, `-DRStatic=ON`
77 
78 ## Handy cmake options
79 * `-DCMAKE_BUILD_TYPE=Debug` or `-DCMAKE_BUILD_TYPE=Release`
80 * `-DENABLE_TESTING=ON` or `-DENABLE_TESTING=OFF`
81 * `-DCMAKE_INCLUDE_PATH=...`, `-DCMAKE_LIBRARY_PATH=...`
82 
83 # Got stuck? Found a bug? Need help?
84 
85 * Bug tracker: https://github.com/shogun-toolbox/shogun/issues
86 * Chat: Join IRC channel #shogun at irc.freenode.net
87 * Mailing list: Send an empty message to shogun-list-subscribe@shogun-toolbox.org

SHOGUN 机器学习工具包 - 项目文档