Skip to content

Commit 79a52d5

Browse files
authored
Merge pull request #1922 from iterative/editors/plots-dashboard
plots: copy edit walkthrough and dashboard tooltips
2 parents 4fa290a + 76a5b79 commit 79a52d5

File tree

3 files changed

+45
-31
lines changed

3 files changed

+45
-31
lines changed

extension/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1416,7 +1416,7 @@
14161416
},
14171417
{
14181418
"id": "dvc.plots",
1419-
"title": "Plots",
1419+
"title": "Plots Dashboard",
14201420
"description": "Visualize and compare multiple experiments with interactive customizable charts.\n[Show Plots](command:dvc.showPlots)",
14211421
"media": {
14221422
"markdown": "resources/walkthrough/plots.md"
Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,72 @@
1-
# Plots
1+
# Plots Dashboard
22

3-
Select one or more experiments to visualize them in the
4-
[`Plots Dashboard`](command:dvc.showPlots). This is the extension's equivalent
5-
of the `dvc plots show` and `dvc plots diff` commands.
3+
Select one or more experiments to visualize in the
4+
[**Plots Dashboard**](command:dvc.showPlots). Use
5+
[`DVC: Show Plots`](command:workbench.action.quickOpen?%22>DVC:%20Show%20Plots%22)
6+
from the command palette to open it.
67

7-
💡 If you don't have any DVC
8-
[plots](https://dvc.org/doc/command-reference/plots) in the project, start
9-
writing data points into JSON, YAML, CSV or TSV or saving plots as images
10-
(`.png`, etc) (check the [DVCLive](https://dvc.org/doc/dvclive) helper library
11-
if you use Python):
8+
[`dvc plots show`]: https://dvc.org/doc/command-reference/plots/show
9+
[`dvc plots diff`]: https://dvc.org/doc/command-reference/plots/diff
10+
11+
💡 To add [DVC plots] to the project, start writing data series into JSON, YAML,
12+
CSV, or TSV files; or save your own plot images (`.png`, etc.). If you're using
13+
Python, the [DVCLive] helper library can save plots data for you!
1214

1315
<p align="center">
1416
<img src="images/plots-dump-with-open-file.png"
1517
alt="Code to Dump a JSON Plot File" />
16-
<img src="images/plots-dump-with-dvclive.png"
17-
alt="Code to Dump a JSON Plot File with DVCLive" />
1818
<img src="images/plots-dump-image.png"
1919
alt="Code to Dump an Image Plot File" />
20+
<img src="images/plots-dump-with-dvclive.png"
21+
alt="Code to Dump a JSON Plot File with DVCLive" />
2022
</p>
2123

22-
Use `DVC: Show Plots` from the
23-
[Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Plots%22)
24-
to open up the plots dashboard. The extension will display the following
25-
sections for selected experiments, that correspond to the different
26-
[types of plots](https://dvc.org/doc/command-reference/plots#supported-file-formats)
27-
supported by DVC:
24+
[dvc plots]: https://dvc.org/doc/start/experiments/visualization
25+
[dvclive]: https://dvc.org/doc/dvclive
26+
27+
These are the types of plots that can be displayed (for the selected
28+
experiments):
2829

2930
<p align="center">
3031
<img src="images/plots-data-series.png"
3132
alt="Plots: Data Series" />
3233
</p>
3334

34-
`Data Series`. JSON, YAML, CSV or TSV files visualized using the predefined
35-
(e.g. confusion matrix, linear) or custom (Vega-lite) templates.
35+
**Data Series** are JSON, YAML, CSV, or TSV files visualized using [plot
36+
templates], which may be predefined (e.g. confusion matrix, linear) or custom
37+
([Vega-lite] files)
38+
39+
[plot templates]:
40+
https://dvc.org/doc/command-reference/plots#plot-templates-data-series-only
41+
[vega-lite]: https://vega.github.io/vega-lite/
3642

3743
<p align="center">
3844
<img src="images/plots-images.png"
3945
alt="Plots: Images" />
4046
</p>
4147

42-
`Images`. Any image file (e,g `.png`) can be visualized as a plot. They will be
43-
rendered side by side in the table.
44-
4548
<p align="center">
4649
<img src="images/plots-trends.png"
4750
alt="Plots: Trends" />
4851
</p>
4952

50-
`Trends`. Linear plots based on data from the experiments table if you use
51-
[checkpoints](https://dvc.org/doc/user-guide/experiment-management/checkpoints).
52-
53-
The plots dashboard can be configured and accessed using using the `Plots` and
54-
`Experiments` views:
53+
**Images** (e.g. `.jpg` or `.svg` files) can be visualized as well. They will be
54+
rendered side by side for the selected experiments.
5555

5656
<p float="left">
5757
<img src="images/plots-plots-view-icon.png"
5858
alt="Plots View" width="49%" />
5959
<img src="images/plots-experiments-view-icon.png"
6060
alt="Experiments View" width="49%" />
6161
</p>
62+
63+
Real-time **Trends** based on scalar [metrics] from the **Experiments Table**
64+
are available when you use [checkpoints].
65+
66+
[metrics]: https://dvc.org/doc/command-reference/metrics
67+
[checkpoints]: https://dvc.org/doc/user-guide/experiment-management/checkpoints
68+
69+
The **Plots Dashboard** can be configured and accessed from the _Plots_ and
70+
_Experiments_ side panels in the [**DVC View**](command:views.dvc-views).
71+
72+
> This is equivalent to the [`dvc plots show`] and [`dvc plots diff`] commands.

webview/src/plots/components/PlotsContainer.tsx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,15 @@ export type BasicContainerProps = Pick<
3131
>
3232

3333
export const SectionDescription = {
34+
// "Trends"
3435
[Section.CHECKPOINT_PLOTS]:
35-
'Linear plots based on data from the experiments table.',
36+
'Real-time plots based on metrics from the Experiments Table',
37+
// "Images"
3638
[Section.COMPARISON_TABLE]:
37-
'A table used to display image plots side by side.',
39+
'Displays image plots side by side across experiments.',
40+
// "Data Series"
3841
[Section.TEMPLATE_PLOTS]:
39-
'JSON, YAML, CSV or TSV files visualized using Vega pre-defined or custom Vega-Lite templates.'
42+
'Plots of JSON, YAML, CSV, or TSV files, visualized using `dvc plots` templates'
4043
}
4144

4245
const InfoIcon = () => (

0 commit comments

Comments
 (0)