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.

Sign up for GitHub

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

vs-code: docs #3663

Closed
wants to merge 2 commits into from
Closed

vs-code: docs #3663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e19e799
vs-code: start new section
jorgeorpinel Jun 14, 2022
944ee5d
vs-code: add index and 2 template guides
jorgeorpinel Jun 14, 2022
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
5 changes: 5 additions & 0 deletions content/docs/sidebar.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,11 @@
}
]
},
{
"slug": "vs-code-extension",
"label": "VS Code Extension",
"children": ["dvc-experiments", "data-management"]
},
{
"label": "Studio",
"slug": "studio",
Expand Down
14 changes: 14 additions & 0 deletions content/docs/vs-code-extension/data-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Data Management in VS Code

The DVC Extension for Virtual Studio Code integrates DVC's core data versioning
shcheklein marked this conversation as resolved.
Show resolved Hide resolved
capabilities into the File Explorer and Source Code (Git) views. It also
provides a UI to synchronize tracked data and models between the workspace,
cache, and (optional) remote storage.

## DVC Tracked panel (Explorer)

...

## DVC panel (Source Code)

...
18 changes: 18 additions & 0 deletions content/docs/vs-code-extension/dvc-experiments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# DVC Experiments in VS Code

The DVC Extension for Virtual Studio Code focuses on providing a UI to run,
display, compare, and manage [DVC Experiments].

[dvc experiments]: /doc/user-guide/experiment-management/experiments-overview

## DVC View

...

## Experiments Table

...

## Plots View

...
30 changes: 30 additions & 0 deletions content/docs/vs-code-extension/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# DVC Extension for Virtual Studio Code

Our [Extension for VS Code] brings DVC's machine learning [experiment
versioning] and [data management] to your IDE! Users with or without command
line experience can enjoy DVC with rich views integrated right into their
development environment.

[extension for vs code]:
https://marketplace.visualstudio.com/items?itemName=Iterative.dvc
[experiment versioning]:
/doc/user-guide/experiment-management/experiments-overview
[data management]: /doc/use-cases/versioning-data-and-model-files

<cards>

<card href="/doc/vs-code-extension/dvc-experiments" heading="DVC Experiments">
Track and version ML experiment metrics and parameters, visualize their
performance in plots, or see live metrics in real-time.
</card>

<card href="/doc/vs-code-extension/data-management" heading="Data Management">
Version your data and models and synchronize them among team mates and
environments.
</card>

</cards>

> See a full list of this extension's [additions] to VS Code.

[additions]: https://github.com/iterative/vscode-dvc#what-you-get