diff --git a/extension/package.json b/extension/package.json index 71349d1502..64f0b1a8df 100644 --- a/extension/package.json +++ b/extension/package.json @@ -1341,115 +1341,112 @@ "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.\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 a DVC Project", + "description": "Try an example DVC project or setup a new quickly, and 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.livePlots", + "title": "Live Plot Updates", + "description": "Run experiments and track how metrics and plots change in the same plots dashboard.\n[Show Plots](command:dvc.showPlots)", "media": { - "markdown": "resources/walkthrough/experiments-table.md" + "markdown": "resources/walkthrough/live-plots.md" }, "completionEvents": [ - "onCommand:dvc.showExperiments" - ], - "when": "dvc.commands.available && dvc.project.available" + "onCommand:dvc.showPlots" + ] }, { - "id": "dvc.plots", - "title": "Plots", - "description": "Open plots.\n[Show Plots](command:dvc.showPlots)", + "id": "dvc.tracked", + "title": "Data and Model Management", + "description": "Navigate and manage datasets, models, and any large files that are tracked by DVC.\n[Show Tracked](command:dvc.views.trackedExplorerTree.focus)", "media": { - "markdown": "resources/walkthrough/plots.md" + "markdown": "resources/walkthrough/dvc-tracked-files.md" }, "completionEvents": [ - "onCommand:dvc.showPlots" - ], - "when": "dvc.commands.available && dvc.project.available" + "onCommand:dvc.views.trackedExplorerTree.focus", + "onCommand:workbench.view.scm" + ] }, { "id": "dvc.learnMore", @@ -1461,6 +1458,17 @@ "completionEvents": [ "onLink:https://dvc.org/doc" ] + }, + { + "id": "dvc.troubleshoot", + "title": "Troubleshoot & Support", + "description": "We are here to help! Ping us and provide the DVC output channel logs.\n[View Output](command:dvc.showOutput)", + "media": { + "markdown": "resources/walkthrough/troubleshoot.md" + }, + "completionEvents": [ + "onCommand:dvc.showOutput" + ] } ] } diff --git a/extension/resources/walkthrough/command-palette.md b/extension/resources/walkthrough/command-palette.md index d8b030accb..f739f9ecfb 100644 --- a/extension/resources/walkthrough/command-palette.md +++ b/extension/resources/walkthrough/command-palette.md @@ -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. -For further information on `DVC` commands see the +

+ DVC Command Palette +

