ref: repro accepts outputs as targets #2362
Conversation
|
Related iterative/dvc#5273 |
|
We should also update the part of the Description that reads "There are a few ways to restrict what will be regenerated by this command..." |
|
|
||
| - `-R`, `--recursive` - looks for `dvc.yaml` files to reproduce in any | ||
| directories given as `targets`, and in their subdirectories. If there are no | ||
| directories among the targets, this option has no effect. | ||
|
|
||
| - `--glob` - causes the `targets` to be interpreted as wildcard | ||
| [patterns](https://docs.python.org/3/library/glob.html) to match for output | ||
| names. For example: `output*` (certain output names). Note that it |
There was a problem hiding this comment.
| names. For example: `output*` (certain output names). Note that it | |
| files or directories. For example: `output*` (certain outputs). Note that it |
|
@Vonski thanks for this! Please try to fix the md formatting if possible (after applying my suggestions). See https://dvc.org/doc/user-guide/contributing/docs 🙂 |
jorgeorpinel
added
the
⌛ status: wait-core-merge
|
@jorgeorpinel I'll wait with updating things here until we agree on what terms should be used in help strings in core PR to make docs consistent with them. |
|
Sorry for the delay @Vonski, getting back to this now. I see the core PR is still unmerged so I guess we still have some time to iterate, but we can also take this over when needed so no pressure (please lmk if your capacity is limited thouogh). Thanks! 👇 |
| There are a few ways to restrict what will be regenerated by this command: by | ||
| specifying specific reproduction [`targets`](#options), or by using certain | ||
| command [options](#options), such as `--single-item` or `--all-pipelines`. | ||
| command [options](#options), such as `--single-item` or `--all-pipelines`. It is | ||
| also possible to use `--glob` and `--glob-stages` to match targets with | ||
| [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) patterns. |
There was a problem hiding this comment.
In #2362 (comment) I meant: we should mention that another way is to specify stage outputs (which will cause the whole stage to be reproed (right?)).
No need to change general info. about --glob in this PR (only further down to update it as per this PR's actual topic: stage outputs as targets.)
There was a problem hiding this comment.
I need a bit of clarification here. If we don't want information about *glob* flags here (thank you for pointing it out) I don't see what should be added to this paragraph, because I understand that from now on generic target could be also any defined stage output (and it is described in section about targets, to which target word links). So imo this part should be left as it was at the beginning (without any changes that I've added). Are we on the same page about that? @jorgeorpinel
There was a problem hiding this comment.
We were on the same page, yes.
| - `dvc repro modeling/dvc.yaml:prepare`: Stage in a specific `dvc.yaml` file | ||
| - `dvc repro --glob train-*`: Pattern to match groups of stages | ||
| - `dvc repro --glob 'model.??'`: Pattern to match groups of output filenames | ||
| - `dvc repro --glob-stages 'train-mode?'`: Pattern to match groups of stages |
There was a problem hiding this comment.
| - `dvc repro --glob-stages 'train-mode?'`: Pattern to match groups of stages | |
| - `dvc repro --glob-stages cleaning/dvc.yaml:parse*`: Pattern to match groups | |
| of stages (by path and name) |
There was a problem hiding this comment.
Question here: Is it intended approach to show commands with globs without putting them inside apostrophes (globs I mean). I don't know how does it work in other shells, but on my machine it will scan for filenames that match before arguments are passed to dvc repro command. Should it be like that? @jorgeorpinel
There was a problem hiding this comment.
I guess it would need 's to avoid the shell's built-in globbing.
|
No problem @jorgeorpinel! I'm cool with fixing this to the very end. I won't have time until Thursday though. If it can wait I am happy to do that. |
|
Sure. The core PR isn't even merged yet 🙂 No rush |
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
jorgeorpinel
changed the title
|
Closing this since the DVC one was closed ? Sorry about that @Vonski , and we really appreciate the effort here. |
❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.
🐛 Please make sure to mention
Fix #issue(if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.Please choose to allow us to edit your branch when creating the PR.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