Skip to content

Commit

Permalink
cmd: simplify exaplnations about plots files being or not in dvc.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Oct 22, 2020
1 parent e558945 commit 27519b4
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
11 changes: 6 additions & 5 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ positional arguments:

## Description

This command is a way to visualize the "difference" between metrics among
experiments in the <abbr>repository</abbr> history, by plotting multiple
versions of the metrics. All plots defined in `dvc.yaml` are used by default.
This command is a way to visualize the "difference" between
[certain metrics](/doc/command-reference/plots#supported-file-formats) among
versions of the <abbr>repository</abbr>, by overlaying them in a single plot.

> Note that unlike `dvc metrics diff`, this command does not calculate numeric
> differences between metrics file values.
Expand All @@ -34,8 +34,9 @@ revision results in comparing the workspace and that version.
💡 Note that any number of `revisions` can be provided, and the resulting plot
shows all of them in a single image.

Specific plots files can be specified with the `--targets` option. Note that
these don't have to be defined as `plots` in `dvc.yaml`.
All plots defined in `dvc.yaml` are used by default, but specific plots files
can be specified with the `--targets` option (note that targets don't
necessarily have to be defined in `dvc.yaml`).

The plot style can be customized with
[plot templates](/doc/command-reference/plots#plot-templates), using the
Expand Down
12 changes: 5 additions & 7 deletions content/docs/command-reference/plots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,13 @@ learning training or data processing:

## Description

DVC provides a set of commands to visualize metrics of machine learning
experiments. Usual plot examples are AUC curves, loss functions, confusion
matrices, among others.
DVC provides a set of commands to visualize certain metrics of machine learning
experiments as plots. Usual plot examples are AUC curves, loss functions,
confusion matrices, among others.

This type of metrics files are created by users, or generated by user data
processing code, and can be defined in `dvc.yaml` stages (using the `--plots`
and `--plots-no-cache` options if using `dvc run`). `dvc plots show` and
`dvc plots diff` can work with any valid plots files in the system, whether
tracked by Git or DVC, or not.
processing code, and can be defined in `dvc.yaml` (`plots` field) for tracking
(optional).

DVC generates plots as HTML files that can be open with a web browser. These
HTML files use [Vega-Lite](https://vega.github.io/vega-lite/). Vega is a
Expand Down
11 changes: 6 additions & 5 deletions content/docs/command-reference/plots/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,13 @@ positional arguments:

## Description

This command provides a quick way to visualize metrics such as loss functions,
AUC curves, confusion matrices, etc. All plots defined in `dvc.yaml` are used by
default.
This command provides a quick way to visualize
[certain metrics](/doc/command-reference/plots#supported-file-formats) such as
loss functions, AUC curves, confusion matrices, etc.

Optionally, specific metric file `targets` to show are accepted. Note that these
don't have to be defined as `plots` in `dvc.yaml`.
All plots defined in `dvc.yaml` are used by default, but specific plots files
can be specified as `targets` (note that targets don't necessarily have to be
defined in `dvc.yaml`).

The plot style can be customized with
[plot templates](/doc/command-reference/plots#plot-templates), using the
Expand Down

0 comments on commit 27519b4

Please sign in to comment.