NuPIC is a library that provides the building blocks for online prediction systems. The library contains the Cortical Learning Algorithm (CLA), but also the Online Prediction Framework (OPF) that allows clients to build prediction systems out of encoders, models, and metrics.
Issue tracker at issues.numenta.org.
For more detailed documentation, see the OPF wiki page.
Encoders turn raw values into sparse distributed representations (SDRs). A good encoder will capture the semantics of the data type in the SDR using overlapping bits for semantically similar values.
Models take sequences of SDRs and make predictions. The CLA is implemented as an OPF model.
Metrics take input values and predictions and output scalar representations of the quality of the predictions. Different metrics are suitable for different problems.
Clients take input data and feed it through encoders, models, and metrics and store or report the resulting predictions or metric results.
For all installation options, see the Installing and Building NuPIC wiki page.
Currently supported platforms:
- Linux (32/64bit)
- Mac OSX
- Raspberry Pi (ARMv6)
- Chromebook (Ubuntu ARM, Crouton) (ARMv7)
- VM images
- Python (2.6-2.7) (with development headers)
- GCC (4.6-4.8), or Clang
- Make or any IDE supported by CMake (Visual Studio, Eclipse, XCode, KDevelop, etc)
The dependencies are included in platform-specific repositories for convenience:
pip install -r external/common/requirements.txt
Note: If using pip 1.5 or later:
pip install --allow-all-external --allow-unverified PIL --allow-unverified psutil -r external/common/requirements.txt
Note: If you get a "permission denied" error when using pip, you may add the --user flag to install to a location in your home directory, which should resolve any permissions issues. Doing this, you may need to add this location to your PATH and PYTHONPATH. Alternatively, you can run pip with 'sudo'.
Build and test NuPIC:
Set the following environment variables in your
$NUPIC is the path to your NuPIC repository and
$NTA is the installation path for NuPIC. You may set a different path for
$NTA or specify the location with CMake with the command line option
export NUPIC=<path to NuPIC repository> export NTA=$NUPIC/build/release export NTA_ROOTDIR=$NTA export PYTHONPATH=$PYTHONPATH:$NTA/lib/python<version>/site-packages
Using command line
Configure and generate build files:
mkdir -p $NUPIC/build/scripts cd $NUPIC/build/scripts cmake $NUPIC
cd $NUPIC/build/scripts (optional) make clean / distclean # to compile all the files again make -j3
Note: -j3 option specify '3' as the maximum number of parallel jobs/threads that Make will use during the build in order to gain speed. However, you can increase this number depending your CPU.
Run the tests:
cd $NUPIC/build/scripts make <test> (where <test> can be C++ tests: 'tests_everything', 'tests_cpphtm' and 'tests_pyhtm' or Python tests: 'tests_run' and 'tests_run_all')
Using graphical interface
Generate the IDE solution:
- Open CMake executable.
- Specify the source folder (
- Specify the build system folder (
$NUPIC/build/scripts), i.e. where IDE solution will be created.
- Choose the IDE that interest you (remember that IDE choice is limited to your OS, i.e. Visual Studio is available only on CMake for Windows).
nupic.*projsolution file generated on
ALL_BUILDproject from your IDE.
Run the tests:
- Run any
tests_*project from your IDE (check
outputpanel to see the results).
You can run the examples using the OpfRunExperiment OPF client:
python $NUPIC/examples/opf/bin/OpfRunExperiment.py $NUPIC/examples/opf/experiments/multistep/hotgym/
There are also some sample OPF clients. You can modify these to run your own data sets. One example is the hotgym prediction client:
Also check out other uses of the CLA on the Getting Started wiki page.