This fork is a community version of the nupic.core C++ repository with Python bindings.
Our aim is to provide an actively developed successor to the nupic.core and nupic repositories by Numenta,
which are not actively developed anymore.
- actively developed C++ core library for HTM/nupic.core (Numenta's repos are in maintanance mode only)
- clean & lean, fast, modern codebase (dependency removal, c++11/17, modernized code, faster)
- API-compatibility with Numenta's code *)
- open and easier involvement of new ideas across HTM community (it's fun to contribute, we make master run stable, but are more open to experiments and larger revamps of the code if it proves useful), new features include:
- Anomaly Likelihood
- BacktrackingTM
- much faster Spatial pooler implementation (runs on Connections)
- stable and well tested code
- easier portability to new platforms (due to removal of custom code (ASM,..) and reliance of C++ standardized features)
- modularity through bindings to the core library
- ie. python bindings in bindings/py
This repository contains the C++ source code for the Numenta Platform for Intelligent Computing (NuPIC). It will eventually contain all algorithms for NuPIC, but is currently in a transition period.
*) The objective is to stay as close as possible to the Nupic API Docs with the aim that we don't break .py code written against the numenta's nupic.core extension library if they were to be ran against this extention library. If you are porting your code to this codebase, please review API Changelog.
Some of the major differences between this library and Numenta's extension library are the following:
- Support for Python 2.7 and Python 3.x (work in progress)
- Support for Linux, OSx, and Windows MS Visual Studio 2017
- Support for C++11, C++17 (work in progress)
- Replaced SWIG with PyBind11 for Python interface.
- Removed CapnProto serialization. It was prevasive and complicated the code considerably. It was replaced with simple binary streaming serialization.
- Many code optimizations, modernization
- Modular structure
- Interfaces & API stabilization, making it easier for developers & researchers to use our codebase
Fork or download the HTM-Community Nupic.cpp repository from https://github.com/htm-community/nupic.cpp
- Python
- Version 2.7 We recommend you use the latest 2.7 version where possible. But the system version should be fine.
- Version 3.6+ (work in progress. The Nupic Python code will need to be upgraded as well before this will be useful. be sure that your Python executable is in the Path environment variable. The Python that is in your default path is the one that will determine which version of Python the extension library will be built for.
- CMake
The easiest way to build from source is as follows.
python setup.py install --user --prefix=
Note that --user --prefix= options will install the extension libaries in ~/.local
so that you don't need su permissions.
This will build everything including the Python extension libraries and install them. After that completes you are all set to run your .py programs which import the extensions:
- nupic.bindings.algorithms
- nupic.bindings.engine_internal
- nupic.bindings.math
The installation scripts will automatically download and build the dependancies it needs.
- Boost (Not needed by C++17 compilers that support the filesystem module)
- Yaml-cpp
- Eigen
- PyBind11
- gtest
- numpy
- pytest
After downloading the repository, do the following:
cd path-to-repository
mkdir -p build/scripts
cd build/scripts
cmake ../..
make install
This will build the Nupic.core library without the Python interface. You will find the
library in build/Release/lib. The headers will be in build/Release/include.
A debug library can be created by adding -DCMAKE_BUILD_TYPE=Debug to the cmake command above. The -j3 could be used
with the make install command to use multiple threads.
This is a work in progress so not everything works quite yet.
After downloading the repository, do the following:
- Double click external/MSVC/startup.bat -- This will setup the build and create the solution file (.sln).
- Double click build/scripts/nupic.cpp.sln -- This starts up Visual Studio
- After Visual Studio starts up, Build everything. -- This will build the C++ library and the Python extensions.
Regardless of how you install nupic.bindings, the nupic-bindings-check command-line script should be installed.
python bindings/py/tests/check_test.py
If you get no error then python is able to load the nupic extension libraries.
There are two sets of unit tests.
- C++ Unit tests -- to run:
cd build/Release/bin; ./unit_tests - Python Unit tests -- to run:
python setup.py test
- Open CMake executable.
- Specify the source folder (
$NUPIC_CORE/src). - Specify the build system folder (
$NUPIC_CORE/build/scripts), i.e. where IDE solution will be created. - Click
Generate. - Choose the IDE that interest you (remember that IDE choice is limited to your OS).
- Double click external/MSVC/startup.bat -- This will setup the build and create the solution file (.sln).
- Double click build/scripts/nupic.cpp.sln -- This starts up Visual Studio
- Open
nupic_core.*projsolution file generated on$NUPIC_CORE/build/scripts. - Run
ALL_BUILDproject from your IDE.
- Run any
tests_*project from your IDE (checkoutputpanel to see the results).