nupic
index
python2.5/site-packages/nupic/__init__.py

## @file
The nupic package contains all Numenta Python support.
It contains utility routines for configuring and saving HTM networks, 
as well as routines for launching the Numenta Runtime Engine 
and using the Runtime Engine for training and testing HTM networks.
 
The most important packages in NuPIC Tools are:
 
* nupic.network
  Package containing modules for configuring, saving and running HTM networks.
  Includes APIs for launching and managing the Numenta Runtime Engine.
 
* nupic.analysis
  Package containing modules for analyzing and visualizing HTM network and their
  inputs and outputs. Also contains utilities for constructing large-scale 
  experiments HTM network and problem parameterizations.
 
Additional available packages include:
 
* nupic.pynodes
  A package of additional HTM node types, written entirely in Python and 
  subclassing from nupic.pynodes.PyNode. 
  PyNodes are meant to be use for rapid prototyping
  of new algorithms, and for access to the extensive universe of Python libraries 
  when writing sensors and effectors.
  nupic.pynodes is often used in conjunction with nupic.network.
 
* nupic.math
  Package containing modules that extend the Python standard library and Numpy
  math functionality with advanced mathematical, probabilistic and statistical
  algorithms and data structures.
 
* nupic.bindings
  Package containing modules that were generated automatically from Numenta
  C++ library APIs. These modules are typically more difficult to use from Python 
  because they often follow C++, rather than Python, API conventions.
  Where important functionality is available in the bindings package, 
  it is also exposed in a more straightforward manner through one of the other 
  Python packages in this list.
 
* nupic.support
  Package containing modules that are used internally by Numenta Python 
  tools and plugins to extend standard library functionality. 
  These modules should NOT be used by client applications.
 
* nupic.algorithms
  Optional package (only distributed with certain licenses) containing modules
  that implement Numenta learning and inference algorithms for use inside
  Numenta Python node plugins.
 
In addition, the contents of the following modules are directly accessible:
 
  nupic.support.paths
 
For example, to use the utility function nupic.support.paths.FromNTATempDir, 
the following code is sufficient:
 
>>> import nupic
>>> path = nupic.FromNTATempDir(subPath, mkdir=True)

 
Package Contents
       
algorithms (package)
analysis (package)
bindings (package)
math (package)
network (package)
pynodes (package)
support (package)

 
Data
        version = '1.6.1'