glossary: create "stage" entry #2198
Conversation
remove WIP content
|
This is also related with #550 |
| match: ['stage', 'stages'] | ||
| tooltip: >- | ||
| A stage is a single unit of execution in a pipeline that produces some | ||
| (intermediate or final) output. [ð](/doc/user-guide/concepts/stage) |
There was a problem hiding this comment.
what is the current version of the tooltip? sorry, I'm lost a bit - have we migrated all of the to the new format or it's still in progress?
There was a problem hiding this comment.
There is tooltip for stage as of now. That sign was a link with a text of 📖 (like 📖 ) but why was it corrupted, I don't get.
Updating the text and removing icon.
|
|
||
| # Stage | ||
|
|
||
| A stage is a single unit of execution in a <abbr>pipeline</abbr> that takes some |
There was a problem hiding this comment.
Should we go a bit more informal here? To be extreme: "Stage is any command that you would usually run from CLI that usually reads some files and produces other files or models. It can be something as simple as `python train.py " ...
We want here to give people sense about these things, I think. Using regular language, simple examples. Something that would make it very easy to catch the idea ...
There was a problem hiding this comment.
I think 1ea2da3 is better in that regard. Thank you.
|
Like "a stage is a step in an experiment/pipeline that may import a file, runs an experiment, etc."? |
* cmd: add dvc update --to-remote docs * Update content/docs/command-reference/update.md Co-authored-by: Jorge Orpinel <[email protected]> Co-authored-by: Ivan Shcheklein <[email protected]> Co-authored-by: Jorge Orpinel <[email protected]>
* Draft of Feb Heartbeat * please work * add images * fix HB image and author path * typos and spacy pic change * typos * updates to Heartbeat * revised dagshub image and link * images shrunk * dashub-logo * corrcting Roger and Dagshub logo * adjust roger * added Alt text * cleanup: delete redundant files * Update 2021-02-12-february-21-dvc-heartbeat.md * Delete 2021-02-12-february-21-dvc-heartbeat.md * Update jeny_defigueiredo.md * Update jeny_defigueiredo.md * Delete spacy_integration.png * Delete dags_diagram.png Co-authored-by: elleobrien <[email protected]> Co-authored-by: Ivan Shcheklein <[email protected]>
|
This contained a BC document for the stage but I deleted it after your suggestion to have rather an informal language. It doesn't change anything on the sidebar. @shcheklein |
| A single step in a pipeline which may import data, run experiments and produce | ||
| some (intermediate or final) output. Stages may depend other stages and they | ||
| can be automatically invalidated when their dependencies change. |
There was a problem hiding this comment.
Good start. I'd look in https://dvc.org/doc/command-reference/run for the existing definition/explanation. Specific questions on this current text:
- Stages run experiments? I think not exactly
- Probably need to describe "invalidated"
There was a problem hiding this comment.
A user runs experiments in stages and a stage may be completely about running an experiment, right? Am I missing something? Stages don't run experiment but a stage may only be about running an experiment.
Will add a "user" there.
Instead of invalidation, I can tell how run or repro skips some stages but succinctly using the "invalidation" seemed more appropriate.
There was a problem hiding this comment.
Experiments are broader than individual stages (see WIP https://dvc-org-guide-experimen-xigcev.herokuapp.com/doc/user-guide/experiment-management). For now I think there's no need to complicate this tooltip with the concept of experiments.
Instead of invalidation, I can tell how run or repro skips some stages
Check the "parameter" and "pipelines file" tooltips: they use invalid (considered outdated)
dvc 2.0 pre-release
guide: Experiment Management
2.0 pre-release blog fixes
* document stage:add * fix typos, indent flags in usage, add tooltip * add syntax highlighting for stage:add command * minor fixup * Update content/docs/command-reference/stage/add.md * Update content/docs/command-reference/stage/add.md * Apply suggestions from code review from @jorgeorpinel Co-authored-by: Jorge Orpinel <[email protected]> * indent examples * put command details before dependencies and outputs section Co-authored-by: Jorge Orpinel <[email protected]>
… iesahin/issue1579
|
It seems |
|
This also fixed #1579 |
This adds a BC document for stage. It also contains
tooltip:front matter to fix #1579TODO