Skip to content

Commit

Permalink
Restyled by prettier (#3857)
Browse files Browse the repository at this point in the history
Co-authored-by: Restyled.io <[email protected]>
  • Loading branch information
restyled-io[bot] and restyled-commits authored Aug 1, 2022
1 parent e37683a commit 3afea03
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 14 deletions.
16 changes: 9 additions & 7 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,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/user-guide/plots#plot-templates-data-series-only), using the `--template`
option. To learn more about plots files and templates please see `dvc plots`.
[plot templates](/doc/user-guide/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 @@ -66,9 +67,9 @@ 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/user-guide/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`.
[plot template](/doc/user-guide/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
Expand Down Expand Up @@ -146,8 +147,9 @@ cat,turtle
...
```

The predefined confusion matrix [template](/doc/user-guide/plots#plot-templates-data-series-only)
(in `.dvc/plots/confusion.json`) shows how metrics comparisons can be faceted by
The predefined confusion matrix
[template](/doc/user-guide/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
2 changes: 1 addition & 1 deletion content/docs/command-reference/plots/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Note that a secondary use of this command is to convert output or simple
## Options

- `-t <name_or_path>, --template <name_or_path>` - set a default
[plot template](/doc/user-guide/plots#plot-templates-data-series-only).
[plot template](/doc/user-guide/plots#plot-templates-data-series-only).

- `-x <field>` - set a default field or column name (or number) from which the X
axis data comes from.
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/plots/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ The default behavior of this command can be modified per [stage plot] file with
[`plots.out_dir`](/doc/command-reference/config#plots) config option.

- `-t <name_or_path>, --template <name_or_path>` -
[plot template](/doc/user-guide/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`.
[plot template](/doc/user-guide/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
Expand Down
7 changes: 4 additions & 3 deletions content/docs/user-guide/plots.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@ plots:
In that case the default behavior will be applied. DVC will take data from
`logs.csv` file and apply `linear` plot
[template](/doc/user-guide/plots#plot-templates-data-series-only) to the last found column (CSV,
TSV files) or field (JSON, YAML).
[template](/doc/user-guide/plots#plot-templates-data-series-only) to the last
found column (CSV, TSV files) or field (JSON, YAML).

We can customize the plot by adding appropriate fields to the configuration:

Expand Down Expand Up @@ -217,7 +217,8 @@ create plots from user data. A set of built-in _plot templates_ are included.

The `linear` template is the default. It can be changed with the `--template`
(`-t`) option of `dvc plots show` and `dvc plots diff`. The argument provided to
`--template` can be a (built-in) template name or a path to a [custom template](#custom-templates).
`--template` can be a (built-in) template name or a path to a
[custom template](#custom-templates).

<admon type="tip">

Expand Down

0 comments on commit 3afea03

Please sign in to comment.