Skip to content

Commit c72dafc

Browse files
restyled-io[bot]paredjorgeorpineldberenbaumrestyled-commits
authored
Restyle cmd-ref: plots: flexible plots docs (#3819)
* cmd-ref: plots: flexible plots docs Related: treeverse/dvc#7477 Related: #2956 * Update content/docs/user-guide/project-structure/dvcyaml-files.md * Apply suggestions from code review * Update content/docs/command-reference/plots/index.md * plots: examples: move to subcommands * plots: refactor top-level plots definition * plots: review refactor * Update content/docs/command-reference/plots/index.md * ref: fix a link (2/2) per #3691 (review) * ref: remove concept of type of metrics * ref: term "plots files" (consistency) * ref: wrap `plots index` usage block * plots: top-level plots edits * plots: improve motivation for top-level plots per #3691 (review) * ref: edit `plots show` desc * ref: return plot template examples from `plots show` to index * guide: move top-lv plot mention from stage entry to desc * ref: clean up new `plots show` examples * ref: more copy edits around plots * Update content/docs/user-guide/project-structure/dvcyaml-files.md * Update content/docs/command-reference/plots/index.md * Update content/docs/command-reference/plots/index.md * Update content/docs/command-reference/plots/index.md * Restyled by prettier Co-authored-by: Paweł Redzyński <[email protected]> Co-authored-by: Jorge Orpinel <[email protected]> Co-authored-by: Jorge Orpinel Perez <[email protected]> Co-authored-by: Dave Berenbaum <[email protected]> Co-authored-by: Restyled.io <[email protected]> Co-authored-by: Dave Berenbaum <[email protected]>
1 parent f157a73 commit c72dafc

21 files changed

+452
-175
lines changed

content/docs/command-reference/metrics/index.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,16 @@ positional arguments:
1515
diff Show changes in metrics between commits.
1616
```
1717

18-
## Types of metrics
19-
20-
DVC has two concepts for metrics, that represent different results of machine
21-
learning training or data processing:
22-
23-
1. `dvc metrics` represent **scalar numbers** such as AUC, _true positive rate_,
24-
etc.
25-
2. `dvc plots` can be used to visualize **data series** such as AUC curves, loss
26-
functions, confusion matrices, etc.
27-
2818
## Description
2919

3020
In order to follow the performance of machine learning experiments, DVC has the
3121
ability to mark a certain stage <abbr>outputs</abbr> as metrics. These metrics
3222
are project-specific floating-point or integer values e.g. AUC, ROC, false
3323
positives, etc.
3424

35-
This type of metrics files are typically generated by user data processing code,
36-
and are tracked using the `-m` (`--metrics`) and `-M` (`--metrics-no-cache`)
37-
options of `dvc stage add`.
25+
Metrics files are typically generated by user data processing code, and are
26+
tracked using the `-m` (`--metrics`) and `-M` (`--metrics-no-cache`) options of
27+
`dvc stage add`.
3828

3929
In contrast to `dvc plots`, these metrics should be stored in hierarchical
4030
files. Unlike its `dvc plots` counterpart, `dvc metrics diff` can report the

content/docs/command-reference/plots/diff.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# plots diff
22

3-
Show multiple versions of [plot metrics](/doc/command-reference/plots) by
4-
overlaying them in a single image. This allows to compare them easily.
3+
Show multiple versions of [plots](/doc/command-reference/plots) by overlaying
4+
them in a single image. This allows to compare them easily.
55

66
## Synopsis
77

@@ -123,11 +123,11 @@ file:///Users/usr/src/dvc_plots/index.html
123123
Compare two specific versions (commit hashes, tags, or branches):
124124

125125
```cli
126-
$ dvc plots diff HEAD 0135527 --targets logs.csv
126+
$ dvc plots diff HEAD^ 0135527 --targets logs.csv
127127
file:///Users/usr/src/dvc_plots/index.html
128128
```
129129

130-
![](/img/plots_diff.svg)
130+
![](/img/plots_diff_two_revs.svg)
131131

132132
## Example: Confusion matrix
133133

0 commit comments

Comments
 (0)