-
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
exp
: misc. guide and ref. updates
#3080
Changes from 8 commits
9ec36f2
d0b46c3
4ae99db
a029288
0eca57b
49c585c
220a9b0
7c30e28
017706c
de850f5
817d6ee
b2bcddc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,22 +14,25 @@ positional arguments: | |
|
||
## Description | ||
|
||
Restores an `experiment` into the workspace as long as no more Git commits have | ||
been made after the target experiment (`HEAD` hasn't moved). The `experiment` | ||
can be referenced by name or hash (see `dvc exp run` for details). This changes | ||
any files (code, data, <abbr>parameters</abbr>, <abbr>metrics</abbr>, etc.) | ||
needed to reflect the experiment conditions and results in the workspace. | ||
Restores an `experiment` into the workspace, as long as we're on the same | ||
project baseline (Git `HEAD`) as when the target experiment was run. The | ||
experiment can be referenced by name or hash (see `dvc exp run` for details). | ||
|
||
⚠️ Conflicting changes in the workspace are overwritten unless `--no-force` is | ||
used. | ||
Specifically, `dvc exp apply` checks out any files or directories needed to | ||
reflect the experiment conditions and results. This can include both with DVC | ||
and Git: code, data, <abbr>parameters</abbr>, <abbr>metrics</abbr>, etc. | ||
|
||
⚠️ This command will destroy any existing changes in the workspace (Git working | ||
tree) unless the `--no-force` flag is used. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm, I'm pretty sure the old text is the intended behavior, but I can confirm that the changes match the current behavior. Reopened iterative/dvc#6930 (comment) to clarify. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see iterative/dvc#6930 was marked as a bug so I'll revert this explanation @dberenbaum ... ⌛ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in b2bcddc. |
||
|
||
This is typically used after choosing a target `experiment` with `dvc exp show` | ||
or `dvc exp diff`, and before committing it to Git (making it | ||
[persistent](/doc/user-guide/experiment-management#persistent-experiments)). | ||
or `dvc exp diff`, and before committing it to Git (making it [persistent]. | ||
|
||
> Note that if a history of [checkpoints] is found in the `experiment`, it will | ||
> **not** be preserved when applying and committing it. | ||
jorgeorpinel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Note that the history of | ||
[checkpoints](/doc/command-reference/exp/run#checkpoints) found in the | ||
`experiment` is **not** preserved when applying and committing it. | ||
[persistent]: /doc/user-guide/experiment-management/persisting-experiments | ||
[checkpoints]: /doc/user-guide/experiment-management/checkpoints | ||
|
||
## Options | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the previous expression is more clear.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't love the 2nd sentence here either if that's what you mean @iesahin. But the previous wording was a single long sentence instead of 2 which mixed the 2 ideas so it was harder to read and comprehend IMO. I also changed "restores" for "check out" to be more specific about the operation what takes place.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
p.s. I think I clarified the wording now (817d6ee).