From b9b81ab1cfdf994d739f1c909e58120fc5680b68 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Tue, 21 Jun 2022 22:02:53 -0500 Subject: [PATCH 01/15] readme: add Known limitations section --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 7dfc9dcb62..048747fe1b 100644 --- a/README.md +++ b/README.md @@ -158,6 +158,27 @@ These are the VS Code [settings] available for the Extension: [workspace level]: https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings +## Known limitations + +Some DVC features have limited support at the moment in the VS Code extension +(but you can still use them from an IDE's _Terminal_). + +### ML Pipelines + +The extension examines [`dvc.yaml` files] to identify tracked data and changes, +but does not currently provide a graphic interface to write or modify stages. + +[`dvc.yaml` files]: https://dvc.org/doc/user-guide/project-structure + +### Monorepos + +While DVC supports Git monorepos with DVC projects inside [sub-directories], the +extension may have unexpected behaviors when opening such repos. Please open +each subdir DVC project directly with VS Code instead. + +[sub-directories]: + https://dvc.org/doc/command-reference/init#initializing-dvc-in-subdirectories + ## Debugging ### The DVC Extension From 09a538d4599c318f48068586787fda5df3a879d3 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Tue, 21 Jun 2022 22:42:38 -0500 Subject: [PATCH 02/15] walks: mention some DVC feats are only CLI and copy edit dvc-learn-more --- extension/package.json | 4 +- .../resources/walkthrough/dvc-learn-more.md | 42 ++++++++++++++----- 2 files changed, 34 insertions(+), 12 deletions(-) diff --git a/extension/package.json b/extension/package.json index a662e3ac5c..159e7301a7 100644 --- a/extension/package.json +++ b/extension/package.json @@ -1450,8 +1450,8 @@ }, { "id": "dvc.learnMore", - "title": "Explore More Resources", - "description": "Take a look into our [documentation](https://dvc.org/doc) to learn more about DVC. \n[Learn More](https://dvc.org/doc)", + "title": "Learn more about DVC", + "description": "Take a look into DVC's [documentation](https://dvc.org/doc) to learn more about its features and command-line usage. \n[Learn More](https://dvc.org/doc)", "media": { "markdown": "resources/walkthrough/dvc-learn-more.md" }, diff --git a/extension/resources/walkthrough/dvc-learn-more.md b/extension/resources/walkthrough/dvc-learn-more.md index 4f3d177761..91f103006d 100644 --- a/extension/resources/walkthrough/dvc-learn-more.md +++ b/extension/resources/walkthrough/dvc-learn-more.md @@ -1,18 +1,40 @@ -# More Resources +# Learn more about DVC -- Get started with our [guide](https://dvc.org/doc/start). +Note that some of DVC features are better or only accessible via command-line. -- Explore [use cases](https://dvc.org/doc/use-cases). + -- Browse the [user guide](https://dvc.org/doc/user-guide). +- Get started with a [hands-on tour] of the major features. -- View all [available `dvc` commands](https://dvc.org/doc/command-reference). +- Explore the [use cases]: high-level solutions that DVC provides to the data + science industry. -- Check out the [DVC GitHub repository](https://github.com/iterative/dvc) or an - [example project](https://github.com/iterative/example-get-started). +- Read the [user guide] for deeper knowledge on the approach and mechanisms or + DVC. -- Explore our [free course](https://learn.iterative.ai/). +- Browse all of the [`dvc` commands] available for command-line, and the [Python + API]. -- Read our [blog](https://dvc.org/blog). +[hands-on tour]: https://dvc.org/doc/start +[use cases]: https://dvc.org/doc/use-cases +[user guide]: https://dvc.org/doc/user-guide +[`dvc` commands]: https://dvc.org/doc/command-reference +[python api]: https://dvc.org/doc/api-reference -- Meet the [Community](https://dvc.org/community). + + +- Take our [free course] and become a certified DVC professional! + +- Check out the [DVC GitHub repository] where you can find and report issues, or + [contribute] to the open-source project. + +- Play with a ready-to-use [example project]. + +- Read our [Blog] and meet the [Community]. + +[dvc github repository]: https://github.com/iterative/dvc +[contribute]: https://dvc.org/doc/contributing/core +[example project]: https://github.com/iterative/example-get-started +[free course]: https://learn.iterative.ai/ +[blog]: https://dvc.org/blog +[community]: https://dvc.org/community From b2c5fca824bf135611a4902a9e0f9b981bdd777b Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Wed, 22 Jun 2022 01:24:09 -0500 Subject: [PATCH 03/15] readme: link to dvc-learn-more walk --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 048747fe1b..0ea6614e2c 100644 --- a/README.md +++ b/README.md @@ -72,13 +72,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/ - - +[more resources]: + https://github.com/iterative/vscode-dvc/blob/main/extension/resources/walkthrough/dvc-learn-more.md ## What you get From aa92cb9492e000e9826eb07b075d4547b37f9ad4 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Wed, 22 Jun 2022 20:44:04 -0500 Subject: [PATCH 04/15] readme: add ToC with with https://github.com/ekalinin/github-markdown-toc (locally) --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0ea6614e2c..7290452d65 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,22 @@ databases are required. https://dvc.org/doc/user-guide/experiment-management/experiments-overview [data versioning]: https://dvc.org/doc/use-cases/versioning-data-and-model-files +## Contents + +- [Quick start](#quick-start) + - [Learn more about DVC (Data Version Control)](#learn-more-about-dvc-data-version-control) +- [What you get](#what-you-get) +- [Useful commands](#useful-commands) +- [Configuration](#configuration) +- [Known limitations](#known-limitations) + - [ML Pipelines](#ml-pipelines) + - [Monorepos](#monorepos) +- [Debugging](#debugging) + - [The DVC Extension](#the-dvc-extension) + - [Your DVC project](#your-dvc-project) +- [Contributing](#contributing) +- [Data and telemetry](#data-and-telemetry) + ## Quick start 1. [Install DVC](https://dvc.org/doc/install) on your system. From e8f53af52205d4c7968dd394ce62d5b215673c44 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Wed, 22 Jun 2022 20:46:35 -0500 Subject: [PATCH 05/15] readme: start Roadmap section --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7290452d65..09c4ba71d1 100644 --- a/README.md +++ b/README.md @@ -195,6 +195,10 @@ each subdir DVC project directly with VS Code instead. [sub-directories]: https://dvc.org/doc/command-reference/init#initializing-dvc-in-subdirectories +## Roadmap + + + ## Debugging ### The DVC Extension From 3f5155a887d52ed19bc978a9a0eadd6d98d252ba Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Fri, 24 Jun 2022 11:07:39 -0500 Subject: [PATCH 06/15] readme: add dev Roadmap section --- README.md | 48 +++++++++++++++++++++++++++++++++++------------- 1 file changed, 35 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 09c4ba71d1..603db2bd48 100644 --- a/README.md +++ b/README.md @@ -174,30 +174,52 @@ These are the VS Code [settings] available for the Extension: [workspace level]: https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings -## Known limitations +## Developer roadmap -Some DVC features have limited support at the moment in the VS Code extension -(but you can still use them from an IDE's _Terminal_). +We are working on increasing the amount of DVC features supported by this GUI. +Remember that you can always use `dvc` commands from the _Integrated Terminal_! -### ML Pipelines +### Parallel coordinates plot (2022 Q3) + +DVC Experiment comparison is easier with interactive [parallel coordinate plots] +(`dvc exp show --pcp`) from command-line. + +[parallel coordinate plots]: + https://dvc.org/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot + +### 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 does not currently provide a graphic interface to write or modify stages. +but it does not currently provide a graphic interface to write or modify stages. [`dvc.yaml` files]: https://dvc.org/doc/user-guide/project-structure -### Monorepos +### 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. + +[remote development]: https://code.visualstudio.com/docs/remote/remote-overview + +### Data registry (2022 Q4) -While DVC supports Git monorepos with DVC projects inside [sub-directories], the -extension may have unexpected behaviors when opening such repos. Please open -each subdir DVC project directly with VS Code instead. +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. -[sub-directories]: - https://dvc.org/doc/command-reference/init#initializing-dvc-in-subdirectories +[data registries]: https://dvc.org/doc/use-cases/data-registry -## Roadmap +### 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! ## Debugging From 73d555a174f4b905eb706fdc27e1a2ffa527d4b4 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Fri, 24 Jun 2022 11:09:44 -0500 Subject: [PATCH 07/15] readme: update ToC --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 603db2bd48..cf4ce659a4 100644 --- a/README.md +++ b/README.md @@ -58,9 +58,13 @@ databases are required. - [What you get](#what-you-get) - [Useful commands](#useful-commands) - [Configuration](#configuration) -- [Known limitations](#known-limitations) - - [ML Pipelines](#ml-pipelines) - - [Monorepos](#monorepos) +- [Developer roadmap](#developer-roadmap) + - [Parallel coordinates plot (2022 Q3)](#parallel-coordinates-plot-2022-q3) + - [Performance improvements (2022 Q3)](#performance-improvements-2022-q3) + - [ML pipelines (2022 Q4)](#ml-pipelines-2022-q4) + - [Remote execution (2022 Q4)](#remote-execution-2022-q4) + - [Data registry (2022 Q4)](#data-registry-2022-q4) + - [More tools from Iterative.ai (2023)](#more-tools-from-iterativeai-2023) - [Debugging](#debugging) - [The DVC Extension](#the-dvc-extension) - [Your DVC project](#your-dvc-project) @@ -176,13 +180,14 @@ These are the VS Code [settings] available for the Extension: ## Developer roadmap -We are working on increasing the amount of DVC features supported by this GUI. -Remember that you can always use `dvc` commands from the _Integrated Terminal_! +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_! ### Parallel coordinates plot (2022 Q3) DVC Experiment comparison is easier with interactive [parallel coordinate plots] -(`dvc exp show --pcp`) from command-line. +(`dvc exp show --pcp` from command-line). [parallel coordinate plots]: https://dvc.org/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot From 3483a48dd7ee9ec5236049ac316e494ba5a6ab72 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Fri, 24 Jun 2022 22:33:22 -0500 Subject: [PATCH 08/15] readme: try ToC as horizontal bar per https://github.com/iterative/vscode-dvc/pull/1936#issuecomment-1165922686 --- README.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index cf4ce659a4..da4e2bfd4a 100644 --- a/README.md +++ b/README.md @@ -51,25 +51,12 @@ databases are required. https://dvc.org/doc/user-guide/experiment-management/experiments-overview [data versioning]: https://dvc.org/doc/use-cases/versioning-data-and-model-files -## Contents - -- [Quick start](#quick-start) - - [Learn more about DVC (Data Version Control)](#learn-more-about-dvc-data-version-control) -- [What you get](#what-you-get) -- [Useful commands](#useful-commands) -- [Configuration](#configuration) -- [Developer roadmap](#developer-roadmap) - - [Parallel coordinates plot (2022 Q3)](#parallel-coordinates-plot-2022-q3) - - [Performance improvements (2022 Q3)](#performance-improvements-2022-q3) - - [ML pipelines (2022 Q4)](#ml-pipelines-2022-q4) - - [Remote execution (2022 Q4)](#remote-execution-2022-q4) - - [Data registry (2022 Q4)](#data-registry-2022-q4) - - [More tools from Iterative.ai (2023)](#more-tools-from-iterativeai-2023) -- [Debugging](#debugging) - - [The DVC Extension](#the-dvc-extension) - - [Your DVC project](#your-dvc-project) -- [Contributing](#contributing) -- [Data and telemetry](#data-and-telemetry) +--- + +[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) ## Quick start From 3d0a41a1c2d9d7c346020ad5ae29c6a0601f8076 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Fri, 24 Jun 2022 22:38:38 -0500 Subject: [PATCH 09/15] readme: make lighter Roadmap rel. https://github.com/iterative/vscode-dvc/pull/1936#pullrequestreview-1019242993 --- README.md | 62 ++++++++++++++++++++++++------------------------------- 1 file changed, 27 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index da4e2bfd4a..b534b5ae28 100644 --- a/README.md +++ b/README.md @@ -171,48 +171,40 @@ 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_! -### Parallel coordinates plot (2022 Q3) - -DVC Experiment comparison is easier with interactive [parallel coordinate plots] -(`dvc exp show --pcp` from command-line). +- **Parallel coordinates plot** (2022 Q3) + DVC Experiment comparison is easier with interactive [parallel coordinate + plots] (`dvc exp show --pcp` from command-line). + +- **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! [parallel coordinate plots]: https://dvc.org/doc/user-guide/experiment-management/comparing-experiments#parallel-coordinates-plot - -### 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. - [`dvc.yaml` files]: https://dvc.org/doc/user-guide/project-structure - -### 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. - [remote development]: https://code.visualstudio.com/docs/remote/remote-overview - -### 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. - [data registries]: https://dvc.org/doc/use-cases/data-registry -### 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! - ## Debugging ### The DVC Extension From 309926be18a97905607a1c2219a2f5fb63f87589 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Fri, 24 Jun 2022 22:43:21 -0500 Subject: [PATCH 10/15] walks: roll back changes per https://github.com/iterative/vscode-dvc/pull/1936#pullrequestreview-1019243063 --- extension/package.json | 4 +- .../resources/walkthrough/dvc-learn-more.md | 42 +++++-------------- 2 files changed, 12 insertions(+), 34 deletions(-) diff --git a/extension/package.json b/extension/package.json index 28a93a1c9e..d7daf83fa0 100644 --- a/extension/package.json +++ b/extension/package.json @@ -1450,8 +1450,8 @@ }, { "id": "dvc.learnMore", - "title": "Learn more about DVC", - "description": "Take a look into DVC's [documentation](https://dvc.org/doc) to learn more about its features and command-line usage. \n[Learn More](https://dvc.org/doc)", + "title": "Explore More Resources", + "description": "Take a look into our [documentation](https://dvc.org/doc) to learn more about DVC. \n[Learn More](https://dvc.org/doc)", "media": { "markdown": "resources/walkthrough/dvc-learn-more.md" }, diff --git a/extension/resources/walkthrough/dvc-learn-more.md b/extension/resources/walkthrough/dvc-learn-more.md index 91f103006d..4f3d177761 100644 --- a/extension/resources/walkthrough/dvc-learn-more.md +++ b/extension/resources/walkthrough/dvc-learn-more.md @@ -1,40 +1,18 @@ -# Learn more about DVC +# More Resources -Note that some of DVC features are better or only accessible via command-line. +- Get started with our [guide](https://dvc.org/doc/start). - +- Explore [use cases](https://dvc.org/doc/use-cases). -- Get started with a [hands-on tour] of the major features. +- Browse the [user guide](https://dvc.org/doc/user-guide). -- Explore the [use cases]: high-level solutions that DVC provides to the data - science industry. +- View all [available `dvc` commands](https://dvc.org/doc/command-reference). -- Read the [user guide] for deeper knowledge on the approach and mechanisms or - DVC. +- Check out the [DVC GitHub repository](https://github.com/iterative/dvc) or an + [example project](https://github.com/iterative/example-get-started). -- Browse all of the [`dvc` commands] available for command-line, and the [Python - API]. +- Explore our [free course](https://learn.iterative.ai/). -[hands-on tour]: https://dvc.org/doc/start -[use cases]: https://dvc.org/doc/use-cases -[user guide]: https://dvc.org/doc/user-guide -[`dvc` commands]: https://dvc.org/doc/command-reference -[python api]: https://dvc.org/doc/api-reference +- Read our [blog](https://dvc.org/blog). - - -- Take our [free course] and become a certified DVC professional! - -- Check out the [DVC GitHub repository] where you can find and report issues, or - [contribute] to the open-source project. - -- Play with a ready-to-use [example project]. - -- Read our [Blog] and meet the [Community]. - -[dvc github repository]: https://github.com/iterative/dvc -[contribute]: https://dvc.org/doc/contributing/core -[example project]: https://github.com/iterative/example-get-started -[free course]: https://learn.iterative.ai/ -[blog]: https://dvc.org/blog -[community]: https://dvc.org/community +- Meet the [Community](https://dvc.org/community). From eb8d27a64062d5d19400364f26f2f279b39e12d7 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Fri, 24 Jun 2022 22:59:29 -0500 Subject: [PATCH 11/15] readme: add DVC metafile bullet to Roadmap per https://iterative-squad.monday.com/boards/2546691996/pulses/2574158499 --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b534b5ae28..392b0f2aa1 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,11 @@ 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` + - **Parallel coordinates plot** (2022 Q3) DVC Experiment comparison is easier with interactive [parallel coordinate plots] (`dvc exp show --pcp` from command-line). @@ -199,9 +204,11 @@ _Integrated Terminal_! [MLEM](https://mlem.ai/) + [GTO](https://github.com/iterative/gto) **model registry** management, and future surprises! +[dvc metafile]: 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 +[`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 From 9d8d9ab087c1314134e21bbf078708f48593a4dc Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Fri, 24 Jun 2022 23:03:49 -0500 Subject: [PATCH 12/15] readme: update More Plots bullet in Roadmap per https://iterative-squad.monday.com/boards/2546691996/pulses/2574177529 --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 392b0f2aa1..0a9b86ac60 100644 --- a/README.md +++ b/README.md @@ -176,9 +176,10 @@ _Integrated Terminal_! corresponding [DVC metafiles]? E.g. `dvc.yaml` and `.dvc` files, param or metrics files, even `dvc.lock` -- **Parallel coordinates plot** (2022 Q3) +- **More and better plots!** (2022 Q3) DVC Experiment comparison is easier with interactive [parallel coordinate - plots] (`dvc exp show --pcp` from command-line). + 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 @@ -202,7 +203,7 @@ _Integrated Terminal_! 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! + registry** management, and future surprises! (TBD) [dvc metafile]: https://dvc.org/doc/user-guide/project-structure [parallel coordinate plots]: From a45cce8c0491ee32e1408589d6b0af89cd200847 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 27 Jun 2022 23:49:52 -0500 Subject: [PATCH 13/15] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a9b86ac60..e3e5e36221 100644 --- a/README.md +++ b/README.md @@ -205,7 +205,7 @@ _Integrated Terminal_! [MLEM](https://mlem.ai/) + [GTO](https://github.com/iterative/gto) **model registry** management, and future surprises! (TBD) -[dvc metafile]: https://dvc.org/doc/user-guide/project-structure +[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]: From e43c7bbdeeb505717dad28f3193b33dfdfa09d93 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Perez Date: Tue, 28 Jun 2022 16:58:23 -0500 Subject: [PATCH 14/15] readme: move ToC up per https://github.com/iterative/vscode-dvc/pull/1936#discussion_r908052645 --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e3e5e36221..f9d1f1410a 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ [![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 @@ -51,13 +58,6 @@ databases are required. https://dvc.org/doc/user-guide/experiment-management/experiments-overview [data versioning]: https://dvc.org/doc/use-cases/versioning-data-and-model-files ---- - -[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) - ## Quick start 1. [Install DVC](https://dvc.org/doc/install) on your system. From fb3dfb70e2ecde97fc4ce0e6d17f0ab118316d1b Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Tue, 28 Jun 2022 15:30:03 -0700 Subject: [PATCH 15/15] minor: remove the horizontal line Co-authored-by: Jorge Orpinel --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index f9d1f1410a..46fde9e1ba 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,6 @@ [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