-
Notifications
You must be signed in to change notification settings - Fork 29
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
plots: copy edit walkthrough and dashboard tooltips #1922
Merged
Merged
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
49eec05
walks: link to Vega-lite docs from Plots and
jorgeorpinel 2b6b8f1
plots: better tooltips from Dashboard
jorgeorpinel 64b624d
walks: copy edit Plots
jorgeorpinel 4b641c8
Merge branch 'main' into editors/plots-dashboard
jorgeorpinel 51e4f48
Update extension/resources/walkthrough/plots.md
jorgeorpinel abc0ff8
Update webview/src/plots/components/PlotsContainer.tsx
shcheklein c6bed38
Update extension/resources/walkthrough/plots.md
shcheklein 562bae5
walks: shorten Plots
jorgeorpinel 5f4d273
Merge branch 'editors/plots-dashboard' of github.com:iterative/vscode…
jorgeorpinel a9bb31b
plots: graph -> plot/visualize
jorgeorpinel 2151326
walks: Plots +Dashboard
jorgeorpinel 376b3d0
move code
jorgeorpinel 76a5b79
Update extension/resources/walkthrough/plots.md
jorgeorpinel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,72 @@ | ||
# Plots | ||
# Plots Dashboard | ||
|
||
Select one or more experiments to visualize them in the | ||
[`Plots Dashboard`](command:dvc.showPlots). This is the extension's equivalent | ||
of the `dvc plots show` and `dvc plots diff` commands. | ||
Select one or more experiments to visualize in the | ||
[**Plots Dashboard**](command:dvc.showPlots). Use | ||
[`DVC: Show Plots`](command:workbench.action.quickOpen?%22>DVC:%20Show%20Plots%22) | ||
from the command palette to open it. | ||
|
||
💡 If you don't have any DVC | ||
[plots](https://dvc.org/doc/command-reference/plots) in the project, start | ||
writing data points into JSON, YAML, CSV or TSV or saving plots as images | ||
(`.png`, etc) (check the [DVCLive](https://dvc.org/doc/dvclive) helper library | ||
if you use Python): | ||
[`dvc plots show`]: https://dvc.org/doc/command-reference/plots/show | ||
[`dvc plots diff`]: https://dvc.org/doc/command-reference/plots/diff | ||
|
||
💡 To add [DVC plots] to the project, start writing data series into JSON, YAML, | ||
CSV, or TSV files; or save your own plot images (`.png`, etc.). If you're using | ||
Python, the [DVCLive] helper library can save plots data for you! | ||
|
||
<p align="center"> | ||
<img src="images/plots-dump-with-open-file.png" | ||
alt="Code to Dump a JSON Plot File" /> | ||
<img src="images/plots-dump-with-dvclive.png" | ||
alt="Code to Dump a JSON Plot File with DVCLive" /> | ||
<img src="images/plots-dump-image.png" | ||
alt="Code to Dump an Image Plot File" /> | ||
<img src="images/plots-dump-with-dvclive.png" | ||
alt="Code to Dump a JSON Plot File with DVCLive" /> | ||
</p> | ||
|
||
Use `DVC: Show Plots` from the | ||
[Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Plots%22) | ||
to open up the plots dashboard. The extension will display the following | ||
sections for selected experiments, that correspond to the different | ||
[types of plots](https://dvc.org/doc/command-reference/plots#supported-file-formats) | ||
supported by DVC: | ||
[dvc plots]: https://dvc.org/doc/start/experiments/visualization | ||
[dvclive]: https://dvc.org/doc/dvclive | ||
|
||
These are the types of plots that can be displayed (for the selected | ||
experiments): | ||
|
||
<p align="center"> | ||
<img src="images/plots-data-series.png" | ||
alt="Plots: Data Series" /> | ||
</p> | ||
|
||
`Data Series`. JSON, YAML, CSV or TSV files visualized using the predefined | ||
(e.g. confusion matrix, linear) or custom (Vega-lite) templates. | ||
**Data Series** are JSON, YAML, CSV, or TSV files visualized using [plot | ||
templates], which may be predefined (e.g. confusion matrix, linear) or custom | ||
([Vega-lite] files) | ||
|
||
[plot templates]: | ||
https://dvc.org/doc/command-reference/plots#plot-templates-data-series-only | ||
[vega-lite]: https://vega.github.io/vega-lite/ | ||
|
||
<p align="center"> | ||
<img src="images/plots-images.png" | ||
alt="Plots: Images" /> | ||
</p> | ||
|
||
`Images`. Any image file (e,g `.png`) can be visualized as a plot. They will be | ||
rendered side by side in the table. | ||
|
||
<p align="center"> | ||
<img src="images/plots-trends.png" | ||
alt="Plots: Trends" /> | ||
</p> | ||
|
||
`Trends`. Linear plots based on data from the experiments table if you use | ||
[checkpoints](https://dvc.org/doc/user-guide/experiment-management/checkpoints). | ||
|
||
The plots dashboard can be configured and accessed using using the `Plots` and | ||
`Experiments` views: | ||
**Images** (e.g. `.jpg` or `.svg` files) can be visualized as well. They will be | ||
rendered side by side for the selected experiments. | ||
|
||
<p float="left"> | ||
<img src="images/plots-plots-view-icon.png" | ||
alt="Plots View" width="49%" /> | ||
<img src="images/plots-experiments-view-icon.png" | ||
alt="Experiments View" width="49%" /> | ||
</p> | ||
|
||
Real-time **Trends** based on scalar [metrics] from the **Experiments Table** | ||
are available when you use [checkpoints]. | ||
|
||
[metrics]: https://dvc.org/doc/command-reference/metrics | ||
[checkpoints]: https://dvc.org/doc/user-guide/experiment-management/checkpoints | ||
|
||
The **Plots Dashboard** can be configured and accessed from the _Plots_ and | ||
_Experiments_ side panels in the **DVC view**. | ||
jorgeorpinel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
> This is equivalent to the [`dvc plots show`] and [`dvc plots diff`] commands. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need both links? I think they do the same thing in the end.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it educates ppl a bit more