Skip to content

Commit ab92427

Browse files
shchekleinshcheklein
authored
Review and update the walkthrough (#1876)
1 parent 3a76bc8 commit ab92427

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+382
-133
lines changed

‎extension/package.json‎

Lines changed: 62 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1341,115 +1341,112 @@
13411341
"walkthroughs": [
13421342
{
13431343
"id": "welcome",
1344-
"title": "Get Started with DVC",
1345-
"description": "Your first steps to set up a DVC project with all the powerful tools and features that the DVC extension has to offer!",
1344+
"title": "Get Started",
1345+
"description": "Your first steps to build better models faster with experiment tracking and dataset versioning",
13461346
"steps": [
13471347
{
13481348
"id": "dvc.installDVC",
13491349
"title": "Install DVC",
1350-
"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",
1350+
"description": "This extension requires DVC to be installed.\n\n[Install DVC](https://dvc.org/doc/install)\n",
13511351
"media": {
13521352
"markdown": "resources/walkthrough/install-dvc.md"
13531353
},
13541354
"completionEvents": [
13551355
"onLink:https://dvc.org",
1356-
"onLink:https://dvc.org/doc/install"
1356+
"onLink:https://dvc.org/doc/install",
1357+
"onCommand:dvc.setupWorkspace"
13571358
]
13581359
},
13591360
{
1360-
"id": "dvc.setup",
1361-
"title": "Setup The Workspace",
1362-
"description": "Setup the workspace for the DVC extension.\n[Setup The Workspace](command:dvc.setupWorkspace)",
1361+
"id": "dvc.setupProject",
1362+
"title": "Setup a DVC Project",
1363+
"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",
13631364
"media": {
1364-
"markdown": "resources/walkthrough/setup-workspace.md"
1365+
"markdown": "resources/walkthrough/setup-project.md"
13651366
},
13661367
"completionEvents": [
1367-
"onCommand:dvc.setupWorkspace"
1368+
"onLink:https://github.com/iterative/example-get-started",
1369+
"onLink:https://github.com/iterative/vscode-dvc/tree/main/demo",
1370+
"onLink:https://dvc.org/doc/dvclive"
13681371
]
13691372
},
13701373
{
13711374
"id": "dvc.showCommands",
13721375
"title": "Available Commands",
1373-
"description": "View available commands.\n[View Commands](command:dvc.showCommands)",
1376+
"description": "See all available commands.\n[View Commands](command:dvc.showCommands)",
13741377
"media": {
13751378
"markdown": "resources/walkthrough/command-palette.md"
13761379
},
13771380
"completionEvents": [
13781381
"onCommand:dvc.showCommands"
1379-
],
1380-
"when": "dvc.commands.available && dvc.project.available"
1382+
]
13811383
},
13821384
{
1383-
"id": "dvc.showOutput",
1384-
"title": "Output Channel",
1385-
"description": "View the DVC output channel.\n[View Output](command:dvc.showOutput)",
1385+
"id": "dvc.viewContainer",
1386+
"title": "Control from the Side Bar",
1387+
"description": "Use rich views to quickly access, control, or overview your experiments and plots.\n[Show Views](command:workbench.view.extension.dvc-views)",
13861388
"media": {
1387-
"markdown": "resources/walkthrough/output-channel.md"
1389+
"markdown": "resources/walkthrough/view-container.md"
13881390
},
13891391
"completionEvents": [
1390-
"onCommand:dvc.showOutput"
1391-
],
1392-
"when": "dvc.commands.available && dvc.project.available"
1392+
"onCommand:workbench.view.extension.dvc-views"
1393+
]
13931394
},
13941395
{
1395-
"id": "dvc.scm",
1396-
"title": "Source Control Management",
1397-
"description": "Open the SCM view.\n[Show SCM](command:workbench.view.scm)",
1396+
"id": "dvc.experimentsTable",
1397+
"title": "Experiments Table",
1398+
"description": "Displays your experiments in a customizable table.\n[Show Table](command:dvc.showExperiments)",
13981399
"media": {
1399-
"markdown": "resources/walkthrough/source-control-management.md"
1400+
"markdown": "resources/walkthrough/experiments-table.md"
14001401
},
14011402
"completionEvents": [
1402-
"onCommand:workbench.view.scm"
1403-
],
1404-
"when": "dvc.commands.available && dvc.project.available"
1403+
"onCommand:dvc.showExperiments"
1404+
]
14051405
},
14061406
{
1407-
"id": "dvc.tracked",
1408-
"title": "Tracked Resources",
1409-
"description": "Open the DVC tracked view.\n[Show Tracked](command:dvc.views.trackedExplorerTree.focus)",
1407+
"id": "dvc.runExperiments",
1408+
"title": "Running Experiments",
1409+
"description": "Explore a few ways you can run or queue a new experiment.\n[Run an Experiment](command:dvc.modifyExperimentParamsAndRun)",
14101410
"media": {
1411-
"markdown": "resources/walkthrough/tracked-explorer.md"
1411+
"markdown": "resources/walkthrough/run-experiments.md"
14121412
},
14131413
"completionEvents": [
1414-
"onCommand:dvc.views.trackedExplorerTree.focus"
1415-
],
1416-
"when": "dvc.commands.available && dvc.project.available"
1414+
"onCommand:dvc.modifyExperimentParamsAndRun"
1415+
]
14171416
},
14181417
{
1419-
"id": "dvc.viewContainer",
1420-
"title": "DVC View Container",
1421-
"description": "Open the DVC view container.\n[Show Views](command:workbench.view.extension.dvc-views)",
1418+
"id": "dvc.plots",
1419+
"title": "Plots",
1420+
"description": "Visualize and compare multiple experiments with interactive customizable charts.\n[Show Plots](command:dvc.showPlots)",
14221421
"media": {
1423-
"markdown": "resources/walkthrough/view-container.md"
1422+
"markdown": "resources/walkthrough/plots.md"
14241423
},
14251424
"completionEvents": [
1426-
"onCommand:workbench.view.extension.dvc-views"
1427-
],
1428-
"when": "dvc.commands.available && dvc.project.available"
1425+
"onCommand:dvc.showPlots"
1426+
]
14291427
},
14301428
{
1431-
"id": "dvc.experimentsTable",
1432-
"title": "Experiments Table",
1433-
"description": "Open the experiments table.\n[Show Table](command:dvc.showExperiments)",
1429+
"id": "dvc.livePlots",
1430+
"title": "Live Plot Updates",
1431+
"description": "Run experiments and track how metrics and plots change in the same plots dashboard.\n[Show Plots](command:dvc.showPlots)",
14341432
"media": {
1435-
"markdown": "resources/walkthrough/experiments-table.md"
1433+
"markdown": "resources/walkthrough/live-plots.md"
14361434
},
14371435
"completionEvents": [
1438-
"onCommand:dvc.showExperiments"
1439-
],
1440-
"when": "dvc.commands.available && dvc.project.available"
1436+
"onCommand:dvc.showPlots"
1437+
]
14411438
},
14421439
{
1443-
"id": "dvc.plots",
1444-
"title": "Plots",
1445-
"description": "Open plots.\n[Show Plots](command:dvc.showPlots)",
1440+
"id": "dvc.tracked",
1441+
"title": "Data and Model Management",
1442+
"description": "Navigate and manage datasets, models, and any large files that are tracked by DVC.\n[Show Tracked](command:dvc.views.trackedExplorerTree.focus)",
14461443
"media": {
1447-
"markdown": "resources/walkthrough/plots.md"
1444+
"markdown": "resources/walkthrough/dvc-tracked-files.md"
14481445
},
14491446
"completionEvents": [
1450-
"onCommand:dvc.showPlots"
1451-
],
1452-
"when": "dvc.commands.available && dvc.project.available"
1447+
"onCommand:dvc.views.trackedExplorerTree.focus",
1448+
"onCommand:workbench.view.scm"
1449+
]
14531450
},
14541451
{
14551452
"id": "dvc.learnMore",
@@ -1461,6 +1458,17 @@
14611458
"completionEvents": [
14621459
"onLink:https://dvc.org/doc"
14631460
]
1461+
},
1462+
{
1463+
"id": "dvc.troubleshoot",
1464+
"title": "Troubleshoot & Support",
1465+
"description": "We are here to help! Ping us and provide the DVC output channel logs.\n[View Output](command:dvc.showOutput)",
1466+
"media": {
1467+
"markdown": "resources/walkthrough/troubleshoot.md"
1468+
},
1469+
"completionEvents": [
1470+
"onCommand:dvc.showOutput"
1471+
]
14641472
}
14651473
]
14661474
}

