README.md

NuPIC

As of September 2023 this repository contains code from legacy Hierarchical Temporal Memory (HTM) Numenta projects that have been in maintenance mode for several years.

Numenta Platform for Intelligent Computing

The Numenta Platform for Intelligent Computing (NuPIC) is a machine intelligence platform that implements the HTM learning algorithms. HTM is a detailed computational theory of the neocortex. At the core of HTM are time-based continuous learning algorithms that store and recall spatial and temporal patterns. NuPIC is suited to a variety of problems, particularly anomaly detection and prediction of streaming data sources. For more information, see numenta.org or the NuPIC Forum.

For usage guides, quick starts, and API documentation, see http://nupic.docs.numenta.org/.

This project is in Maintenance Mode

We plan to do minor releases only, and limit changes in NuPIC and NuPIC Core to:

• Fixing critical bugs.
• Features needed to support ongoing research.

Installing NuPIC

NuPIC binaries are available for:

• Linux x86 64bit
• OS X 10.9
• OS X 10.10
• Windows 64bit

Dependencies

The following dependencies are required to install NuPIC on all operating systems.

• Python 2.7
• pip>=8.1.2
• setuptools>=25.2.0
• wheel>=0.29.0
• numpy
• C++ 11 compiler like gcc (4.8+) or clang

Additional OS X requirements:

• Xcode command line tools

Install

Run the following to install NuPIC:

pip install nupic

Test

# From the root of the repo:
py.test tests/unit

Having problems?

• You may need to use the --user flag for the commands above to install in a non-system location (depends on your environment). Alternatively, you can execute the pip commands with sudo (not recommended).
• You may need to add the --use-wheel option if you have an older pip version (wheels are now the default binary package format for pip).

For any other installation issues, please see our search our forums (post questions there). You can report bugs at https://github.com/numenta/nupic/issues.

Live Community Chat:

Installing NuPIC From Source

To install from local source code, run from the repository root:

pip install .

Use the optional -e argument for a developer install.

If you want to build the dependent nupic.bindings from source, you should build and install from nupic.core prior to installing nupic (since a PyPI release will be installed if nupic.bindings isn't yet installed).

• Build:
• To cite this codebase: