run: add --outs-persist and --outs-persist-no-cache description #217
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
shcheklein
reviewed
Mar 25, 2019
shcheklein
reviewed
Mar 25, 2019
| @@ -84,6 +84,17 @@ automatically under DVC control. In case of metrics it's pretty usual because | |||
| metric files are small enough to be put into Git or other underlying version | |||
| control system. See also the difference between `-o` and `-O` options. | |||
|
|
|||
| * `--outs-persist` - the same as `-o` except outputs will not be removed in case | |||
| of [`dvc repro`](https://dvc.org/doc/commands-reference/repro#repro) command. | |||
There was a problem hiding this comment.
please, keep the same indent as in the options around
shcheklein
reviewed
Mar 25, 2019
shcheklein
reviewed
Mar 25, 2019
| * `--outs-persist` - the same as `-o` except outputs will not be removed in case | ||
| of [`dvc repro`](https://dvc.org/doc/commands-reference/repro#repro) command. | ||
| Upon running [`dvc repro`](https://dvc.org/doc/commands-reference/repro#repro), | ||
| In case of `-o` target file is removed (if exists) before performing command |
There was a problem hiding this comment.
target file is confusing (sounds more like DVC file itself in this context). Why don't we specify that in case of -o or -O data files or directories produced in the previous run are removed ... or something like this
shcheklein
reviewed
Mar 25, 2019
shcheklein
requested changes
Mar 25, 2019
There was a problem hiding this comment.
Thanks!
Put some comments to improve/fix the doc.
Also:
- Mention where these options are useful. One-two sentence if we can get the from the user request.
- Mention that these options are safe and take care about unprotecting files and that it might affect the performance with certain cache settings (cache=hardlink,symlink?)
- Example - let's not use
foo,barnames. Let's come up with something more meaningful. It's hard to understand what's going on when input file isbarand output isfoo.
shcheklein
reviewed
Mar 26, 2019
| cache types (symlink, hardlink) reproduction step will be prolonged by time | ||
| necessary to create copies. `--outs-persist` might still overwrite existing | ||
| outputs if `run` command somehow removes existing output (example in | ||
| [Examples](#Examples)). |
There was a problem hiding this comment.
❤️ I would remove (example in Examples) though
shcheklein
reviewed
Mar 26, 2019
|
|
||
| * Difference between `run --outs` and `run --outs-persist`. | ||
| This example shows how using `--outs-persist` influences | ||
| reproduction step. |
|
@shcheklein can we close it for now? |
|
@pared agreed! |
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.
Related to #1214