Updated OPF Metric API docs #3638
Conversation
src/nupic/frameworks/opf/metrics.py
Outdated
| :param prediction: | ||
| The value predicted by the network at the current timestep | ||
|
|
||
| :param record: ? |
There was a problem hiding this comment.
@scottpurdy Can you help me out with this?
There was a problem hiding this comment.
This is the input record as fed to the Model.compute method by the user. The typical usage is to feed a record to that method and get a ModelResult. Then you pass ModelResult.rawInput into this function as the record parameter.
src/nupic/frameworks/opf/metrics.py
Outdated
| information relevant to the given metric, for example the number of timesteps represented in | ||
| the current measurement. all stats are implementation defined, and "stats" can be None | ||
|
|
||
| Metric name is defined by the MetricIface implementation. ``stats`` is |
There was a problem hiding this comment.
Metric name is defined by the MetricIface implementation
@scottpurdy Does this statement make sense? I don't see how MetricIface defines a metric name.
There was a problem hiding this comment.
I have the same confusion as you. What is metric name? It looks safe to me to remove any reference to a metric name since I don't think there is one that is relevant to this function.
The return value is also unclear since you say it is an object but what kind? Is it an instance of a specific class or a dict? This is important because it determines whether you do returnValue.value, returnValue["value"], or returnValue.value() to get the value form the returned object.
|
@scottpurdy ready |
fixes #3637