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

Restyle cmd-ref: plots: flexible plots docs #3819

Merged
merged 26 commits into from
Jul 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
097d013
cmd-ref: plots: flexible plots docs
pared Jun 21, 2022
2283123
Update content/docs/user-guide/project-structure/dvcyaml-files.md
jorgeorpinel Jul 21, 2022
38aceb2
Apply suggestions from code review
jorgeorpinel Jul 21, 2022
5bf8c5b
Update content/docs/command-reference/plots/index.md
jorgeorpinel Jul 21, 2022
f85a35e
plots: examples: move to subcommands
pared Jul 21, 2022
716bd8b
plots: refactor top-level plots definition
pared Jul 21, 2022
1f3ae00
plots: review refactor
pared Jul 22, 2022
984102f
Update content/docs/command-reference/plots/index.md
jorgeorpinel Jul 26, 2022
eef0e2f
ref: fix a link (2/2)
jorgeorpinel Jul 26, 2022
44ac295
Merge branch 'main' into 7086_flexible_plots
jorgeorpinel Jul 26, 2022
4a25f0c
ref: remove concept of type of metrics
jorgeorpinel Jul 26, 2022
88e5914
ref: term "plots files" (consistency)
jorgeorpinel Jul 26, 2022
725b0b9
ref: wrap `plots index` usage block
jorgeorpinel Jul 26, 2022
5ab3dbc
plots: top-level plots edits
jorgeorpinel Jul 27, 2022
d73e909
plots: improve motivation for top-level plots
jorgeorpinel Jul 27, 2022
921b00c
ref: edit `plots show` desc
jorgeorpinel Jul 27, 2022
e295298
ref: return plot template examples from `plots show` to index
jorgeorpinel Jul 27, 2022
20fb298
guide: move top-lv plot mention from stage entry to desc
jorgeorpinel Jul 27, 2022
5a762d6
ref: clean up new `plots show` examples
jorgeorpinel Jul 27, 2022
aac654e
ref: more copy edits around plots
jorgeorpinel Jul 27, 2022
764654c
Update content/docs/user-guide/project-structure/dvcyaml-files.md
dberenbaum Jul 27, 2022
8cc50bc
Update content/docs/command-reference/plots/index.md
dberenbaum Jul 27, 2022
f0c88a8
Update content/docs/command-reference/plots/index.md
dberenbaum Jul 27, 2022
839fd63
Update content/docs/command-reference/plots/index.md
dberenbaum Jul 27, 2022
22e13f1
Restyled by prettier
restyled-commits Jul 27, 2022
3c427e3
Merge branch 'main' into restyled/7086_flexible_plots
Jul 28, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions content/docs/command-reference/metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,16 @@ positional arguments:
diff Show changes in metrics between commits.
```

## Types of metrics

DVC has two concepts for metrics, that represent different results of machine
learning training or data processing:

1. `dvc metrics` represent **scalar numbers** such as AUC, _true positive rate_,
etc.
2. `dvc plots` can be used to visualize **data series** such as AUC curves, loss
functions, confusion matrices, etc.

## Description

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

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

In contrast to `dvc plots`, these metrics should be stored in hierarchical
files. Unlike its `dvc plots` counterpart, `dvc metrics diff` can report the
Expand Down
8 changes: 4 additions & 4 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# plots diff

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

## Synopsis

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

```cli
$ dvc plots diff HEAD 0135527 --targets logs.csv
$ dvc plots diff HEAD^ 0135527 --targets logs.csv
file:///Users/usr/src/dvc_plots/index.html
```

![](/img/plots_diff.svg)
![](/img/plots_diff_two_revs.svg)

## Example: Confusion matrix

Expand Down
Loading