iterative / example-repos-dev

Source code and generator scripts for example DVC projects
https://dvc.org/doc
21 stars 13 forks source link

use default dvclive plots #282

Closed dberenbaum closed 5 months ago

dberenbaum commented 5 months ago

When going through https://dvc.org/doc/start/data-pipelines/metrics-parameters-plots, no plots are generated unless the user manually edits dvc.yaml because we set Live(dvcyaml=False) here:

https://github.com/iterative/example-repos-dev/blob/bc47159c46e26f0209b0065c9344376762d91301/example-get-started/code/src/evaluate.py#L103

We set custom plots in dvc.yaml, but dvc.yaml is not downloaded as part of the get started tutorial's code.zip, so no plots will show for users.

This PR drops dvcyaml=False in code.zip, so that following the tutorial starts with the default dvclive plots. This PR also adds a step in generate.sh to edit the code to add dvcyaml=False and replace with the custom plots so we end up with the same nice-looking plots at the end. We can explain this as an optional step in the docs.