Skip to content
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
b9b81ab
readme: add Known limitations section
jorgeorpinel Jun 22, 2022
09a538d
walks: mention some DVC feats are only CLI and
jorgeorpinel Jun 22, 2022
b2c5fca
readme: link to dvc-learn-more walk
jorgeorpinel Jun 22, 2022
68bc5b8
Merge branch 'main' into readme/known-limitations
jorgeorpinel Jun 23, 2022
aa92cb9
readme: add ToC with
jorgeorpinel Jun 23, 2022
e8f53af
readme: start Roadmap section
jorgeorpinel Jun 23, 2022
7f2a00b
Merge branch 'main' into readme/known-limitations
jorgeorpinel Jun 24, 2022
3f5155a
readme: add dev Roadmap section
jorgeorpinel Jun 24, 2022
73d555a
readme: update ToC
jorgeorpinel Jun 24, 2022
94b8f74
Merge branch 'main' into readme/known-limitations
jorgeorpinel Jun 25, 2022
3483a48
readme: try ToC as horizontal bar
jorgeorpinel Jun 25, 2022
3d0a41a
readme: make lighter Roadmap
jorgeorpinel Jun 25, 2022
309926b
walks: roll back changes
jorgeorpinel Jun 25, 2022
eb8d27a
readme: add DVC metafile bullet to Roadmap
jorgeorpinel Jun 25, 2022
9d8d9ab
readme: update More Plots bullet in Roadmap
jorgeorpinel Jun 25, 2022
7427f05
Merge branch 'main' into readme/known-limitations
jorgeorpinel Jun 28, 2022
a45cce8
Update README.md
jorgeorpinel Jun 28, 2022
e43c7bb
readme: move ToC up
jorgeorpinel Jun 28, 2022
fb3dfb7
minor: remove the horizontal line
shcheklein Jun 28, 2022
6282adf
Merge branch 'main' into readme/known-limitations
jorgeorpinel Jun 30, 2022
3fc4741
Merge branch 'readme/known-limitations' of github.com:iterative/vscod…
jorgeorpinel Jun 30, 2022
ce3353a
Merge branch 'main' into readme/known-limitations
jorgeorpinel Jun 30, 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
59 changes: 56 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/fb243c31ea059c0038b2/maintainability)](https://codeclimate.com/repos/608b5886f52398018b00264c/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/fb243c31ea059c0038b2/test_coverage)](https://codeclimate.com/repos/608b5886f52398018b00264c/test_coverage)

[Quick start](#quick-start) • [What you get](#what-you-get) •
[Commands](#useful-commands) • [Configuration](#configuration) •
[Roadmap](#developer-roadmap) • [Debugging](#debugging) •
[Contributing](#contributing) • [Telemetry](#data-and-telemetry)

Run, compare, visualize, and track machine learning experiments right in VS
Code. This extension uses [DVC](https://dvc.org/), an open-source data
versioning and ML experiment management tool. No additional services or
Expand Down Expand Up @@ -72,13 +77,13 @@ databases are required.
### Learn more about DVC (Data Version Control)

See the DVC documentation to Get Started with [Experiment Versioning] or [Data
Management]. For deeper learning, try our [free course]!
Management]. For deeper learning, try our [free course]! [More resources]

[experiment versioning]: https://dvc.org/doc/start/experiments
[data management]: https://dvc.org/doc/start/data-management
[free course]: https://learn.iterative.ai/

<!-- [learn more]: extension/resources/walkthrough/dvc-learn-more.md -->
[more resources]:
https://github.com/iterative/vscode-dvc/blob/main/extension/resources/walkthrough/dvc-learn-more.md

## What you get

Expand Down Expand Up @@ -158,6 +163,54 @@ These are the VS Code [settings] available for the Extension:
[workspace level]:
https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings

## Developer roadmap
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's actually create a board and put a link to it instead? For now either tickets or stubs are fine, we'll review it later

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now I made it into a lighter-looking bullet list since I can't make the board myself. Cc @mattseddon happy to link instead once one exists.

See https://github.com/iterative/vscode-dvc/tree/readme/known-limitations#developer-roadmap. Thanks

Copy link
Contributor

Choose a reason for hiding this comment

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

We'll go through Q planning next week.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So should we keep this open or merge (since it's approved) and revisit then?

Copy link
Contributor

Choose a reason for hiding this comment

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

If the PR meets the criteria to merge then feel free. We should keep everything moving.


We are working on increasing the quantity and quality of DVC features supported
by this GUI. Remember that you can always use `dvc` commands from the
_Integrated Terminal_!

- **DVC metafile editor** (2022 Q3) Wouldn't it be cool to manage stages,
parameters, metrics, data and model paths, and other metadata in-place inside
corresponding [DVC metafiles]? E.g. `dvc.yaml` and `.dvc` files, param or
metrics files, even `dvc.lock`

- **More and better plots!** (2022 Q3)
DVC Experiment comparison is easier with interactive [parallel coordinate
plots], which can be generated from command line with `dvc exp show --pcp`. We
plan to incorporate that and brand new IDE-exclusive plots! (TBD)

- **Performance improvements** (2022 Q3)
Our extension will be faster and more reliable with better internal usage of
DVC and more efficient data management.

- **ML pipelines** (2022 Q4)
The extension examines [`dvc.yaml` files] to identify tracked data and
changes, but it does not currently provide a graphic interface to write or
modify stages.

- **Remote execution** (2022 Q4)
DVC Experiments can be run in remote environments. We intend to integrate this
with VS Code's robust [remote development] features.

- **Data registry** (2022 Q4)
DVC [data registries] can help you centralize and secure data management
across all your ML projects. You'll be able to construct and handle them right
from the IDE.

- **More tools from Iterative.ai** (2023)
Expect this extension to become a full-fledged suite for the ecosystem of
tools from Iterative, such as [CML](https://cml.dev/),
[MLEM](https://mlem.ai/) + [GTO](https://github.com/iterative/gto) **model
registry** management, and future surprises! (TBD)

[dvc metafiles]: https://dvc.org/doc/user-guide/project-structure
[parallel coordinate plots]:
https://dvc.org/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot
[`dvc.yaml` files]:
https://dvc.org/doc/user-guide/project-structure/pipelines-files
[remote development]: https://code.visualstudio.com/docs/remote/remote-overview
[data registries]: https://dvc.org/doc/use-cases/data-registry

## Debugging

### The DVC Extension
Expand Down