Skip to content

Commit

Permalink
Merge pull request #1809 from iterative/4446_metrics
Browse files Browse the repository at this point in the history
plots and metrics: update new targets rules
  • Loading branch information
jorgeorpinel authored Oct 20, 2020
2 parents 97e5f95 + dca051e commit e8588ff
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,16 @@ versions of the metrics. All plots defined in `dvc.yaml` are used by default.
> differences between metrics file values.
`revisions` are Git commit hashes, tag, or branch names. If none are specified,
`dvc plots diff` compares targets currently present in the
<abbr>workspace</abbr> (uncommitted changes) with their latest committed
versions (required). A single specified revision results in comparing the
workspace and that version.
`dvc plots diff` compares plots currently present in the <abbr>workspace</abbr>
(uncommitted changes) with their latest commit (required). A single specified
revision results in comparing the workspace and that version.

Note that any number of `revisions` can be provided, and the resulting plot
💡 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`.

The plot style can be customized with
[plot templates](/doc/command-reference/plots#plot-templates), using the
`--template` option. To learn more about metrics file formats and templates
Expand All @@ -48,11 +50,9 @@ all the current plots, without comparisons.

## Options

- `--targets <path>` - specific metrics files to visualize. These must be listed
in a [`dvc.yaml`](/doc/user-guide/dvc-files-and-directories#dvcyaml-file) file
(see the `--plots` option of `dvc run`). When specifying arguments for
`--targets` before `revisions`, you should use `--` after this option's
arguments, e.g.:
- `--targets <path>` - specific metrics files to visualize. When specifying
arguments for `--targets` before `revisions`, you should use `--` after this
option's arguments, e.g.:

```dvc
$ dvc plots diff --targets t1.json t2.csv -- HEAD v1 v2
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/plots/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ 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.

Optionally, specific metrics file `targets` to show are accepted. These must be
listed in a `dvc.yaml` file (see the `--plots` option of `dvc run`).
Optionally, specific metric file `targets` to show are accepted. Note that these
don't have to be defined as `plots` 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 e8588ff

Please sign in to comment.