Skip to content
This repository has been archived by the owner on Sep 1, 2023. It is now read-only.

NUP-2405: quick-start guide for the Network API #3557

Merged
merged 21 commits into from
Apr 26, 2017

Conversation

marionleborgne
Copy link
Member

@marionleborgne marionleborgne commented Apr 18, 2017

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 at 127.0.0.1:8000/quick-start/network.html

cc @scottpurdy @rhyolight

Blocked by #3520

Marion Le Borgne added 19 commits April 4, 2017 16:58
…94-network-api

# Conflicts:
#	docs/examples/opf/model_params.py
* 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
Copy link
Member

@rhyolight rhyolight left a 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!

probabilities = classifierRegion.getOutputData("probabilities")


Refer to the documentation of :class:`.SDRClassisifierRegion` for
Copy link
Member

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`

Marion Le Borgne added 2 commits April 26, 2017 13:03
…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
@marionleborgne
Copy link
Member Author

@rhyolight Addressed the feedback. Thanks.

@rhyolight rhyolight merged commit 36b96d2 into numenta:master Apr 26, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants