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

Reduce CML with DVC report generation code #409

Open
dberenbaum opened this issue Dec 1, 2022 · 0 comments
Open

Reduce CML with DVC report generation code #409

dberenbaum opened this issue Dec 1, 2022 · 0 comments
Labels
C: guide Content of /doc/user-guide documentation Markdown files external-request You asked, we did p1-important High priority

Comments

@dberenbaum
Copy link

Related to #389.

In https://cml.dev/doc/cml-with-dvc, the "Create CML report" step is more than half the YAML file for both GH and GL. I think it's a useful example but makes CML<>DVC integration look way more intimidating than it needs to be.

Some initial ideas for improvement:

  1. Move that step to a separate section further down the page to keep the intro example more concise.
  2. Show a DVCLive example, which will generate the markdown report on its own. Also, should the CML<>DVCLive live update workflow be documented somewhere in this page?
  3. Use cml pr and mention that you can view DVC metrics and plots in Studio (related: https://github.com/iterative/studio/issues/4232).
@casperdcl casperdcl added documentation Markdown files p1-important High priority external-request You asked, we did C: guide Content of /doc/user-guide labels Dec 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: guide Content of /doc/user-guide documentation Markdown files external-request You asked, we did p1-important High priority
Projects
None yet
Development

No branches or pull requests

2 participants