+ +For further information on specific `dvc` commands, see the [command-reference docs](https://dvc.org/doc/command-reference). diff --git a/extension/resources/walkthrough/dvc-learn-more.md b/extension/resources/walkthrough/dvc-learn-more.md index c18db9bb20..4f3d177761 100644 --- a/extension/resources/walkthrough/dvc-learn-more.md +++ b/extension/resources/walkthrough/dvc-learn-more.md @@ -6,9 +6,9 @@ - Browse the [user guide](https://dvc.org/doc/user-guide). -- View all [available commands](https://dvc.org/doc/command-reference). +- View all [available `dvc` 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/). diff --git a/extension/resources/walkthrough/dvc-tracked-files.md b/extension/resources/walkthrough/dvc-tracked-files.md new file mode 100644 index 0000000000..2760c69fb3 --- /dev/null +++ b/extension/resources/walkthrough/dvc-tracked-files.md @@ -0,0 +1,30 @@ +# Manage DVC-Tracked Files + +> ๐Ÿ’ก Read more about managing large files with Git and DVC +> [here](https://dvc.org/doc/start/data-management). DVC provides a few commands +> you can run along with `git` to version large files, directories, or ML model +> using external storages like S3, SSH, Google Cloud, etc. + +In the [DVC Tracked View](command:dvc.views.trackedExplorerTree.focus) you can +see the files and directories that are managed by DVC (even if they are not yet +downloaded) in a view similar to the regular `Explorer` view + +

+ DVC-Tracked Explorer Integration +

+ +You can `dvc pull` to download your data or `dvc push` to save it right from +this view. + +In the [Source Control View](command:workbench.view.scm) the statuses shown are +designed to integrate with that of the built-in Git extension and give an "at a +glance" state of the entire workspace. The extension will show if DVC-tracked +datasets are changed and you need to _commit_ them. + +

+ DVC-Tracked SCM Integration +

+ +From this view you can trigger data management commands like `dvc checkout`, +`dvc commit`, as well as `dvc pull` and `dvc push`. diff --git a/extension/resources/walkthrough/experiments-table.md b/extension/resources/walkthrough/experiments-table.md index 68c20416ff..3551bc2284 100644 --- a/extension/resources/walkthrough/experiments-table.md +++ b/extension/resources/walkthrough/experiments-table.md @@ -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. +

+ Experiment Table +

+ +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: + +

+ Columns View +

+ +The table provides context menus to access basic operation on experiments and +table headers. You can edit parameters, sort or filter, run new experiments and +more: + +

+ Experiments Table: Context Menus +

diff --git a/extension/resources/walkthrough/images/available-commands-command-palette.png b/extension/resources/walkthrough/images/available-commands-command-palette.png new file mode 100644 index 0000000000..15b58f5bac Binary files /dev/null and b/extension/resources/walkthrough/images/available-commands-command-palette.png differ diff --git a/extension/resources/walkthrough/images/dvc-tracked-explorer.png b/extension/resources/walkthrough/images/dvc-tracked-explorer.png new file mode 100644 index 0000000000..3150683f61 Binary files /dev/null and b/extension/resources/walkthrough/images/dvc-tracked-explorer.png differ diff --git a/extension/resources/walkthrough/images/dvc-tracked-scm.png b/extension/resources/walkthrough/images/dvc-tracked-scm.png new file mode 100644 index 0000000000..1e8a5e151c Binary files /dev/null and b/extension/resources/walkthrough/images/dvc-tracked-scm.png differ diff --git a/extension/resources/walkthrough/images/experiments-table-context-menus.png b/extension/resources/walkthrough/images/experiments-table-context-menus.png new file mode 100644 index 0000000000..b7221e9b0b Binary files /dev/null and b/extension/resources/walkthrough/images/experiments-table-context-menus.png differ diff --git a/extension/resources/walkthrough/images/experiments-table-from-side-bar.png b/extension/resources/walkthrough/images/experiments-table-from-side-bar.png new file mode 100644 index 0000000000..def9d0a3e2 Binary files /dev/null and b/extension/resources/walkthrough/images/experiments-table-from-side-bar.png differ diff --git a/extension/resources/walkthrough/images/experiments-table.png b/extension/resources/walkthrough/images/experiments-table.png new file mode 100644 index 0000000000..8cf831b36a Binary files /dev/null and b/extension/resources/walkthrough/images/experiments-table.png differ diff --git a/extension/resources/walkthrough/images/install-dvc-setup-wizard.png b/extension/resources/walkthrough/images/install-dvc-setup-wizard.png new file mode 100644 index 0000000000..c4c0267c7b Binary files /dev/null and b/extension/resources/walkthrough/images/install-dvc-setup-wizard.png differ diff --git a/extension/resources/walkthrough/images/install-dvc-status-bar-detected.png b/extension/resources/walkthrough/images/install-dvc-status-bar-detected.png new file mode 100644 index 0000000000..3b7d85a305 Binary files /dev/null and b/extension/resources/walkthrough/images/install-dvc-status-bar-detected.png differ diff --git a/extension/resources/walkthrough/images/live-plots-updates.gif b/extension/resources/walkthrough/images/live-plots-updates.gif new file mode 100644 index 0000000000..192d3fb4c0 Binary files /dev/null and b/extension/resources/walkthrough/images/live-plots-updates.gif differ diff --git a/extension/resources/walkthrough/images/plots-data-series.png b/extension/resources/walkthrough/images/plots-data-series.png new file mode 100644 index 0000000000..599888c033 Binary files /dev/null and b/extension/resources/walkthrough/images/plots-data-series.png differ diff --git a/extension/resources/walkthrough/images/plots-dump-image.png b/extension/resources/walkthrough/images/plots-dump-image.png new file mode 100644 index 0000000000..0d86389fe5 Binary files /dev/null and b/extension/resources/walkthrough/images/plots-dump-image.png differ diff --git a/extension/resources/walkthrough/images/plots-dump-with-dvclive.png b/extension/resources/walkthrough/images/plots-dump-with-dvclive.png new file mode 100644 index 0000000000..f67d60d3b3 Binary files /dev/null and b/extension/resources/walkthrough/images/plots-dump-with-dvclive.png differ diff --git a/extension/resources/walkthrough/images/plots-dump-with-open-file.png b/extension/resources/walkthrough/images/plots-dump-with-open-file.png new file mode 100644 index 0000000000..9ed0ce3e3d Binary files /dev/null and b/extension/resources/walkthrough/images/plots-dump-with-open-file.png differ diff --git a/extension/resources/walkthrough/images/plots-experiments-view-icon.png b/extension/resources/walkthrough/images/plots-experiments-view-icon.png new file mode 100644 index 0000000000..2920300f3e Binary files /dev/null and b/extension/resources/walkthrough/images/plots-experiments-view-icon.png differ diff --git a/extension/resources/walkthrough/images/plots-images.png b/extension/resources/walkthrough/images/plots-images.png new file mode 100644 index 0000000000..d3f790bbbb Binary files /dev/null and b/extension/resources/walkthrough/images/plots-images.png differ diff --git a/extension/resources/walkthrough/images/plots-plots-view-icon.png b/extension/resources/walkthrough/images/plots-plots-view-icon.png new file mode 100644 index 0000000000..849e190784 Binary files /dev/null and b/extension/resources/walkthrough/images/plots-plots-view-icon.png differ diff --git a/extension/resources/walkthrough/images/plots-trends.png b/extension/resources/walkthrough/images/plots-trends.png new file mode 100644 index 0000000000..5e14382a56 Binary files /dev/null and b/extension/resources/walkthrough/images/plots-trends.png differ diff --git a/extension/resources/walkthrough/images/run-experiments-command-palette.png b/extension/resources/walkthrough/images/run-experiments-command-palette.png new file mode 100644 index 0000000000..c50d0b4f4a Binary files /dev/null and b/extension/resources/walkthrough/images/run-experiments-command-palette.png differ diff --git a/extension/resources/walkthrough/images/run-experiments-params-buttons.png b/extension/resources/walkthrough/images/run-experiments-params-buttons.png new file mode 100644 index 0000000000..bfb71c7092 Binary files /dev/null and b/extension/resources/walkthrough/images/run-experiments-params-buttons.png differ diff --git a/extension/resources/walkthrough/images/run-experiments-table-buttons.png b/extension/resources/walkthrough/images/run-experiments-table-buttons.png new file mode 100644 index 0000000000..e93c796192 Binary files /dev/null and b/extension/resources/walkthrough/images/run-experiments-table-buttons.png differ diff --git a/extension/resources/walkthrough/images/setup-project-dump-metrics.png b/extension/resources/walkthrough/images/setup-project-dump-metrics.png new file mode 100644 index 0000000000..9df18e4116 Binary files /dev/null and b/extension/resources/walkthrough/images/setup-project-dump-metrics.png differ diff --git a/extension/resources/walkthrough/images/setup-project-dvc-yaml-example.png b/extension/resources/walkthrough/images/setup-project-dvc-yaml-example.png new file mode 100644 index 0000000000..93f17c792c Binary files /dev/null and b/extension/resources/walkthrough/images/setup-project-dvc-yaml-example.png differ diff --git a/extension/resources/walkthrough/images/setup-project-dvclive-metrics.png b/extension/resources/walkthrough/images/setup-project-dvclive-metrics.png new file mode 100644 index 0000000000..e2de3834e9 Binary files /dev/null and b/extension/resources/walkthrough/images/setup-project-dvclive-metrics.png differ diff --git a/extension/resources/walkthrough/images/view-container-columns.png b/extension/resources/walkthrough/images/view-container-columns.png new file mode 100644 index 0000000000..d404f4ffef Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-columns.png differ diff --git a/extension/resources/walkthrough/images/view-container-experiments.png b/extension/resources/walkthrough/images/view-container-experiments.png new file mode 100644 index 0000000000..344cdca676 Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-experiments.png differ diff --git a/extension/resources/walkthrough/images/view-container-filter.png b/extension/resources/walkthrough/images/view-container-filter.png new file mode 100644 index 0000000000..4d4e617c32 Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-filter.png differ diff --git a/extension/resources/walkthrough/images/view-container-plots.png b/extension/resources/walkthrough/images/view-container-plots.png new file mode 100644 index 0000000000..fbb038a5c0 Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-plots.png differ diff --git a/extension/resources/walkthrough/images/view-container-show.png b/extension/resources/walkthrough/images/view-container-show.png new file mode 100644 index 0000000000..9a71064210 Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-show.png differ diff --git a/extension/resources/walkthrough/images/view-container-sort.png b/extension/resources/walkthrough/images/view-container-sort.png new file mode 100644 index 0000000000..493356a65c Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-sort.png differ diff --git a/extension/resources/walkthrough/images/view-container-support.png b/extension/resources/walkthrough/images/view-container-support.png new file mode 100644 index 0000000000..e6535e2a39 Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-support.png differ diff --git a/extension/resources/walkthrough/images/view-container-welcome.png b/extension/resources/walkthrough/images/view-container-welcome.png new file mode 100644 index 0000000000..c035267640 Binary files /dev/null and b/extension/resources/walkthrough/images/view-container-welcome.png differ diff --git a/extension/resources/walkthrough/install-dvc.md b/extension/resources/walkthrough/install-dvc.md index aca0c65a6c..1a2caff988 100644 --- a/extension/resources/walkthrough/install-dvc.md +++ b/extension/resources/walkthrough/install-dvc.md @@ -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 would attempt to detect it automatically. If successful, you'll 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). +

+ DVC icon in the status bar +

+ +If you see instead the crossed circle icon, use the +[Setup Workspace](command:dvc.setupWorkspace) wizard to manually select the +right environment: + +

+ DVC Setup Wizard +

diff --git a/extension/resources/walkthrough/live-plots.md b/extension/resources/walkthrough/live-plots.md new file mode 100644 index 0000000000..e7a12f39c3 --- /dev/null +++ b/extension/resources/walkthrough/live-plots.md @@ -0,0 +1,40 @@ +# Monitor your Experiments + +As you run your experiments you can use the same +[`Plots Dashboard`](command:dvc.showPlots) to watch for the metrics and plot +updates: + +

+ Live Metric Updates +

+ +This functionality comes baked in when you update your plots files in your +training code. For example like this, using the +[DVCLive](https://dvc.org/doc/dvclive) library that also +[supports](https://dvc.org/doc/dvclive/ml-frameworks) many popular ML frameworks +to automate this process: + +```python +from dvclive import Live + +live = Live("training_metrics") + +for epoch in range(NUM_EPOCHS): + train_model(...) + metrics = evaluate_model(...) + + for metric_name, value in metrics.items(): + live.log(metric_name, value) + + live.next_step() +``` + +`DVCLive` is _optional_, and you can just append or modify plot files using any +language and any tool. + +๐Ÿ’ก `Trends` section of the plots dashboard is being updated automatically based +on the data in the table. You don't even have to manage or write any special +plot files, but you need to enable +[checkpoints](https://dvc.org/doc/user-guide/experiment-management/checkpoints) +in the project. diff --git a/extension/resources/walkthrough/output-channel.md b/extension/resources/walkthrough/output-channel.md deleted file mode 100644 index 78f66f61d8..0000000000 --- a/extension/resources/walkthrough/output-channel.md +++ /dev/null @@ -1,14 +0,0 @@ -# Output Channel - -All `DVC` CLI commands generate two entries in this extension's dedicated output -channel. - -The first shows the command has started. The second is to signify that it has -completed. - -The completion entry will show: - -- The outcome of the command (COMPLETED / FAILED). -- Any non-zero exit codes. -- The length of time that each command took to run (ms). -- Any error message provided by the CLI. diff --git a/extension/resources/walkthrough/plots.md b/extension/resources/walkthrough/plots.md index 6f1bb43690..7677b5c519 100644 --- a/extension/resources/walkthrough/plots.md +++ b/extension/resources/walkthrough/plots.md @@ -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 Dashboard`](command: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. +

+ Code to Dump a JSON Plot File + Code to Dump a JSON Plot File with DVCLive + Code to Dump an Image Plot File +

-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: + +

+ Plots: Data Series +

+ +`Data Series`. JSON, YAML, CSV or TSV files visualized using the predefined +(e.g. confusion matrix, linear) or custom (Vega-lite) templates. + +

+ Plots: Images +

+ +`Images`. Any image file (e,g `.png`) can be visualized as a plot. They will be +rendered side by side in the table. + +

+ Plots: Trends +

+ +`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: + +

+ Plots View + Experiments View +

diff --git a/extension/resources/walkthrough/run-experiments.md b/extension/resources/walkthrough/run-experiments.md new file mode 100644 index 0000000000..704e165c7a --- /dev/null +++ b/extension/resources/walkthrough/run-experiments.md @@ -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 one +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 available when the experiments +table or parameters file are open: + +

+ Run Experiments from the Table + Run Experiments from a Parameters File +

+ +After you are done modifying the project you can choose `Run`, `Queue`, or +`Run all`. As you do this you should see new items in the experiments table. + +As usual, you can do the same and more from 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: + +

+ Run Experiments from the Command Palette +

diff --git a/extension/resources/walkthrough/setup-project.md b/extension/resources/walkthrough/setup-project.md new file mode 100644 index 0000000000..6e2aa1e31c --- /dev/null +++ b/extension/resources/walkthrough/setup-project.md @@ -0,0 +1,38 @@ +# Setup a DVC Project + +> Skip this step if you already have a DVC project with metrics, plots, and +> params. + +๐Ÿ’ก Check out the +[DVC Get Started](https://github.com/iterative/example-get-started) or +[Extension Demo](https://github.com/iterative/vscode-dvc/tree/main/demo) +projects to quickly try the extension. + +To quickly setup a new DVC project run +[`dvc exp init -i`](https://dvc.org/doc/command-reference/exp/init#example-interactive-mode) +in a [Terminal](command:workbench.action.terminal.new). It will generate a +config file `dvc.yaml` that describes the project, and will look something like +this: + +

+ dvc.yaml example +

+ +๐Ÿ’ก Names, values in this file are project dependent and can be customized. + +DVC and this extension read experiments data from these files (e.g +`metrics.json`, `params.yaml`, etc). Your code needs to write and read to them +(the example below is Python, but it can be done in any language): + +

+ Dump JSON metrics file +

+ +Alternatively, use the [`DVCLive`](https://dvc.org/doc/dvclive) Python library, +which can read and write a lot of different common metrics and plots: + +

+ DVCLive: dump metrics +

diff --git a/extension/resources/walkthrough/setup-workspace.md b/extension/resources/walkthrough/setup-workspace.md deleted file mode 100644 index ddcf02d175..0000000000 --- a/extension/resources/walkthrough/setup-workspace.md +++ /dev/null @@ -1,15 +0,0 @@ -# Integrating with the CLI - -This extension can support a global or virtual environment installation of -`DVC`. - -You will need a `DVC` project opened within the workspace to see all of the -extension's available features. See the `Explore More Resources` step for -details on creating a `DVC` project. - -Use the workspace setup wizard to set the required config options. - -Once completed, the rest of the walkthrough will appear. - -The wizard can be accessed by clicking [here](command:dvc.setupWorkspace) or use -`DVC: Setup The Workspace` from the Command Palette. diff --git a/extension/resources/walkthrough/source-control-management.md b/extension/resources/walkthrough/source-control-management.md deleted file mode 100644 index 19372dc6e7..0000000000 --- a/extension/resources/walkthrough/source-control-management.md +++ /dev/null @@ -1,8 +0,0 @@ -# Source Control Management - -Resources tracked by `DVC` can be managed through the SCM view. - -The statuses shown are designed to integrate with that of the built-in `git` -extension and give an "at a glance" state of the entire workspace. - -You can `checkout`, `commit`, `add`, `push` & `pull` from this view. diff --git a/extension/resources/walkthrough/tracked-explorer.md b/extension/resources/walkthrough/tracked-explorer.md deleted file mode 100644 index 81f432f632..0000000000 --- a/extension/resources/walkthrough/tracked-explorer.md +++ /dev/null @@ -1,9 +0,0 @@ -# Tracked Resources - -Resources tracked by `DVC` can be viewed and managed via the tracked explorer -view. - -This view is designed to give you more situational awareness of the project. - -From here you can perform file actions, `push` & `pull` specific resources and -manage the data within tracked datasets. diff --git a/extension/resources/walkthrough/troubleshoot.md b/extension/resources/walkthrough/troubleshoot.md new file mode 100644 index 0000000000..f4636060c0 --- /dev/null +++ b/extension/resources/walkthrough/troubleshoot.md @@ -0,0 +1,20 @@ +# Support + +All `DVC` CLI commands generate two entries in this extension's dedicated output +channel. The first shows the command has started. The second is to signify that +it has completed. + +The completion entry will show: + +- The outcome of the command (COMPLETED / FAILED). +- Any non-zero exit codes. +- The length of time that each command took to run (ms). +- Any error message provided by the CLI. + +Don't hesitate to ping us in the [Discord](https://discord.gg/BGCjJHvDHt) +channel or open an issue on +[GitHub](https://github.com/iterative/vscode-dvc/issues). We are happy to help +๐Ÿค—. + +Please share with us the output channel logs, the extension version, and the DVC +version (the `dvc version` output). diff --git a/extension/resources/walkthrough/view-container.md b/extension/resources/walkthrough/view-container.md index 89e6a1b0a7..a97ac5f4f7 100644 --- a/extension/resources/walkthrough/view-container.md +++ b/extension/resources/walkthrough/view-container.md @@ -1,14 +1,56 @@ -# DVC View Container - -The view container provides supplementary information and control over the -experiments and plots in the workspace. +# DVC Views Click on the `DVC` icon in the [Activity Bar](https://code.visualstudio.com/docs/getstarted/userinterface) to -access the container or use +access the views or use [View: Show DVC](command:workbench.view.extension.dvc-views) from the Command Palette. -A welcome view showing some getting started instructions will appear in the -container when the CLI is not accessible or if there is not a `DVC` project -available in the workspace. +โ— Welcome and support views showing some getting started instructions will +appear in the container when `DVC` is not installed or if there is not a `DVC` +project available in the workspace: + +

+ Welcome View + Support View +

+ +> ๐Ÿค— If something goes wrong, you have a feature request, or you need some help- +> don't hesitate to ping us in the [Discord](https://discord.gg/BGCjJHvDHt) +> channel or open an issue on +> [GitHub](https://github.com/iterative/vscode-dvc/issues). We are happy to +> help. + +If DVC and the extension are initialized, side bar will exposes multiple views: + +

+ Show DVC Container View + Columns View +

+

+ Experiments View + Sort By View +

+

+ Filter By View + Plots View +

+ +- `COLUMNS`. Used to fine-tune the experiments table to focus on the most + important metrics, parameters, and data signals and to view all available + columns. +- `EXPERIMENTS`. Exposes the list of experiments, their checkpoints and common + actions. +- `SORT BY`. Used to display and configure how the experiments table is sorted. +- `FILTER BY`. Used to view, add, or remove metrics and parameters filters. + These will hide specific experiments in the table. +- `PLOTS`. Used to fine-tune the plots dashboard, e.g. by toggling plots + visibility.