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.

Sign up for GitHub

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

Add documentation to ExperimentDescriptionAPI #3679

Merged
merged 4 commits into from
Jun 7, 2017
Merged

Add documentation to ExperimentDescriptionAPI #3679

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad2672e
Add documentation to ExperimentDescriptionAPI
scottpurdy Jun 7, 2017
7b26f24
RST formatting on exp-description-api
rhyolight Jun 7, 2017
fe35dcb
Merge pull request #8 from rhyolight/exp-description-api-docs
scottpurdy Jun 7, 2017
c1ede0e
Clean up comments
scottpurdy Jun 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions src/nupic/frameworks/opf/exp_description_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,11 @@ class ExperimentDescriptionAPI(DescriptionIface):
constructing an OPF model and the control includes information about the
environment, where to get the data from, etc.

The experiment_runner takes an instance of this class as the description
of the experiment to run. Similarly, scripts/run_opf_experiment.py looks
for an instance of this class in a variable called `descriptionInterface`
in the experiment files that are passed to it.
The :mod:`~nupic.frameworks.opf.experiment_runner` takes an instance of
this class as the description of the experiment to run. Similarly,
`scripts/run_opf_experiment.py` looks for an instance of this class in a
Copy link
Member

Choose a reason for hiding this comment

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

you can use double ticks to code-format something:

this is not code ``but this is``.

variable called "descriptionInterface" in the experiment files that are
passed to it.

:param modelConfig: (dict) a specification of the model to use, including
the following keys:
Expand All @@ -156,8 +157,8 @@ class ExperimentDescriptionAPI(DescriptionIface):
for inference, including "predictedField" and "predictionSteps"
- **metrics**: a list of MetricSpec instances that specify the metrics to
compute during this experiment
- **loggedMetrics**: a sequence of regular expression strings that specify
which metrics should be logged at each iteration of the
- **loggedMetrics**: a sequence of regular expression strings that
specify which metrics should be logged at each iteration of the
experiment
"""

Expand Down