Numenta Platform for Intelligent Computing
Inherited by CLAModel.
|Model constructor. More...|
|Run one iteration of this model. More...|
|Place the model in a permanent "finished learning" mode. More...|
|Signal that the input record is the start of a new sequence. More...|
|Return the sequence of FieldMetaInfo objects specifying the format of Model's output. More...|
|Propagate field statistics to the model in case some of its machinery needs it. More...|
|Get runtime statistics specific to this model, i.e. More...|
|Common learning/inference methods. More...|
|Turn Learning on for the current model. More...|
|Turn Learning off for the current model. More...|
|Return the Learning state of the current model. More...|
|Enable inference for this model. More...|
|Return the dict of arguments for the current inference mode. More...|
|Turn Inference off for the current model. More...|
|Return the inference state of the current model. More...|
|Implementation of common save/load functionality. More...|
|Load saved model. More...|
This is the base class that all OPF Model implementations should subclass.
It includes a number of virtual methods, to be overridden by subclasses, as well as some shared functionality for saving/loading models
|inferenceType||(nupic.frameworks.opf.opfutils.InferenceType) A value that specifies the type of inference (i.e. TemporalNextStep, Classification, etc.).|
Turn Inference off for the current model.
Turn Learning off for the current model.
Enable inference for this model.
|inferenceArgs||(dict) A dictionary of arguments required for inference. These depend on the InferenceType of the current model|
Turn Learning on for the current model.
Place the model in a permanent "finished learning" mode.
In such a mode the model will not be able to learn from subsequent input records.
NOTE: Upon completion of this command, learning may not be resumed on the given instance of the model (e.g., the implementation may optimize itself by pruning data structures that are necessary for learning).
Return the sequence of FieldMetaInfo objects specifying the format of Model's output.
This may be different than the list of FieldMetaInfo objects supplied at initialization (e.g., due to the transcoding of some input fields into meta-fields, such as datetime -> dayOfWeek, timeOfDay, etc.).
|includeClassifierOnlyField||(bool) If True, any field which is only sent to the classifier (i.e. not sent in to the bottom of the network) is also included|
Return the dict of arguments for the current inference mode.
Common learning/inference methods.
Return the InferenceType of this model. This is immutable.
Get runtime statistics specific to this model, i.e.
Return the inference state of the current model.
Return the Learning state of the current model.
Load saved model.
|savedModelDir||(string) Directory of where the experiment is to be or was saved|
Signal that the input record is the start of a new sequence.
Run one iteration of this model.
|inputRecord||(object) A record object formatted according to nupic.data.record_stream.RecordStreamIface.getNextRecord() or nupic.data.record_stream.RecordStreamIface.getNextRecordDict() result format.|
Implementation of common save/load functionality.
Save the model in the given directory.
|saveModelDir||(string) Absolute directory path for saving the model. This directory should only be used to store a saved model. If the directory does not exist, it will be created automatically and populated with model data. A pre-existing directory will only be accepted if it contains previously saved model data. If such a directory is given, the full contents of the directory will be deleted and replaced with current model data.|
Propagate field statistics to the model in case some of its machinery needs it.
|fieldStats||(dict) A dict of dicts with first key being the fieldname and the second key is min,max or other supported statistics|