Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: InferenceShifter,ModelResult,SensorInput,InferenceType #3549

Merged
merged 3 commits into from
Apr 14, 2017

Conversation

rhyolight
Copy link
Member

fixes #3548


HELP: This ``dataRow`` description above is wrong because there is no
getDecodedFieldMetaInfo() method anymore. I aso need someone to doc
``dataDict`` and ``category``. -- Matt
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scottpurdy can you help here (or suggest someone to help)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this class is just an abstraction over the encoders. The category comes from categoryOut on the sensor region:

https://github.com/numenta/nupic/blob/914ada4fa719609e1523ca5c54c6e06b5b223bd3/src/nupic/frameworks/opf/htmpredictionmodel.py#L448

And in that code you can also see how dataRow comes from the sensor sourceOut while dataDict is the input to the sensor. Interestingly, these are both the unencoded values so I think they are just different forms of the same thing?

And the intent of this class isn't fully clear to me so hard to know the right thing to put in the documentation.

@rhyolight
Copy link
Member Author

@scottpurdy I'm happy with this if you are

@rhyolight rhyolight merged commit ae3e1e3 into numenta:master Apr 14, 2017
@rhyolight rhyolight deleted the inference-shifter-docstrings branch April 14, 2017 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update api docs for InferenceShifter
2 participants