Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref: formalize dvc.yaml page + better structure #3896

Closed
jorgeorpinel opened this issue Aug 25, 2022 · 1 comment
Closed

ref: formalize dvc.yaml page + better structure #3896

jorgeorpinel opened this issue Aug 25, 2022 · 1 comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Aug 25, 2022

In general, https://dvc.org/doc/user-guide/project-structure/dvcyaml-files is turning into a reference closer to the cmd ref than guides, esp. since there are actual guides for certain topics in there (like pipelining or plots). But the content is still mixed with some guide-like sections and other more formal spec/definition sections. Should be closer to the latter.

Maybe also move it into /doc/files-reference along with a few other pages?

Some specific ideas from the OP:


...we should be describing things in their order. In every section we can put a small snippet again to get some context back what part of dvc.yaml we are talking about.

Section names could be a bit more formal e.g. "cmd: stage command"

Originally posted by @shcheklein in #3414 (comment)

@jorgeorpinel jorgeorpinel added A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference labels Aug 25, 2022
@dberenbaum
Copy link
Collaborator

https://dvc.org/doc/user-guide/project-structure/dvcyaml-files is focused on pipelines. With coming changes to the experiments onboarding experience that will introduce top-level params and metrics in addition to the existing plots, it's time to broaden the scope of how we describe dvc.yaml.

It can be a general configuration file for ML experiments. This enables users to:

  • Describe experiment tracking info: pipelines, parameters, metrics, and plots.
  • Configure that info in human-readable files that can be modified before, during, or after experiments.
  • Manage the configuration alongside code and data in Git.
  • Use DVCLive to configure it, but also have flexibility to manually configure additional outputs (like adding plots that aren't supported by DVCLive).
  • Use the tool of your choice to consume this schema and visualize/compare experiments (CLI, VS Code, Studio, CML, IPython/notebooks in the future).

@dberenbaum dberenbaum added the p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. label Oct 16, 2023
@dberenbaum dberenbaum closed this as not planned Won't fix, can't repro, duplicate, stale Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately.
Projects
None yet
Development

No branches or pull requests

2 participants