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

Jump to bottom

readme: more VS Code Extension info. #7916

Merged
merged 11 commits into from Jun 20, 2022
Merged

readme: more VS Code Extension info. #7916

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a7bdc1e
readme: intro updates (VSCE)
jorgeorpinel Jun 17, 2022
0f28652
readme: blocks to link to DVC GS
jorgeorpinel Jun 17, 2022
b84366f
readme: Link current Quick start to Cmd Ref
jorgeorpinel Jun 17, 2022
04fd858
readme: add VS Code to Installation list + formatting
jorgeorpinel Jun 17, 2022
b06bbef
Update README.rst
jorgeorpinel Jun 18, 2022
d3c0f08
readme: add VS Code Extension sction and gif
jorgeorpinel Jun 18, 2022
ac96fc5
readme: fix link
jorgeorpinel Jun 18, 2022
5482de3
readme: roll back non-vscode changes
jorgeorpinel Jun 19, 2022
8fdaec5
readme: single QS, VSC gif in Install
jorgeorpinel Jun 19, 2022
d003755
Merge branch 'main' into readme/vsce
jorgeorpinel Jun 20, 2022
5a1f9b0
readme: make VS Code installation into a separate section.
jorgeorpinel Jun 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 23 additions & 13 deletions README.rst
View file
Open in desktop
Expand Up @@ -2,21 +2,20 @@

`Website <https://dvc.org>`_
• `Docs <https://dvc.org/doc>`_
• `VS Code Extension <https://marketplace.visualstudio.com/items?itemName=Iterative.dvc>`_
• `Blog <http://blog.dataversioncontrol.com>`_
• `Twitter <https://twitter.com/DVCorg>`_
• `Chat (Community & Support) <https://dvc.org/chat>`_
• `Tutorial <https://dvc.org/doc/get-started>`_
• `Mailing List <https://sweedom.us10.list-manage.com/subscribe/post?u=a08bf93caae4063c4e6a351f6&id=24c0ecc49a>`_
• `VS Code Extension <https://marketplace.visualstudio.com/items?itemName=Iterative.dvc>`_

|CI| |Maintainability| |Coverage| |VS Code| |DOI|

|PyPI| |Packages| |Brew| |Conda| |Choco| |Snap|

|

**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 <https://marketplace.visualstudio.com/items?itemName=Iterative.dvc>`_ 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.
Expand All @@ -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
<https://marketplace.visualstudio.com/items?itemName=Iterative.dvc>`_.
#. **Compare** any data, code, parameters, model, or performance plots

#. **Share** experiments and automatically reproduce anyone's experiment.

Expand Down Expand Up @@ -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 <https://dvc.org/doc/get-started>`_ tutorial to learn more.

Quick start
Expand Down Expand Up @@ -84,17 +81,27 @@ Please read `Get Started <https://dvc.org/doc/get-started>`_ guide for a full ve
| | | ``$ dvc push`` |
+-----------------------------------+----------------------------------------------------------------------------+

Visual Studio Code Extension
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
============================

|VS Code|

To get use DVC as a GUI right from your VS Code IDE, install the `DVC Extension <https://marketplace.visualstudio.com/items?itemName=Iterative.dvc>`_ 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 <https://dvc.org/doc/get-started/install>`_.

To use with VS Code, install DVC and then install the `DVC Extension
<https://marketplace.visualstudio.com/items?itemName=Iterative.dvc>`_.

Snap (Snapcraft/Linux)
----------------------
Snapcraft (Linux)
-----------------

|Snap|

Expand Down Expand Up @@ -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
Expand Down