Reduce CML with DVC report generation code
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 13
- Fork
- 22
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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).
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla pagina cml.dev/doc/cml-with-dvc e confronta gli esempi YAML per GitHub e GitLab. Esamina la posizione proposta del passaggio di report, gli esempi di DVCLive e `cml pr` e il riferimento a Studio; il lavoro è completato quando l’esempio introduttivo è più breve e i workflow pertinenti sono documentati chiaramente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github, gitlab, markdown, typescript, yaml
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100