Compilation

In order to use Nieme, the simplest is to download one of the compiled binaries versions available here. If you want to compile Nieme yourself, download the source code and follow one of the following compilation guides:

• Compiling Nieme with Makefiles (Linux, MacOSX)
• Compiling Nieme with XCode (MacOSX)
• Compiling Nieme with Visual C++ (Windows)

First Execution

Once you have downloaded a binary version of Nieme or compiled it yourself, read the first execution guide in order to use Nieme with Python, Java or C++.

• First Execution Guide print the version number.
  • Python: importing the package, execution.
  • Java: importing the package, compilation and execution.
  • C++: including headers, linking, execution.

"Using Nieme" Tutorials

These three tutorials describe the interface of Nieme, which is available for Python, Java and C++:

• Tutorial 1 Basic operations on learning machines.
  • Loading a dataset, randomizing datasets.
  • Creating a learning machine.
  • Learning a machine given a dataset.
  • Saving and Loading the learning machine.
  • Evaluating the learning machine on new examples.
• Tutorial 2 Synthetic data, Vectors and Cross-Validation.
  • Creating a new dataset stored in memory.
  • Creating examples forming a synthetic dataset.
  • Creating a new regression machine.
  • Performing cross-validation.
  • Retrieving cross-validation results.
  • Table statistics.
• Tutorial 3 Tuning L1 regularization with cross-validation, using Tables.
  • Quickly working on a data subset.
  • Complexity of a learning machine.
  • Creating Tables.
  • Generating result curves.
  • Finding the best L1 regularization value.

"Extending Nieme" Tutorials

These two tutorials describe how to extend Nieme. They are related to the C++ implementation of Nieme.

• Tutorial 4 Extending Nieme
  • Use cases
  • Correspondences between the interface and the implementation
  • Creating plugins
• Tutorial 5 Creating a Decision Process
  • Decision Process classes
  • Python bindings
  • Custom user interface component

Testing Nieme

Here is the procedure to test Nieme:

1. install the Python version.
2. go into nieme/test directory
3. run python TestAll.py

Generating Nieme's documentation

Here is the procedure to build Nieme documentation:

1. While configuring, make sure that the NIEME_DOCUMENTATION option is selected.
2. Build the nieme-dox target.
3. The documentation is generated into the nieme/dox/Nieme directory.