Autogenerate CLI docs #1231
Autogenerate CLI docs #1231
Conversation
sueann
added
the
rn/documentation
| scipy |
| artifact location. Command takes a required argument for experiment ID. Command will thrown | ||
| an error if experiment is not found or already marked for deletion. | ||
|
|
||
| Experiments marked for deletion can be restored using ``restore`` command, unless they are |
There was a problem hiding this comment.
We should avoid losing some of these docs which are not in the CLI today. Specifically, for delete we currently refer to restore_experiment in the CLI docs (which doesn't exist) and don't mention the implementation of deletion stores. Mind adding these to the CLI?
There was a problem hiding this comment.
yeah the plan was to add stuff from the old version of cli.rst into the CLI docstrings if we were okay with this autogen route (didn't want to do the work prematurely :P)
| option. If not provided, backend store will pick default location. Backend store will generate a | ||
| unique ID for each experiment. | ||
|
|
||
| All artifacts generated by runs related to this experiment will be stored under artifact location, |
There was a problem hiding this comment.
Similarly to the comment below regarding delete, it may be good to retain this comment and the one below
|
Looks good! Is there a way to hide things? e.g., this is not very useful:
|
|
yeah... not sure of a quick way to hide things but will look briefly |
|
LGTM! |
What changes are proposed in this pull request?
Added a library to autogenerate CLI docs from CLI docstrings. If this looks okay I will revamp the CLI docstrings with material from the original
cli.rstdoc (didn't want to do this work prematurely).How is this patch tested?
and inspect the CLI page
Release Notes
Is this a user-facing change?
Revamped the CLI docs page to show all commands and options.
What component(s) does this PR affect?
How should the PR be classified in the release notes? Choose one:
rn/documentation