From f4e63330a25f718e40b262bce0ea0130cf16b029 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Redzy=C5=84ski?= Date: Tue, 22 Sep 2020 13:44:45 +0200 Subject: [PATCH 1/3] metrics: accept any viable target update --- content/docs/command-reference/plots/diff.md | 11 +++++------ content/docs/command-reference/plots/show.md | 4 ++-- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/content/docs/command-reference/plots/diff.md b/content/docs/command-reference/plots/diff.md index 413d54e5f6..bba11776d7 100644 --- a/content/docs/command-reference/plots/diff.md +++ b/content/docs/command-reference/plots/diff.md @@ -21,7 +21,8 @@ positional arguments: This command is a way to visualize the "difference" between metrics among experiments in the repository history, by plotting multiple -versions of the metrics. All plots defined in `dvc.yaml` are used by default. +versions of the metrics. All plots defined in `dvc.yaml` are used by default. If +`targets` are specified, they do not have to be defined in `dvc.yaml`. > Note that unlike `dvc metrics diff`, this command does not calculate numeric > differences between metrics file values. @@ -48,11 +49,9 @@ all the current plots, without comparisons. ## Options -- `--targets ` - 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 ` - 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 diff --git a/content/docs/command-reference/plots/show.md b/content/docs/command-reference/plots/show.md index 3d8d398f3e..ab4035eecf 100644 --- a/content/docs/command-reference/plots/show.md +++ b/content/docs/command-reference/plots/show.md @@ -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 metrics file `targets` to show are accepted. If `targets` +are present, they do not have to be defined in `dvc.yaml` as plots. The plot style can be customized with [plot templates](/doc/command-reference/plots#plot-templates), using the From 3c1e9514efc1ca8759c5ec1573d9efeefe7bdbf8 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 16 Oct 2020 18:42:50 -0500 Subject: [PATCH 2/3] Update content/docs/command-reference/plots/show.md --- content/docs/command-reference/plots/show.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/plots/show.md b/content/docs/command-reference/plots/show.md index ab4035eecf..8586b06341 100644 --- a/content/docs/command-reference/plots/show.md +++ b/content/docs/command-reference/plots/show.md @@ -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. If `targets` -are present, they do not have to be defined in `dvc.yaml` as plots. +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 From dca051e84a4e812e091cf9068e3f4414fcea32e5 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 16 Oct 2020 19:05:31 -0500 Subject: [PATCH 3/3] cmd: improve note about targets in plots diff per https://github.com/iterative/dvc.org/pull/1809#pullrequestreview-510850013 --- content/docs/command-reference/plots/diff.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/content/docs/command-reference/plots/diff.md b/content/docs/command-reference/plots/diff.md index bba11776d7..d0bf5504ab 100644 --- a/content/docs/command-reference/plots/diff.md +++ b/content/docs/command-reference/plots/diff.md @@ -21,21 +21,22 @@ positional arguments: This command is a way to visualize the "difference" between metrics among experiments in the repository history, by plotting multiple -versions of the metrics. All plots defined in `dvc.yaml` are used by default. If -`targets` are specified, they do not have to be defined in `dvc.yaml`. +versions of the metrics. All plots defined in `dvc.yaml` are used by default. > Note that unlike `dvc metrics diff`, this command does not calculate numeric > 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 -workspace (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 workspace +(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