SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SHOGUN-TOOLBOX Quickstart

This quickstart assumes that you have access to standard unix/linux tools, cmake and a C/C++ compiler. It may be neccessary to install additional libraries or header files to compile shogun or its interfaces.

Build prerequisites

Download sources

The following commands will get the prepared shogun source archives. Note that some examples might depend on "shogun-data", which is approximately 250 MB of data to be downloaded. The additional data is not required for shogun itself, so you may skip downloading them.

$ cd "$HOME"
$ wget ftp://shogun-toolbox.org/shogun/releases/3.1/sources/shogun-3.1.1.tar.bz2
$ tar xjf shogun-3.1.1.tar.bz2

$ wget ftp://shogun-toolbox.org/shogun/data/shogun-data-0.7.tar.bz2
$ tar xjf shogun-data-0.7.tar.bz2

$ cd shogun-3.1.1
$ rm -rv data/
$ ln -s ../shogun-data-0.7 data

Compile and install SHOGUN-TOOLBOX into home directory

We assume that you want to install shogun in a subdirectory shogun-install of your user home. Installing shogun to system-directories is possible as well, but may require root/sudo privileges.

$ cd "$HOME/shogun-3.1.1"

$ mkdir build
$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX="$HOME/shogun-install" ..

$ make -j5 all
$ make install

Run the examples

Many toy examples on can be found within share/shogun/examples/libshogun. In order to run them, you need to point LD_LIBRARY_PATH to the location of the compiled library. If everything from above was successful, this should work well:

$ export LD_LIBRARY_PATH="$HOME/shogun-install/lib:$LD_LIBRARY_PATH"
$ cd "$HOME/shogun-install/share/shogun/examples/libshogun"
$ chmod +x ./so_multiclass_BMRM && ./so_multiclass_BMRM

You know what you're doing?

A small cheat sheet of available cmake options. This list does not claim to be comprehensive – it's meant to be a quick reference for those you know what they do.

Enabling modular interfaces

Enabling static interfaces (legacy)

Handy cmake options

Got stuck? Found a bug? Need help?


SHOGUN Machine Learning Toolbox - Documentation