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.

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

guide: make plots guide #3830

Merged
merged 13 commits into from
Aug 10, 2022
4 changes: 2 additions & 2 deletions content/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,8 +324,8 @@ experiments or projects use a similar structure.
generated by `dvc plots` commands in a browser. `false` by default

- `plots.html_template` - sets a
[custom HTML template](/doc/command-reference/plots#html-templates) for
`dvc plots`. Accepts a path relative to the `.dvc/` folder.
[custom HTML template](/doc/command-reference/plots/show#custom-html-templates)
for `dvc plots`. Accepts a path relative to the `.dvc/` folder.

- `plots.out_dir` - changes the default value for `dvc plots show --out` and
`dvc plots diff --out`. The original default value is `dvc_plots`.
Expand Down
25 changes: 13 additions & 12 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ positional arguments:
## Description

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.
[certain metrics](/doc/user-guide/visualizing-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 plots file values.
Expand All @@ -39,9 +40,9 @@ All plots defined in `dvc.yaml` are used by default, but specific files can be
specified with the `--targets` option (any valid plots file is accepted).

The plot style can be customized with
[plot templates](/doc/command-reference/plots#plot-templates), using the
`--template` option. To learn more about plots files and templates please see
`dvc plots`.
[plot templates](/doc/user-guide/visualizing-plots#plot-templates-data-series-only),
using the `--template` option. To learn more about plots files and templates
please see `dvc plots`.

> Note that the default behavior of this command can be modified per metrics
> file with `dvc plots modify`.
Expand All @@ -67,13 +68,13 @@ all the current plots, without comparisons.
[`plots.out_dir`](/doc/command-reference/config#plots) config option.

- `-t <name_or_path>, --template <name_or_path>` -
[plot template](/doc/command-reference/plots#plot-templates) to be injected
with data. The default template is `.dvc/plots/default.json`. See more details
in `dvc plots`.
[plot template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only)
to be injected with data. The default template is `.dvc/plots/default.json`.
See more details in `dvc plots`.

- `-x <field>` - field name from which the X axis data comes from. An
auto-generated `index` field is used by default. See
[Custom templates](/doc/command-reference/plots#custom-templates) for more
[Custom templates](/doc/command-reference/plots/templates) for more
information on this `index` field. Column names or numbers are expected for
tabular metrics files.

Expand All @@ -98,7 +99,7 @@ all the current plots, without comparisons.
names.

- `--html-template <path>` - path to a
[custom HTML template](/doc/command-reference/plots#html-templates).
[custom HTML template](/doc/command-reference/plots/show#custom-html-templates).

- `-h`, `--help` - prints the usage/help message, and exit.

Expand Down Expand Up @@ -148,8 +149,8 @@ cat,turtle
```

The predefined confusion matrix
[template](/doc/command-reference/plots#plot-templates) (in
`.dvc/plots/confusion.json`) shows how metrics comparisons can be faceted by
[template](/doc/user-guide/visualizing-plots#plot-templates-data-series-only)
(in `.dvc/plots/confusion.json`) shows how metrics comparisons can be faceted by
separate plots. It can be enabled with `-t` (`--template`):

```cli
Expand Down
Loading