exp save: update --help #8729
Merged
exp save: update --help #8729
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dtrifiro
commented
Dec 23, 2022
| @@ -68,7 +68,7 @@ def add_parser(experiments_subparsers, parent_parser): | |||
| "-f", | |||
| "--force", | |||
| action="store_true", | |||
| help="Replace local experiment already exists.", | |||
| help="Replace local experiment if it already exists.", | |||
There was a problem hiding this comment.
This could also be plural?
There was a problem hiding this comment.
(same for exp push)
Codecov ReportBase: 93.50% // Head: 93.50% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #8729 +/- ##
=======================================
Coverage 93.50% 93.50%
=======================================
Files 457 457
Lines 36203 36203
Branches 5244 5244
=======================================
Hits 33850 33850
Misses 1845 1845
Partials 508 508
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
3 tasks
| @@ -49,7 +49,7 @@ def add_parser(experiments_subparsers, parent_parser): | |||
| "--force", | |||
| action="store_true", | |||
| default=False, | |||
| help="Save even if hash value for dependencies/outputs changed.", | |||
| help="Replace experiment if it already exists", | |||
There was a problem hiding this comment.
Suggested change
| help="Replace experiment if it already exists", | |
| help="Replace experiment if it already exists.", |
There was a problem hiding this comment.
What about mentioning that "save also errors out if nothing changed in the workspace, --force overrides this" (from iterative/dvc.org#4200 (comment))?
We can have that in the docs only if you want to keep this short.
There was a problem hiding this comment.
I'd prefer to keep short, Just in the docs is fine I guess.
jorgeorpinel
approved these changes
Dec 23, 2022
jorgeorpinel
added a commit
to iterative/dvc.org
that referenced
this pull request
Dec 23, 2022
|
Note that I updated the docs around this in iterative/dvc.org@0a08f16 (PTAL). |
dberenbaum
approved these changes
Dec 27, 2022
dtrifiro
force-pushed
the
exp-save-help
branch
from
912b1d0
to
4b441ad
Compare
dtrifiro
force-pushed
the
exp-save-help
branch
from
4b441ad
to
0f8f495
Compare
dberenbaum
added a commit
to iterative/dvc.org
that referenced
this pull request
Feb 27, 2023
* start: `exp save`-related clarifications Per #4166 (review) * guide: `exp save`-related updates Per #4166 (review) * ref: `exp save`-related improvements Per #4166 (review) * ref: copy edits * ref: improve value prop for `exp save/run` Per #4200 (review) * ref: update `exp push/pull -f` Per iterative/dvc#8729 * ref: update `exp save -f` Per #4200 (review) * Update content/docs/command-reference/exp/run.md * Update content/docs/command-reference/exp/save.md * Update content/docs/user-guide/experiment-management/experiments-overview.md * Restyled by prettier (#4213) Co-authored-by: Restyled.io <commits@restyled.io> * Update content/docs/command-reference/exp/pull.md * Update content/docs/command-reference/exp/push.md * Update content/docs/command-reference/exp/save.md * Update content/docs/start/experiment-management/experiments.md * Restyled by prettier (#4337) Co-authored-by: Restyled.io <commits@restyled.io> --------- Co-authored-by: daniele <36171005+dtrifiro@users.noreply.github.com> Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com> Co-authored-by: Restyled.io <commits@restyled.io> Co-authored-by: Dave Berenbaum <dave@iterative.ai>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
exp save --forceexp pull --force