-
Notifications
You must be signed in to change notification settings - Fork 394
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
guide: Running Experiments improvements #2768
Labels
A: docs
Area: user documentation (gatsby-theme-iterative)
C: guide
Content of /doc/user-guide
type: enhancement
Something is not clear, small updates, improvement suggestions
Comments
jorgeorpinel
added
type: enhancement
Something is not clear, small updates, improvement suggestions
A: docs
Area: user documentation (gatsby-theme-iterative)
labels
Aug 31, 2021
This was referenced Aug 31, 2021
I believe the command reference should contain examples with one or two sentence explanations and the rest should be moved to UG. Command examples can continue to live in the ref. WDYT @jorgeorpinel |
@iesahin Yes, we need some cmd ref examples focused on how to use the CLI (not so much on explaining concepts). There can be examples in both places. |
2 tasks
This was referenced Oct 6, 2021
This was referenced Nov 4, 2021
Merged
1 task
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A: docs
Area: user documentation (gatsby-theme-iterative)
C: guide
Content of /doc/user-guide
type: enhancement
Something is not clear, small updates, improvement suggestions
The pipeline section seems too deep. In fact(updated in ref: extract technical details fromexp run
to guides #3182)removing the pipeline and stages concept would be ideal. I think the guide could link to other parts of the docs more liberally.
exp run
to guides #3182)--name
(see [NESTED] guide: Exp implementation details, naming into Overview #3006 (review)).Delete note on "each experiment runs in an independent temporary directory" ?Has been hidden<details>
exp run --reset
: Clarify behavior #2745exp run --set-param
with templating #2313exp run
param overrides and grid search (Hydra feature). ContextThe text was updated successfully, but these errors were encountered: