Quick Start

Install NuPIC

pip install nupic [--user]

The --user is in brackets because it is optional. See the pip reference guide for details.

The output of this command should end with:

Successfully installed nupic-X.X.X nupic.bindings-X.X.X

where X.X.X represents the most recent versions shown for each project at:

• https://pypi.python.org/pypi/nupic
• https://pypi.python.org/pypi/nupic.bindings

If your installation was unsuccessful, you can find help on NuPIC Forums and on Github.

Choose Your API

You can choose to construct an HTM several ways with NuPIC. See the Network Guide and Network API Docs for more details. Below are Quick Start guides for each interface:

• Online Prediction Framework (OPF)
  • Model Parameters
  • Create an OPF Model
  • Feed the Model Data
  • Extract the results
• Network API
  • Network Parameters
  • Create a Network
  • Add a Sensor Region
  • Add a Data Source to the Sensor Region
  • Add an Encoder to the Sensor Region
  • Add a Spatial Pooler Region
  • Add a Temporal Memory Region
  • Add a Classifier Region
  • Link all Regions
  • Set the Predicted Field Index
  • Enable Learning and Inference
  • Run the Network
  • Getting Predictions
• Algorithms API
  • Encoding Data
    • One Row Of Data
    • Creating Encoders
    • Encoding Data
  • Spatial Pooling
    • Creating the SP
    • Running the SP
  • Temporal Memory
    • Creating the TM
    • Running the TM
    • Predictive Cells
  • Getting Predictions
    • Creating an SDR Classifier
    • Running the Classifier