-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
NUP-2405: quick-start guide for the Network API #3557
NUP-2405: quick-start guide for the Network API #3557
Conversation
…94-network-api # Conflicts: # docs/examples/opf/model_params.py
…xamples (OPF, network API and algo)
* Use new network links created in NUP-2396 * Remove customCompute() usage
…94-network-api # Conflicts: # docs/examples/opf/model_params.py
* Add unit test to make sure all 3 examples don't thow any exception * Change single quotes to double quotes everywhere * Remove utlity script to plot saved prediction results from all 3 examples * Remove part where examples save predictions to file * Rename networkapi to network for better readability
* Make the example code easier to follow in the quick-start section.
* RST documentation * Code snippets
* Use YAML params instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small change for a bad API link. Otherwise excellent!
docs/source/quick-start/network.rst
Outdated
probabilities = classifierRegion.getOutputData("probabilities") | ||
|
||
|
||
Refer to the documentation of :class:`.SDRClassisifierRegion` for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use :class:`~nupic.regions.SDRClassifierRegion.SDRClassifierRegion`
…05-network-quick-start # Resolved conflicts: # docs/examples/network/complete-example.py # docs/examples/opf/complete-example.py # docs/examples/opf/create-model-example.py
@rhyolight Addressed the feedback. Thanks. |
Fixes #3522
Documentation and code snippets for the Network API quick-start guide.
Usage: Follow the README in
nupic/docs
to generate the HTML docs. Open the home page of the docs that you just generated; the section I added lives at127.0.0.1:8000/quick-start/network.html
cc @scottpurdy @rhyolight
Blocked by #3520