repro cmdref updates #1861
repro cmdref updates #1861
Conversation
jorgeorpinel
had a problem deploying
to
dvc-landing-reprocmd-8au5lq1iw
jorgeorpinel
had a problem deploying
to
dvc-landing-reprocmd-8au5lq1iw
There was a problem hiding this comment.
Thanks @imhardikj. This needs some more work on the options, and to think through the examples. Please see discussions above.
|
I saw this failed deploy, and I believe it's been affected by the recent change to how the community page's schema works. I believe merging master will fix this, and I'm trying it out locally. I can do the push with my merged master if that's alright, and we'll be able to see if it fixes the deploy. |
|
Thank for the note Roger. Please merge |
| - `-R`, `--recursive` - expands arguments that `targets` accepts to determine | ||
| the stages to be reproduced, by searching each target directory and its | ||
| subdirectories. This option only has an effect if directory paths are given as | ||
| `targets`. |
There was a problem hiding this comment.
First, this is a confusing text. It should be explained in simpler terms, shorter sentences, etc. Also, it has grammar errors.
There was a problem hiding this comment.
Secondly we're missing the whole point of #1632... Maybe you're confused by the term "expands". One thing is to expand a path (explore recursively) — that's not what the issue is about at all. Just forget about that term...
This is about the targets argument of dvc repro (and how -RP affect it). Again (from #1861 (comment)), "i.e. usually targets only accept "Stage or path to dvc.yaml or .dvc file to reproduce", right? It does not say that paths to directories are accepted. But these options (-RP) only work for directories, so what's going on?"
If you can answer that question, you'll be closer to understanding what's needed here.
| targets Stage or .dvc file to reproduce | ||
| targets Stage or path to dvc.yaml or .dvc file to reproduce. Using -R, | ||
| directories to search for stages can also be given. |
There was a problem hiding this comment.
Perfect. We will need to submit a matching change in the core dvc repo. Are you able to try that too @imhardikj ? Thanks
There was a problem hiding this comment.
I checked -p, it doesn't work with directories. So the current description is correct I think.
submit a matching change in the core dvc repo
Sure I'll do this. Currently this is displayed for targets: Stages to reproduce. 'dvc.yaml' by default.
This should be updated to exact same text as above right: Stage or path to dvc.yaml or .dvc file to reproduce. Using -R, directories to search for stages can also be given.
Also this (https://github.com/iterative/dvc/blob/master/dvc/command/repro.py) is the file that needs to updated?
There was a problem hiding this comment.
There was a problem hiding this comment.
OK this is good so far. I guess changing the usage block was way easier than what we were trying to do initially... 🤦
Let's just check whether -p needs clarification too. Are directories accepted as targets when -p is used? Please test and if so, update that option to clarify @imhardikj
Thanks
|
Woot woot 🎉 |
Fixes #1632
targetsdescriptionPartially addresses #1824