From 27519b4ad4c31bd0bf33ddfce9fbc76e3ed577c7 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 22 Oct 2020 18:00:38 -0500 Subject: [PATCH] cmd: simplify exaplnations about plots files being or not in dvc.yaml per https://github.com/iterative/dvc.org/pull/1881#pullrequestreview-513228760 --- content/docs/command-reference/plots/diff.md | 11 ++++++----- content/docs/command-reference/plots/index.md | 12 +++++------- content/docs/command-reference/plots/show.md | 11 ++++++----- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/content/docs/command-reference/plots/diff.md b/content/docs/command-reference/plots/diff.md index d0bf5504ab..5bcd21353d 100644 --- a/content/docs/command-reference/plots/diff.md +++ b/content/docs/command-reference/plots/diff.md @@ -19,9 +19,9 @@ positional arguments: ## Description -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. +This command is a way to visualize the "difference" between +[certain metrics](/doc/command-reference/plots#supported-file-formats) among +versions of the repository, by overlaying them in a single plot. > Note that unlike `dvc metrics diff`, this command does not calculate numeric > differences between metrics file values. @@ -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 diff --git a/content/docs/command-reference/plots/index.md b/content/docs/command-reference/plots/index.md index df602b5299..9a9af955bf 100644 --- a/content/docs/command-reference/plots/index.md +++ b/content/docs/command-reference/plots/index.md @@ -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 diff --git a/content/docs/command-reference/plots/show.md b/content/docs/command-reference/plots/show.md index 326fb34444..441380cb5e 100644 --- a/content/docs/command-reference/plots/show.md +++ b/content/docs/command-reference/plots/show.md @@ -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