‎extension/resources/walkthrough/command-palette.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,10 @@ Which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
77
To see a list of available commands click [here](command:dvc.showCommands) or
88
type DVC into the Command Palette.
99

10-
For further information on `DVC` commands see the
10+
<p align="center">
11+
<img src="images/available-commands-command-palette.png"
12+
alt="DVC Command Palette" />
13+
</p>
14+
15+
For further information on specific `dvc` commands, see the
1116
[command-reference docs](https://dvc.org/doc/command-reference).

‎extension/resources/walkthrough/dvc-learn-more.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
- Browse the [user guide](https://dvc.org/doc/user-guide).
88

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

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

1414
- Explore our [free course](https://learn.iterative.ai/).

‎extension/resources/walkthrough/dvc-tracked-files.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Manage DVC-Tracked Files
2+
3+
> 💡 Read more about managing large files with Git and DVC
4+
> [here](https://dvc.org/doc/start/data-management). DVC provides a few commands
5+
> you can run along with `git` to version large files, directories, or ML model
6+
> using external storages like S3, SSH, Google Cloud, etc.
7+
8+
In the [DVC Tracked View](command:dvc.views.trackedExplorerTree.focus) you can
9+
see the files and directories that are managed by DVC (even if they are not yet
10+
downloaded) in a view similar to the regular `Explorer` view
11+
12+
<p align="center">
13+
<img src="images/dvc-tracked-explorer.png"
14+
alt="DVC-Tracked Explorer Integration" />
15+
</p>
16+
17+
You can `dvc pull` to download your data or `dvc push` to save it right from
18+
this view.
19+
20+
In the [Source Control View](command:workbench.view.scm) the statuses shown are
21+
designed to integrate with that of the built-in Git extension and give an "at a
22+
glance" state of the entire workspace. The extension will show if DVC-tracked
23+
datasets are changed and you need to _commit_ them.
24+
25+
<p align="center">
26+
<img src="images/dvc-tracked-scm.png" alt="DVC-Tracked SCM Integration" />
27+
</p>
28+
29+
From this view you can trigger data management commands like `dvc checkout`,
30+
`dvc commit`, as well as `dvc pull` and `dvc push`.

‎extension/resources/walkthrough/experiments-table.md‎

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,32 @@
11
# Experiments Table
22

3-
The extension's equivalent of `dvc exp show`.
3+
> ❗ DVC should be installed and DVC project available in the workspace for this
4+
> and the next steps to work properly. Please refer to first two steps of this
5+
> guide.
46
5-
Use `DVC: Show Experiments` from the Command Palette to open up the experiments
6-
table for a `DVC` repository.
7+
As you change code, parameters, data and run new experiments this table will
8+
keep all the details about your iterations. It can be manipulated and configured
9+
using the [DVC side panel](command:workbench.view.extension.dvc-views). This is
10+
the extension's equivalent of the `dvc exp show` command.
711

8-
The view can be manipulated using the controls shown in the extension's view
9-
container.
12+
<p align="center">
13+
<img src="images/experiments-table.png" alt="Experiment Table" />
14+
</p>
15+
16+
Use `DVC: Show Experiments` from the
17+
[Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Experiments%22)
18+
to open up the experiments table or access it, using the Columns view:
19+
20+
<p align="center">
21+
<img src="images/experiments-table-from-side-bar.png"
22+
alt="Columns View" />
23+
</p>
24+
25+
The table provides context menus to access basic operation on experiments and
26+
table headers. You can edit parameters, sort or filter, run new experiments and
27+
more:
28+
29+
<p align="center">
30+
<img src="images/experiments-table-context-menus.png"
31+
alt="Experiments Table: Context Menus" />
32+
</p>

‎extension/resources/walkthrough/images/available-commands-command-palette.png‎

39.4 KB
Loading

‎extension/resources/walkthrough/images/dvc-tracked-explorer.png‎

29.3 KB
Loading

‎extension/resources/walkthrough/images/dvc-tracked-scm.png‎

25.1 KB
Loading

‎extension/resources/walkthrough/images/experiments-table-context-menus.png‎

67.1 KB
Loading

‎extension/resources/walkthrough/images/experiments-table-from-side-bar.png‎

31.5 KB
Loading

0 commit comments

Comments
 (0)