Skip to content

Commit

Permalink
review and update the walkthrough
Browse files Browse the repository at this point in the history
  • Loading branch information
shcheklein committed Jun 14, 2022
1 parent d22127e commit df9fdb1
Show file tree
Hide file tree
Showing 39 changed files with 290 additions and 100 deletions.
115 changes: 61 additions & 54 deletions extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -1341,115 +1341,111 @@
"walkthroughs": [
{
"id": "welcome",
"title": "Get Started with DVC",
"description": "Your first steps to set up a DVC project with all the powerful tools and features that the DVC extension has to offer!",
"title": "Get Started",
"description": "Your first steps to build better models faster with experiment tracking and dataset versioning",
"steps": [
{
"id": "dvc.installDVC",
"title": "Install DVC",
"description": "The DVC extension requires DVC to be installed. To install follow the guide shown on [dvc.org](https://dvc.org).\n\n[Install DVC](https://dvc.org/doc/install)\n",
"description": "This extension requires DVC to be installed. To install follow the guide shown on [dvc.org](https://dvc.org).\n\n[Install DVC](https://dvc.org/doc/install)\n",
"media": {
"markdown": "resources/walkthrough/install-dvc.md"
},
"completionEvents": [
"onLink:https://dvc.org",
"onLink:https://dvc.org/doc/install"
"onLink:https://dvc.org/doc/install",
"onCommand:dvc.setupWorkspace"
]
},
{
"id": "dvc.setup",
"title": "Setup The Workspace",
"description": "Setup the workspace for the DVC extension.\n[Setup The Workspace](command:dvc.setupWorkspace)",
"id": "dvc.setupProject",
"title": "Setup Project",
"description": "Try an example project and setup DVC to start tracking datasets, models, metrics, and plots\n\n[Example Project](https://github.com/iterative/example-get-started)\n",
"media": {
"markdown": "resources/walkthrough/setup-workspace.md"
"markdown": "resources/walkthrough/setup-project.md"
},
"completionEvents": [
"onCommand:dvc.setupWorkspace"
"onLink:https://github.com/iterative/example-get-started",
"onLink:https://github.com/iterative/vscode-dvc/tree/main/demo",
"onLink:https://dvc.org/doc/dvclive"
]
},
{
"id": "dvc.showCommands",
"title": "Available Commands",
"description": "View available commands.\n[View Commands](command:dvc.showCommands)",
"description": "See all available commands.\n[View Commands](command:dvc.showCommands)",
"media": {
"markdown": "resources/walkthrough/command-palette.md"
},
"completionEvents": [
"onCommand:dvc.showCommands"
],
"when": "dvc.commands.available && dvc.project.available"
]
},
{
"id": "dvc.showOutput",
"title": "Output Channel",
"description": "View the DVC output channel.\n[View Output](command:dvc.showOutput)",
"id": "dvc.viewContainer",
"title": "Control from the Side Bar",
"description": "Use rich views to quickly access, control, or overview your experiments and plots.\n[Show Views](command:workbench.view.extension.dvc-views)",
"media": {
"markdown": "resources/walkthrough/output-channel.md"
"markdown": "resources/walkthrough/view-container.md"
},
"completionEvents": [
"onCommand:dvc.showOutput"
],
"when": "dvc.commands.available && dvc.project.available"
"onCommand:workbench.view.extension.dvc-views"
]
},
{
"id": "dvc.scm",
"title": "Source Control Management",
"description": "Open the SCM view.\n[Show SCM](command:workbench.view.scm)",
"id": "dvc.experimentsTable",
"title": "Experiments Table",
"description": "Displays your experiments in a customizable table.\n[Show Table](command:dvc.showExperiments)",
"media": {
"markdown": "resources/walkthrough/source-control-management.md"
"markdown": "resources/walkthrough/experiments-table.md"
},
"completionEvents": [
"onCommand:workbench.view.scm"
],
"when": "dvc.commands.available && dvc.project.available"
"onCommand:dvc.showExperiments"
]
},
{
"id": "dvc.tracked",
"title": "Tracked Resources",
"description": "Open the DVC tracked view.\n[Show Tracked](command:dvc.views.trackedExplorerTree.focus)",
"id": "dvc.runExperiments",
"title": "Running Experiments",
"description": "Explore a few ways you can run or queue a new experiment.\n[Run an Experiment](command:dvc.modifyExperimentParamsAndRun)",
"media": {
"markdown": "resources/walkthrough/tracked-explorer.md"
"markdown": "resources/walkthrough/run-experiments.md"
},
"completionEvents": [
"onCommand:dvc.views.trackedExplorerTree.focus"
],
"when": "dvc.commands.available && dvc.project.available"
"onCommand:dvc.modifyExperimentParamsAndRun"
]
},
{
"id": "dvc.viewContainer",
"title": "DVC View Container",
"description": "Open the DVC view container.\n[Show Views](command:workbench.view.extension.dvc-views)",
"id": "dvc.plots",
"title": "Plots",
"description": "Visualize and compare multiple experiments with interactive customizable charts.\n[Show Plots](command:dvc.showPlots)",
"media": {
"markdown": "resources/walkthrough/view-container.md"
"markdown": "resources/walkthrough/plots.md"
},
"completionEvents": [
"onCommand:workbench.view.extension.dvc-views"
],
"when": "dvc.commands.available && dvc.project.available"
"onCommand:dvc.showPlots"
]
},
{
"id": "dvc.experimentsTable",
"title": "Experiments Table",
"description": "Open the experiments table.\n[Show Table](command:dvc.showExperiments)",
"id": "dvc.tracked",
"title": "Tracked Resources",
"description": "Open the DVC tracked view.\n[Show Tracked](command:dvc.views.trackedExplorerTree.focus)",
"media": {
"markdown": "resources/walkthrough/experiments-table.md"
"markdown": "resources/walkthrough/tracked-explorer.md"
},
"completionEvents": [
"onCommand:dvc.showExperiments"
],
"when": "dvc.commands.available && dvc.project.available"
"onCommand:dvc.views.trackedExplorerTree.focus"
]
},
{
"id": "dvc.plots",
"title": "Plots",
"description": "Open plots.\n[Show Plots](command:dvc.showPlots)",
"id": "dvc.scm",
"title": "Source Control Management",
"description": "Open the SCM view.\n[Show SCM](command:workbench.view.scm)",
"media": {
"markdown": "resources/walkthrough/plots.md"
"markdown": "resources/walkthrough/source-control-management.md"
},
"completionEvents": [
"onCommand:dvc.showPlots"
],
"when": "dvc.commands.available && dvc.project.available"
"onCommand:workbench.view.scm"
]
},
{
"id": "dvc.learnMore",
Expand All @@ -1461,6 +1457,17 @@
"completionEvents": [
"onLink:https://dvc.org/doc"
]
},
{
"id": "dvc.troubleshoot",
"title": "Troubleshoot",
"description": "View the DVC output channel.\n[View Output](command:dvc.showOutput)",
"media": {
"markdown": "resources/walkthrough/troubleshoot.md"
},
"completionEvents": [
"onCommand:dvc.showOutput"
]
}
]
}
Expand Down
5 changes: 5 additions & 0 deletions extension/resources/walkthrough/command-palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,10 @@ Which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
To see a list of available commands click [here](command:dvc.showCommands) or
type DVC into the Command Palette.

<p align="center">
<img src="images/available-commands-command-palette.png"
alt="DVC Command Palette" />
</p>

For further information on `DVC` commands see the
[command-reference docs](https://dvc.org/doc/command-reference).
2 changes: 1 addition & 1 deletion extension/resources/walkthrough/dvc-learn-more.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

- View all [available commands](https://dvc.org/doc/command-reference).

- Check out the [DVC github repository](https://github.com/iterative/dvc) or an
- Check out the [DVC GitHub repository](https://github.com/iterative/dvc) or an
[example project](https://github.com/iterative/example-get-started).

- Explore our [free course](https://learn.iterative.ai/).
Expand Down
33 changes: 28 additions & 5 deletions extension/resources/walkthrough/experiments-table.md
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>
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.
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.
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.
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.
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.
27 changes: 19 additions & 8 deletions extension/resources/walkthrough/install-dvc.md
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>
65 changes: 56 additions & 9 deletions extension/resources/walkthrough/plots.md
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>
31 changes: 31 additions & 0 deletions extension/resources/walkthrough/run-experiments.md
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>
Loading

0 comments on commit df9fdb1

Please sign in to comment.