-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d22127e
commit df9fdb1
Showing
39 changed files
with
290 additions
and
100 deletions.
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
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,9 +1,32 @@ | ||
# Experiments Table | ||
|
||
The extension's equivalent of `dvc exp show`. | ||
> ❗ DVC should be installed and DVC project available in the workspace for this | ||
> and the next steps to work properly. Please refer to first two steps of this | ||
> guide. | ||
Use `DVC: Show Experiments` from the Command Palette to open up the experiments | ||
table for a `DVC` repository. | ||
As you change code, parameters, data and run new experiments this table will | ||
keep all the details about your iterations. It can be manipulated and configured | ||
using the [DVC side panel](command:workbench.view.extension.dvc-views). This is | ||
the extension's equivalent of the `dvc exp show` command. | ||
|
||
The view can be manipulated using the controls shown in the extension's view | ||
container. | ||
<p align="center"> | ||
<img src="images/experiments-table.png" alt="Experiment Table" /> | ||
</p> | ||
|
||
Use `DVC: Show Experiments` from the | ||
[Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Experiments%22) | ||
to open up the experiments table or access it, using the Columns view: | ||
|
||
<p align="center"> | ||
<img src="images/experiments-table-from-side-bar.png" | ||
alt="Columns View" /> | ||
</p> | ||
|
||
Table provides context menus to access basic operation on experiments and table | ||
headers. You can edit parameters, apply sort or filter, run new experiments and | ||
more: | ||
|
||
<p align="center"> | ||
<img src="images/experiments-table-context-menus.png" | ||
alt="Experiments Table: Context Menus" /> | ||
</p> |
Binary file added
BIN
+49 KB
extension/resources/walkthrough/images/available-commands-command-palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+185 KB
extension/resources/walkthrough/images/experiments-table-context-menus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+89.8 KB
extension/resources/walkthrough/images/experiments-table-from-side-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+10.2 KB
extension/resources/walkthrough/images/install-dvc-status-bar-detected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+56.6 KB
extension/resources/walkthrough/images/plots-experiments-view-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+61.4 KB
extension/resources/walkthrough/images/run-experiments-command-palette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+61.8 KB
extension/resources/walkthrough/images/run-experiments-params-buttons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+63.9 KB
extension/resources/walkthrough/images/run-experiments-table-buttons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+11.5 KB
extension/resources/walkthrough/images/setup-project-dump-metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+20 KB
extension/resources/walkthrough/images/setup-project-dvc-yaml-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+19.7 KB
extension/resources/walkthrough/images/setup-project-dvclive-metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+55.5 KB
extension/resources/walkthrough/images/view-container-experiments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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,13 +1,24 @@ | ||
# Install DVC | ||
|
||
There are quite a few options for installing `DVC`. This extension supports | ||
various installation types. See the `Setup The Workspace` step for more details. | ||
There are a few [options](https://dvc.org/doc/install) for installing `DVC`. | ||
This extension supports all installation types. | ||
|
||
To install the latest version of `DVC` follow your platform specific guide on | ||
[dvc.org](https://dvc.org/doc/install). | ||
To verify the installation run `dvc -h` in a | ||
[Terminal](command:workbench.action.terminal.new). | ||
|
||
To verify the installation run `dvc -h` in your terminal of choice. | ||
If DVC is installed as a global binary or in a Python virtual environment, the | ||
extension should detect it automatically and you should see a DVC icon like this | ||
in the status bar: | ||
|
||
**Note**: Use `Terminal: Create New Terminal` from the Command Palette to create | ||
a new | ||
[integrated terminal](https://code.visualstudio.com/docs/editor/integrated-terminal). | ||
<p align="center"> | ||
<img src="images/install-dvc-status-bar-detected.png" | ||
alt="DVC icon in the status bar" /> | ||
</p> | ||
|
||
If you see instead the crossed circle icon, use the | ||
[Setup Workspace](command:dvc.setupWorkspace) wizard to manually select the | ||
right environment: | ||
|
||
<p align="center"> | ||
<img src="images/install-dvc-setup-wizard.png" alt="DVC Setup Wizard" /> | ||
</p> |
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,14 +1,61 @@ | ||
# Plots | ||
|
||
The extension will display the following sections for selected experiments: | ||
Select one or more experiments to visualize them in the | ||
[`Plots View`](command:onCommand:dvc.showPlots). This is the extension's | ||
equivalent of the `dvc plots show` and `dvc plots diff` commands. | ||
|
||
- Data Series - JSON, YAML, CSV or TSV files visualized using Vega pre-defined | ||
or custom Vega-Lite templates. | ||
- Images - a table used to display image plots side by side. | ||
- Trends - linear plots based on data from the experiments table. | ||
💡 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): | ||
|
||
Use `DVC: Show Plots` from the Command Palette to open the view for a `DVC` | ||
repository. | ||
<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" /> | ||
</p> | ||
|
||
The view can be manipulated using the controls shown in the extension's view | ||
container. | ||
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: | ||
|
||
<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: | ||
|
||
<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: | ||
|
||
<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> |
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 |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Running Experiments | ||
|
||
You edit your code, edit or add more data, applying a new combination of | ||
hyperparameters- you have a new idea to try 💡! | ||
|
||
This extension provides many different ways to run a new experiment or queue it | ||
to be run later in the background or in parallel. This functionality wraps up | ||
the [`dvc exp run`](https://dvc.org/doc/command-reference/exp/run) command. | ||
|
||
The basic one is the set of buttons that are availble when the experiments table | ||
or parameters file are open: | ||
|
||
<p align="center"> | ||
<img src="images/run-experiments-table-buttons.png" | ||
alt="Run Experiments from the Table" /> | ||
<img src="images/run-experiments-params-buttons.png" | ||
alt="Run Experiments from a Parameters File" /> | ||
</p> | ||
|
||
After you are done modifying the project you can hit `Run`, `Queue`, and | ||
`Run all`. As you do this you should see new items in the experiments table. | ||
|
||
As usual, you can do the same and more with the context menus in the experiments | ||
table, in the experiments View in the side bar, or via the command palette. For | ||
example, we can take one of the existing experiments as a base, modify some | ||
parameters and run/queue a new iteration: | ||
|
||
<p align="center"> | ||
<img src="images/run-experiments-command-palette.png" | ||
alt="Run Experiments from the Command Palette" /> | ||
</p> |
Oops, something went wrong.