-
Notifications
You must be signed in to change notification settings - Fork 29
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
Review and update the walkthrough #1876
Conversation
78e29dd
to
5909bed
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good improvement. Need to think about what to do if we cannot access the CLI or have nothing meaningful to show for part of the walkthrough.
Yep, it's WIP. I mentioned that there will be some graphics / animations, etc. I think it's much better to show everything, it was super confusing and took me time to understand what's happening and that I need to click two things to see more and w/o the other sections it looked quite strange. |
@mattseddon thanks for reviewing this! |
ebad0ab
to
df9fdb1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review on Install DVC page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Setup DVC Project review
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On Available Commands
UPDATE: I would move this all the way down just before the More Resources page.
df9fdb1
to
4be032b
Compare
4be032b
to
3c162c8
Compare
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add link to the command here as per: [Command Palette](command:workbench.action.quickOpen?%22>DVC:%20Show%20Experiments%22)
?
3c162c8
to
b1f5fa0
Compare
b1f5fa0
to
56cb6e4
Compare
Restyle Review and update the walkthrough
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On the DVC View page
I'd rename it to dvc-view.md BTW.
"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)", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"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)", | |
"title": "DVC View (Activity Bar)", | |
"description": "Quickly access and select your experiments and plots from a dedicated DVC screen\n\n[Open DVC View](command:workbench.view.extension.dvc-views)", |
|
||
The view container provides supplementary information and control over the | ||
experiments and plots in the workspace. | ||
# DVC Views |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically the whole screen is a "View" in VS Code. The side bar sections are its Panels.
# DVC Views | |
# DVC View |
access the views or use | ||
[View: Show DVC](command:workbench.view.extension.dvc-views) from the Command | ||
Palette. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
access the views or use | |
[View: Show DVC](command:workbench.view.extension.dvc-views) from the Command | |
Palette. | |
or use the | |
[View: Show DVC](command:workbench.view.extension.dvc-views) command | |
to reach the DVC screen. |
❗ A welcome and support views showing some getting started instructions will | ||
appear in the container when the `DVC` is not installed or if there is not a | ||
`DVC` project available in the workspace: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❗ A welcome and support views showing some getting started instructions will | |
appear in the container when the `DVC` is not installed or if there is not a | |
`DVC` project available in the workspace: | |
⚠️ If DVC or the project have not been set up yet, the | |
[Side Bar](https://code.visualstudio.com/docs/getstarted/userinterface) | |
will display **Welcome** and **Support** panels to point you in the right | |
direction. |
> 🤗 If something goes wrong, you have a feature request, 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 exposes multiple views: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> 🤗 If something goes wrong, you have a feature request, 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 exposes multiple views: | |
> 🤗 If you need help or have a feature request, | |
> don't hesitate to ping us on [Discord](https://discord.gg/BGCjJHvDHt) | |
> or open an [issue](https://github.com/iterative/vscode-dvc/issues) on | |
> GitHub. | |
For up and running DVC projects, the Side Bar will show several panels to | |
work on your experiments: |
- `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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- `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. | |
- **Columns**: Open the _Experiments Table_ and pick which experiment | |
metrics, parameters, as well as input and output files to include (as table | |
headers). | |
- **Experiments**: Run an experiment or choose experiments (and checkpoints) | |
to include in the _Plots Dashboard_. | |
- **Sort by**: Set the order of the Experiments Table rows. | |
- **Filter by**: Quickly find or hide certain experiments from the Experiments | |
Table based on their metrics and params | |
- **Plots**: Open the _Plots Dashboard_ and select the data series and images | |
to visualize in it. |
Code Climate has analyzed commit fee0c6e and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (85% is the threshold). This pull request will bring the total coverage in the repository to 96.6% (0.0% change). View more on Code Climate. |
@jorgeorpinel let's not review it now, let's merge it as-is and review after the release. let's focus on the README |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll be iterating on this over the next week.
"title": "Get Started", | ||
"description": "Your first steps to build better models faster with experiment tracking and dataset versioning", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"title": "Get Started", | |
"description": "Your first steps to build better models faster with experiment tracking and dataset versioning", | |
"title": "Walkthrough", | |
"description": "Setup the extension and tour its main features. Take your first steps to build better models faster with experiment tracking and dataset versioning", |
|
||
- 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). | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file just re-lists the side bar of dvc.org/doc. We can just link there instead and remove this, I think.
Screen.Recording.2022-06-11.at.5.31.37.PM.mov