-
Notifications
You must be signed in to change notification settings - Fork 23
Open
Labels
C: guideContent of /doc/user-guideContent of /doc/user-guidedocumentationMarkdown filesMarkdown filesexternal-requestYou asked, we didYou asked, we didp1-importantHigh priorityHigh priority
Description
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:
- Move that step to a separate section further down the page to keep the intro example more concise.
- 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?
- Use
cml prand mention that you can view DVC metrics and plots in Studio (related: https://github.com/iterative/studio/issues/4232).
casperdcl and dtrifiro
Metadata
Metadata
Assignees
Labels
C: guideContent of /doc/user-guideContent of /doc/user-guidedocumentationMarkdown filesMarkdown filesexternal-requestYou asked, we didYou asked, we didp1-importantHigh priorityHigh priority