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.

Sign up for GitHub

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

plots and metrics: update new targets rules #1809

Merged
merged 3 commits into from
Oct 20, 2020
Merged

plots and metrics: update new targets rules #1809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4e6333
metrics: accept any viable target update
pared Sep 22, 2020
3c1e951
Update content/docs/command-reference/plots/show.md
jorgeorpinel Oct 16, 2020
dca051e
cmd: improve note about targets in plots diff
jorgeorpinel Oct 17, 2020
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
20 changes: 10 additions & 10 deletions content/docs/command-reference/plots/diff.md
View file
Open in desktop
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
View file
Open in desktop
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