|
1 | | -# Plots |
| 1 | +# Plots Dashboard |
2 | 2 |
|
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. |
6 | 7 |
|
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! |
12 | 14 |
|
13 | 15 | <p align="center"> |
14 | 16 | <img src="images/plots-dump-with-open-file.png" |
15 | 17 | 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" /> |
18 | 18 | <img src="images/plots-dump-image.png" |
19 | 19 | 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" /> |
20 | 22 | </p> |
21 | 23 |
|
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): |
28 | 29 |
|
29 | 30 | <p align="center"> |
30 | 31 | <img src="images/plots-data-series.png" |
31 | 32 | alt="Plots: Data Series" /> |
32 | 33 | </p> |
33 | 34 |
|
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/ |
36 | 42 |
|
37 | 43 | <p align="center"> |
38 | 44 | <img src="images/plots-images.png" |
39 | 45 | alt="Plots: Images" /> |
40 | 46 | </p> |
41 | 47 |
|
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 | | - |
45 | 48 | <p align="center"> |
46 | 49 | <img src="images/plots-trends.png" |
47 | 50 | alt="Plots: Trends" /> |
48 | 51 | </p> |
49 | 52 |
|
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. |
55 | 55 |
|
56 | 56 | <p float="left"> |
57 | 57 | <img src="images/plots-plots-view-icon.png" |
58 | 58 | alt="Plots View" width="49%" /> |
59 | 59 | <img src="images/plots-experiments-view-icon.png" |
60 | 60 | alt="Experiments View" width="49%" /> |
61 | 61 | </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. |
0 commit comments