Skip to content

Commit

Permalink
drop metrics/plots stage outputs (#4798)
Browse files Browse the repository at this point in the history
  • Loading branch information
dberenbaum authored Aug 25, 2023
1 parent b07857f commit 9ad0b97
Show file tree
Hide file tree
Showing 7 changed files with 66 additions and 358 deletions.
3 changes: 0 additions & 3 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ specified with the `--targets` option (any valid plots file is accepted).
The plot style can be customized with [plot templates], using the `--template`
option. See `dvc plots` to learn more about plots files and templates.

> Note that the default behavior of this command can be modified per metrics
> file with `dvc plots modify`.
Another way to display plots is the `dvc plots show` command, which just lists
all the current plots, without comparisons.

Expand Down
7 changes: 2 additions & 5 deletions content/docs/command-reference/plots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,20 @@

A set of commands to visualize and compare data series or images from ML
projects: [show](/doc/command-reference/plots/show),
[diff](/doc/command-reference/plots/diff),
[modify](/doc/command-reference/plots/modify) and
[diff](/doc/command-reference/plots/diff), and
[templates](/doc/command-reference/plots/templates).

## Synopsis

```usage
usage: dvc plots [-h] [-q | -v] {show,diff,modify,templates} ...
usage: dvc plots [-h] [-q | -v] {show,diff,templates} ...
positional arguments:
COMMAND
show Generate plots from target files or from `plots`
definitions in `dvc.yaml`.
diff Show multiple versions of a plot by overlaying them
in a single image.
modify Modify display properties of data-series plots
defined in stages (has no effect on image plots).
templates List built-in plots templates or show JSON
specification for one.
```
Expand Down
167 changes: 0 additions & 167 deletions content/docs/command-reference/plots/modify.md

This file was deleted.

9 changes: 1 addition & 8 deletions content/docs/command-reference/plots/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@ All plots defined in `dvc.yaml` are used by default, but you can specify any
The plot style can be customized with [plot templates], using the `--template`
option. To learn more about plots file formats and templates, see `dvc plots`.

<admon type="tip">

The default behavior of this command can be modified per [stage plot] file with
`dvc plots modify`.

</admon>

[certain data]:
/doc/user-guide/experiment-management/visualizing-plots#supported-plot-file-formats
[plot templates]:
Expand Down Expand Up @@ -205,7 +198,7 @@ $ dvc plots show --no-header logs.csv -y 2
file:///Users/usr/src/dvc_plots/index.html
```

## Example: Top-level plots
## Example: `dvc.yaml` plots

### Simple plot definition

Expand Down
4 changes: 0 additions & 4 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -429,10 +429,6 @@
"label": "plots diff",
"slug": "diff"
},
{
"label": "plots modify",
"slug": "modify"
},
{
"label": "plots templates",
"slug": "templates"
Expand Down
47 changes: 0 additions & 47 deletions content/docs/user-guide/experiment-management/visualizing-plots.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,53 +188,6 @@ Refer to the [full format specification] and `dvc plots show` for more details.

</admon>

### Plot outputs

Plots can use any file defined in the project, including <abbr>outputs</abbr> of
[pipelines]:

```yaml
plots:
- logs.csv:
x: epoch
y: loss
stages:
build:
cmd: python train.py
outs:
- logs.csv
...
```

Alternatively, when defining [pipelines], some <abbr>outputs</abbr> (both files
and directories) can be placed under a `plots` list for the corresponding stage
in `dvc.yaml`. This will tell DVC that they are intended for visualization.

<admon type="info">

When using `dvc stage add`, use `--plots/--plots-no-cache` instead of
`--outs/--outs-no-cache`.

</admon>

```yaml
stages:
build:
cmd: python train.py
plots:
- logs.csv:
x: epoch
y: loss
...
```

Marking stage outputs as plots is convenient for working with plots at the stage
level, without having to write top-level `plots` definitions in `dvc.yaml`.
However, stage-level plots do not support custom plot IDs or multiple data
sources.

[pipelines]: /doc/start/data-management/data-pipelines

## Plot templates (data-series only)

DVC uses [Vega-Lite](https://vega.github.io/vega-lite/) JSON specifications to
Expand Down
Loading

0 comments on commit 9ad0b97

Please sign in to comment.