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

RST formatting on exp-description-api #8

Merged
merged 1 commit into from
Jun 7, 2017
Merged

RST formatting on exp-description-api #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 13 additions & 9 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 @@ -136,23 +136,27 @@ class ExperimentDescriptionAPI(DescriptionIface):

:param modelConfig: (dict) a specification of the model to use, including
the following keys:
model: the name of the OPF model to create
version: the config format version to use
modelParams: parameters to pass to the OPF model

- **model**: the name of the OPF model to create
- **version**: the config format version to use
- **modelParams**: parameters to pass to the OPF model

There may be other required fields such as predictionSteps,
predictedField, and numRecords

:param control: (dict): a specification of the experimental setup,
including the following keys:
environment: the environment that the model will be run in
dataset: input specification as defined in

- **environment**: the environment that the model will be run in
- **dataset**: input specification as defined in
`src/nupic/frameworks/opf/jsonschema/stream_def.json`
iterationCount: maximum number of iterations, or -1 to iterate
- **iterationCount**: maximum number of iterations, or -1 to iterate
until the data source is exhausted
inferenceArgs: a dict containing all the supplementary parameters
- **inferenceArgs**: a dict containing all the supplementary parameters
for inference, including "predictedField" and "predictionSteps"
metrics: a list of MetricSpec instances that specify the metrics to
- **metrics**: a list of MetricSpec instances that specify the metrics to
compute during this experiment
loggedMetrics: a sequence of regular expression strings that specify
- **loggedMetrics**: a sequence of regular expression strings that specify
which metrics should be logged at each iteration of the
experiment
"""
Expand Down