document stage list #2245
document stage list #2245
Conversation
There was a problem hiding this comment.
good stuff, @skshetry ! some quick comments here and there - nothing major
|
@jorgeorpinel ping. Could you please take a look? Thanks. 🙂 |
|
@shcheklein @jorgeorpinel, ping |
|
Merging this, to unblock @skshetry . Let's do a review as a separate ticket. If it's needed. |
|
Sorry I couldn't get to it earlier but it was in my queue! I'll submit a PR if needed but this looks great, thanks 🙂 |
| - `dvc stage list train-model`: Specific stage name or a | ||
| [foreach group](doc/user-guide/project-structure/pipelines-files#foreach-stages) | ||
| in `./dvc.yaml` | ||
| - `dvc stage list modeling/dvc.yaml:prepare`: Stage or a | ||
| [foreach group](doc/user-guide/project-structure/pipelines-files#foreach-stages) | ||
| in a specific `dvc.yaml` file |
There was a problem hiding this comment.
Just one Q guys: I thought we didn't want the "group" term for foreach stages? BTW I'd be happy to adopt this but requires some changes to the dvc.yaml guide (for context). Cc @shcheklein
There was a problem hiding this comment.
So in the example:
stages:
cleanups:
foreach: # List of simple values
- raw1
- labels1
- raw2
do:
cmd: clean.py "${item}"
outs:
- ${item}.clnIt looks like both of these are supported:
dvc stage list cleanups
dvc stage list cleanups@raw1
That's great!
Maybe we could describe cleanups as a foreach key, or is that too technical? Is this even worth documenting? It seems pretty intuitive to try dvc stage list cleanups in this scenario.
There was a problem hiding this comment.
"foreach key" seems a bit deep, yep.
Maybe it's not worth being so explicit indeed, and we can just say "Stage(s)" (here and in https://dvc.org/doc/command-reference/repro#options)
dvc stage list cleanups@raw1
That may need documenting though. We currently say "in dvc.yaml" and cleanups@raw1 really exists in dvc.lock... ⌛
There was a problem hiding this comment.
Good point. It's confusing, but not sure whether it's worth it to worry about the specifics here. Is there even a use case for dvc stage list cleanups@raw1?
There was a problem hiding this comment.
🤷 maybe not (just confirming that it exists) but keep in mind this also applies to repro.
Adding docs for
stage:list. Implemented on iterative/dvc#5498 and updated on iterative/dvc#5499.Pending issue: iterative/dvc#5390, unlikely to change in a short term window.