Information

Documentation

We use Doxygen for both user and developer documentation which may be read online here. More than 600 documented examples for the interfaces python_modular, octave_modular, r_modular, static python, static matlab and octave, static r, static command line and C++ libshogun developer interface can be found in the online documentation. In addition, examples are shipped in the examples/(un)documented/[interface] directory in the source code (where interface is one of r_static, octave_static, matlab_static, python, python_modular, r_modular, octave_modular, cmdline, libshogun).

English

Chinese

Here you may find links to the older, current (latest release) and latest (cutting edge code in github) versions of the documentation:

Note that documentation for python-modular is most complete and also that python's help function will show the documentation when working interactively:

$ python
Python 2.4.4 (#2, Jan  3 2008, 13:36:28) 
[GCC 4.2.3 20071123 (prerelease) (Debian 4.2.2-4)] on linux2
Type help, copyright, credits or license for more information.
>>> from shogun.Classifier import SVM
>>> help(SVM)

class SVM(CSVM)
|  Method resolution order:
|      SVM
|      CSVM
|      CKernelMachine
|      Classifier
|      SGObject
|      __builtin__.object
|  
|  Methods defined here:
|  
|  __init__(self, kernel, alphas, support_vectors, b)
[...]


What's New

Feb. 17, 2014 -> SHOGUN 3.2.0
Jan. 6, 2014 -> SHOGUN 3.1.1
Jan. 5, 2014 -> SHOGUN 3.1.0
Oct. 28, 2013 -> SHOGUN 3.0.0
March 17, 2013 -> SHOGUN 2.1.0
Sept. 1, 2012 -> SHOGUN 2.0.0
Dec. 1, 2011 -> SHOGUN 1.1.0