diff --git a/src/nupic/frameworks/opf/htm_prediction_model.py b/src/nupic/frameworks/opf/htm_prediction_model.py index e4ce6e476f..b7551ace0b 100644 --- a/src/nupic/frameworks/opf/htm_prediction_model.py +++ b/src/nupic/frameworks/opf/htm_prediction_model.py @@ -106,11 +106,19 @@ def __repr__(self): class HTMPredictionModel(Model): """ - This model is for temporal predictions multiple steps ahead. + This model is for temporal predictions multiple steps ahead. After creating + this model, you must call + :meth:`~nupic.frameworks.opf.model.Model.enableInference` to specify a + predicted field, like this: - :param inferenceType: (:class:`~nupic.frameworks.opf.opf_utils.InferenceType`) + .. code-block:: python + + model.enableInference({"predictedField": "myPredictedField"}) - :param predictedField: (string) The field to predict for multistep prediction. + Where ``myPredictedField`` is the field name in your data input that should be + predicted. + + :param inferenceType: (:class:`~nupic.frameworks.opf.opf_utils.InferenceType`) :param sensorParams: (dict) specifying the sensor parameters. @@ -157,7 +165,6 @@ class HTMPredictionModel(Model): def __init__(self, sensorParams={}, inferenceType=InferenceType.TemporalNextStep, - predictedField=None, spEnable=True, spParams={},