diff --git a/README.rst b/README.rst index ee63795af2..6e2d7c7161 100644 --- a/README.rst +++ b/README.rst @@ -2,12 +2,12 @@ `Website `_ • `Docs `_ +• `VS Code Extension `_ • `Blog `_ • `Twitter `_ • `Chat (Community & Support) `_ • `Tutorial `_ • `Mailing List `_ -• `VS Code Extension `_ |CI| |Maintainability| |Coverage| |VS Code| |DOI| @@ -15,8 +15,7 @@ | -**Data Version Control** or **DVC** helps you develop reproducible machine -learning projects: +**Data Version Control** or **DVC** is a command line tool and `VS Code Extension `_ to help you develop reproducible machine learning projects: #. **Version** your data and models. Store them in your cloud storage but keep their version info in your Git repo. @@ -26,9 +25,7 @@ learning projects: #. **Track** experiments in your local Git repo (no servers needed). -#. **Compare** any data, code, parameters, metrics, or plots from the command - line or in `VS Code - `_. +#. **Compare** any data, code, parameters, model, or performance plots #. **Share** experiments and automatically reproduce anyone's experiment. @@ -56,7 +53,7 @@ Google Cloud, etc) or any on-premise network storage (via SSH, for example). The DVC pipelines (computational graph) feature connects code and data together. It is possible to explicitly specify all steps required to produce a model: input dependencies including data, commands to run, -and output information to be saved. See the quick start section below or +and output information to be saved. See the quick start sections below or the `Get Started `_ tutorial to learn more. Quick start @@ -84,17 +81,27 @@ Please read `Get Started `_ guide for a full ve | | | ``$ dvc push`` | +-----------------------------------+----------------------------------------------------------------------------+ +Visual Studio Code Extension +============================ + +|VS Code| + +To get use DVC as a GUI right from your VS Code IDE, install the `DVC Extension `_ from the Marketplace. +It currently features experiment tracking and data management, and more features (data pipeline support, etc.) are coming soon! + +|VS Code Extension Overview| + + Note: You'll have to install core DVC on your system separately (as detailed + below). The Extension will guide you if needed. + Installation ============ -There are four options to install DVC: ``pip``, Homebrew, Conda (Anaconda) or an OS-specific package. +There are several ways to install DVC: in VS Code; using ``snap``, ``choco``, ``brew``, ``conda``, ``pip``; or with an OS-specific package. Full instructions are `available here `_. -To use with VS Code, install DVC and then install the `DVC Extension -`_. - -Snap (Snapcraft/Linux) ----------------------- +Snapcraft (Linux) +----------------- |Snap| @@ -257,6 +264,9 @@ Barrak, A., Eghan, E.E. and Adams, B. `On the Co-evolution of ML Pipelines and S :target: https://dvc.org :alt: DVC logo +.. |VS Code Extension Overview| image:: https://raw.githubusercontent.com/iterative/vscode-dvc/main/extension/docs/overview.gif + :alt: DVC Extension for VS Code + .. |CI| image:: https://github.com/iterative/dvc/workflows/Tests/badge.svg?branch=main :target: https://github.com/iterative/dvc/actions :alt: GHA Tests