Skip to content

Commit

Permalink
guide: updates to dvc.yaml spec (#3789)
Browse files Browse the repository at this point in the history
* initial plan and some content

* added content about stages

* title and restyle fixes

* added dag section

* depend to -> depend on

* added dependencies section

* Update content/docs/user-guide/pipelines/index.md

* Update content/docs/user-guide/pipelines/index.md

* Restyled by prettier (#3532)

Co-authored-by: Restyled.io <[email protected]>

* Update content/docs/user-guide/pipelines/index.md

Co-authored-by: Jorge Orpinel <[email protected]>

* added pipelines to sidebar

* updated the title

* fixed formatting

* updating for dvc.yaml first

* fed -> used

* dvc.yaml-first

* editing to tell dvc.yaml first

* minor fix

* url dependency

* dvc lock example

* section titles for deps

* section titles for outputs

* reproduction -> running

* adding hyperparameters section

* added experiments section

* adding url dependencies

* added outputs section content

* minor

* added running pipelines content

* moved outputs below running

* removed plots section header

* guide: Defining Data Pipelines

* guide: split up Data Pipelines section

* Update content/docs/command-reference/plots/templates.md

* guide: Data Pipes -> ML Pipes
per #3414 (review)

* guide: oops, remove op-pipes file

* guide: remoge ML Pipes intro
per #3414 (review)

* guide: mention both imports in Def ML Pipes
rel #3414 (review)

* guide: move DAG info from cmd ref
per #3414 (review)

* guide: move all info and links about DAG to ML Pipes
section about Dependency Graphs

* guide: point from some Stage links to ML Pipes
section on Stages (Defining Pipes)

* guide: delete Running ML Pipes (for now)

* nav: remove future ML Pipes guides

* guide: remove ML Pipes/ Experimental Pipes

* roll back unrelated changes...

* guide: roll back dvc.yaml page changes
per #3414 (review)

* guide: link ML Pipes/ Defining Stages to dvc.yaml/stages spec

* guide: some changes to start improving the dvc.yaml guide

* guide: edit Stages section (dvc.yaml guide) and
and move Stage entry spec to right after that.

* guide: link deps and params tooltip to ML Pipes/ Stages guide sections

* guide: links from dvc.yaml doc to ML Pipes/ Stages

* guide: update dvc.yaml Templating spec

* guide: a couple more admons for dvc.yaml doc

* guide: more links

* guide: oops, remove unused files

* remove unrelated change

* ref: update stage add/ run Descs

* guide: move stage definition details to ML Pipes
from cmd ref

* guide: move stage definition details to ML Pipes
from cmd ref

* guide: move stage command details into ML Pipes
re-link from existing places

* guide; update Stage entries spec descs.

* guide: admons for dvc.yaml page

* guide: roll back wrong change

* edits to dvc.yaml doc
per #3730 (review)

* ref: roll back unrelated changes

* .

* ref: few more links to dependency graph in guide

* ref: refactor run, stage add, and repro a little

* guide: drop old pipelines guide

* ref: revert files
one change moved to #4024

* pipelines: revert a bunch of files (for now)
per #3789 (comment)

* proper admons

Co-authored-by: iterative <[email protected]>
Co-authored-by: Emre Şahin <[email protected]>
Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
  • Loading branch information
5 people authored Oct 12, 2022
1 parent 04c4f88 commit 548749a
Show file tree
Hide file tree
Showing 2 changed files with 146 additions and 125 deletions.
4 changes: 2 additions & 2 deletions content/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ experiments or projects use a similar structure.

- `parsing.bool` - Controls the templating syntax for boolean values when used
in
[dict unpacking](/doc/user-guide/project-structure/dvcyaml-files#dict-unpacking).
[dict unpacking](/doc/user-guide/project-structure/dvcyaml-files#dictionary-unpacking).

Valid values are `"store_true"` (default) and `"boolean_optional"`, named
after
Expand Down Expand Up @@ -289,7 +289,7 @@ experiments or projects use a similar structure.
```

- `parsing.list` - Controls the templating syntax for list values when used in
[dict unpacking](/doc/user-guide/project-structure/dvcyaml-files#dict-unpacking).
[dict unpacking](/doc/user-guide/project-structure/dvcyaml-files#dictionary-unpacking).

Valid values are `"nargs"` (default) and `"append"`, named after
[Python argparse actions](https://docs.python.org/3/library/argparse.html#action).
Expand Down
Loading

0 comments on commit 548749a

Please sign in to comment.