Skip to content
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

Fix "Get Started" walkthrough typos and outdated mentions #4118

Merged
merged 3 commits into from
Jun 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -1469,7 +1469,7 @@
},
{
"view": "dvc.views.welcome",
"contents": "The extension is currently unable to initialize.\n[Show Setup](command:dvc.showDvcSetup)\nNew to the extension? Watch a [demo of the extension](https://youtu.be/E26IaD7bNXg?t=1177) in action or quickly try the extension yourself with our [example project](https://github.com/iterative/example-dvc-experiments.git). Dive deeper into DVC at [dvc.org](https://dvc.org/).",
"contents": "The extension is currently unable to initialize.\n[Show Setup](command:dvc.showDvcSetup)\nNew to the extension? Watch a [demo of the extension](https://youtu.be/E26IaD7bNXg?t=1177) in action or quickly try the extension yourself with our [example project](https://github.com/iterative/example-get-started-experiments). Dive deeper into DVC at [dvc.org](https://dvc.org/).",
"when": "true"
},
{
Expand Down
6 changes: 3 additions & 3 deletions extension/resources/walkthrough/command-palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

> ℹ️ The extension's features cannot be accessed until DVC is installed and a
> DVC project is available in the workspace. Please refer to the
> [setup page](command:dvc.dvc.showDvcSetup) if you have not setup DVC yet.
> [setup page](command:dvc.showDvcSetup) if you have not setup DVC yet.

This extension makes extensive use of the
[Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
Which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
[Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)
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.
Expand Down
2 changes: 1 addition & 1 deletion extension/resources/walkthrough/experiments-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ 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.

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

Expand Down
2 changes: 1 addition & 1 deletion extension/resources/walkthrough/live-plots.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ updates:
</p>

This functionality comes baked in when you update your plots files in your
training code. For example like this, using the
training code. For examples like this, use 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:
Expand Down
4 changes: 2 additions & 2 deletions extension/resources/walkthrough/more-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

- Browse all available [`dvc` commands] and [Python API] functions.

- Take our [free course] and become a certified in Iterative.ai tools!
- Take our [free course] and become certified in Iterative.ai tools!

- Play with a ready-to-use [example project].

Expand All @@ -30,7 +30,7 @@
[python api]: https://dvc.org/doc/api-reference
[free course]: https://learn.iterative.ai/
[contribute]: https://dvc.org/doc/contributing/core
[example project]: https://github.com/iterative/example-get-started
[example project]: https://github.com/iterative/example-get-started-experiments
[blog]: https://dvc.org/blog
[community]: https://dvc.org/community
[dvc github repository]: https://github.com/iterative/dvc
Expand Down
7 changes: 4 additions & 3 deletions extension/resources/walkthrough/plots.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,16 +74,17 @@ rendered side by side for the selected experiments.
alt="Plots: Custom" />
</p>

**Custom** plots compare a chosen [metric] and param across experiments.
**Custom** plots compare a chosen [metric] and [param] across experiments.

[metric]: https://dvc.org/doc/command-reference/metrics
[param]: https://dvc.org/doc/command-reference/params

<p align="center">
<img src="images/plots-view-icon.png"
alt="Plots View Icon" />
</p>

The **Plots Dashboard** can be configured and accessed from the _Plots_ and
_Experiments_ side panels in the [**DVC View**](command:views.dvc-views).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plots is no longer a link in the Experiments side panel.

The **Plots Dashboard** can be configured and accessed from the _Plots_ side
panel in the [**DVC View**](command:views.dvc-views).

> This is equivalent to the [`dvc plots show`] and [`dvc plots diff`] commands.
7 changes: 4 additions & 3 deletions extension/resources/walkthrough/run-experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
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.
This extension provides many different ways to run a new experiment. You can
also 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:
Expand Down
7 changes: 4 additions & 3 deletions extension/resources/walkthrough/view-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ project available in the workspace:
> [GitHub](https://github.com/iterative/vscode-dvc/issues). We are happy to
> help.
If DVC and the extension are initialized, side bar will expose multiple views:
If DVC and the extension are initialized, the side bar will expose multiple
views:

<p align="center">
<img src="images/view-container.png"
Expand All @@ -36,6 +37,6 @@ If DVC and the extension are initialized, side bar will expose multiple views:
columns.
- `PLOTS`. Used to fine-tune the plots dashboard, e.g. by toggling plots
visibility.
- `FILTER BY`. Used to view, add, or remove metrics and parameters filters.
- `FILTER BY`. Used to view, add, or remove metrics/parameters filters. These
will hide specific experiments in the table.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be wrong but I think the mention about hiding experiments should be in the filter by section. I don't think sorting hides experiments 🤔

- `SORT BY`. Used to display and configure how the experiments table is sorted.
These will hide specific experiments in the table.