Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 17,589 Commits
.ci		.ci
.github		.github
applications		applications
cmake		cmake
configs		configs
data @ 126500b		data @ 126500b
debian @ e47abf2		debian @ e47abf2
doc		doc
examples		examples
scripts		scripts
src		src
tests		tests
.clang-format		.clang-format
.clang_complete		.clang_complete
.gitignore		.gitignore
.gitmodules		.gitmodules
CMakeLists.txt		CMakeLists.txt
FUNDING.yml		FUNDING.yml
LICENSE		LICENSE
NEWS		NEWS
README.md		README.md
environment.yml		environment.yml

Repository files navigation

The SHOGUN machine learning toolbox

Unified and efficient Machine Learning since 1999.

Latest release:

Cite Shogun:

Develop branch build status:

Donate to Shogun via NumFocus:

Buildbot:https://buildbot.shogun.ml.

Seedoc/readme/ABOUT.md for a project description.
Seedoc/readme/INSTALL.md for installation instructions.
Seedoc/readme/INTERFACES.md for calling Shogun from its interfaces.
Seedoc/readme/EXAMPLES.md for details on creating API examples.
Seedoc/readme/DEVELOPING.md for how to hack Shogun.
SeeAPI examples for all interfaces.
Seethe wiki for extended developer information.

Interfaces

Shogun is implemented in C++ and offers automatically generated, unified interfaces to Python, Octave, Java / Scala, Ruby, C#, R, Lua. We are currently working on adding more languages including JavaScript, D, and Matlab.

Interface	Status
Python	mature (no known problems)
Octave	mature (no known problems)
Java/Scala	stable (no known problems)
Ruby	stable (no known problems)
C#	stable (no known problems)
R	beta (most examples work, static calls unavailable)
Perl	pre-alpha (work in progress quality)
JS	pre-alpha (work in progress quality)

Seeour website for examples in all languages.

Platforms

Shogun is supported under GNU/Linux, MacOSX, FreeBSD, and Windows.

Directory Contents

The following directories are found in the source distribution.Note that some folders are submodules that can be checked out withgit submodule update --init.

src - source code, separated into C++ source and interfaces
doc - readmes (doc/readme, submodule), Jupyter notebooks, cookbook (API examples), licenses
examples - example files for all interfaces
data - data sets (submodule, required for examples)
tests - unit tests and continuous integration of interface examples
applications - applications of SHOGUN (outdated)
benchmarks - speed benchmarks
cmake - cmake build scripts