search

iterative / dvc

🦉 ML Experiments and Data Management with Git
https://dvc.org
Apache License 2.0
13.36k stars 1.16k forks source link
ai collaboration data-science data-version-control developer-tools git hacktoberfest machine-learning python reproducibility

readme

|Banner|

Website <https://dvc.org> • Docs <https://dvc.org/doc> • Blog <http://blog.dataversioncontrol.com> • Tutorial <https://dvc.org/doc/get-started> • Related Technologies <https://dvc.org/doc/user-guide/related-technologies> • How DVC works • VS Code Extension • Installation • Contributing • Community and Support

|CI| |Python Version| |Coverage| |VS Code| |DOI|

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

|

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.

. Iterate fast with lightweight pipelines.

When you make changes, only run the steps impacted by those changes.

. Track experiments in your local Git repo (no servers needed).

. Compare any data, code, parameters, model, or performance plots.

. Share experiments and automatically reproduce anyone's experiment.

Quick start

Please read our `Command Reference <https://dvc.org/doc/command-reference>`_ for a complete list.

A common CLI workflow includes:

+-----------------------------------+----------------------------------------------------------------------------------------------------+ | Task | Terminal | +===================================+====================================================================================================+ | Track data | | $ git add train.py params.yaml | | | | $ dvc add images/ | +-----------------------------------+----------------------------------------------------------------------------------------------------+ | Connect code and data | | $ dvc stage add -n featurize -d images/ -o features/ python featurize.py | | | | $ dvc stage add -n train -d features/ -d train.py -o model.p -M metrics.json python train.py | +-----------------------------------+----------------------------------------------------------------------------------------------------+ | Make changes and experiment | | $ dvc exp run -n exp-baseline | | | | $ vi train.py | | | | $ dvc exp run -n exp-code-change | +-----------------------------------+----------------------------------------------------------------------------------------------------+ | Compare and select experiments | | $ dvc exp show | | | | $ dvc exp apply exp-baseline | +-----------------------------------+----------------------------------------------------------------------------------------------------+ | Share code | | $ git add . | | | | $ git commit -m 'The baseline model' | | | | $ git push | +-----------------------------------+----------------------------------------------------------------------------------------------------+ | Share data and ML models | | $ dvc remote add myremote -d s3://mybucket/image_cnn | | | | $ dvc push | +-----------------------------------+----------------------------------------------------------------------------------------------------+

How DVC works

We encourage you to read our `Get Started
<https://dvc.org/doc/get-started>`_ docs to better understand what DVC
does and how it can fit your scenarios.

The closest analogies to describe the main DVC features are these:

. Git for data: Store and share data artifacts (like Git-LFS but without a server) and models, connecting them with a Git repository. Data management meets GitOps!

. Makefiles for ML: Describes how data or model artifacts are built from other data and code in a standard format. Now you can version your data pipelines with Git.

. Local experiment tracking: Turn your machine into an ML experiment management platform, and collaborate with others using existing Git hosting (Github, Gitlab, etc.).

Git is employed as usual to store and version code (including DVC meta-files as placeholders for data). DVC stores data and model files <https://dvc.org/doc/start/data-management>_ seamlessly in a cache outside of Git, while preserving almost the same user experience as if they were in the repo. To share and back up the data cache, DVC supports multiple remote storage platforms - any cloud (S3, Azure, Google Cloud, etc.) or on-premise network storage (via SSH, for example).

|Flowchart|

DVC pipelines <https://dvc.org/doc/start/data-management/data-pipelines>_ (computational graphs) connect code and data together. They specify all steps required to produce a model: input dependencies including code, data, commands to run; and output information to be saved.

Last but not least, DVC Experiment Versioning <https://dvc.org/doc/start/experiments>_ lets you prepare and run a large number of experiments. Their results can be filtered and compared based on hyperparameters and metrics, and visualized with multiple plots.

.. _VS Code Extension:

VS Code Extension

|VS Code|

To 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 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>_.

Snapcraft (Linux)

|Snap|

.. code-block:: bash

snap install dvc --classic

This corresponds to the latest tagged release. Add --beta for the latest tagged release candidate, or --edge for the latest main version.

Chocolatey (Windows)

|Choco|

.. code-block:: bash

choco install dvc

Brew (mac OS)

|Brew|

.. code-block:: bash

brew install dvc

Anaconda (Any platform)

|Conda|

.. code-block:: bash

conda install -c conda-forge mamba # installs much faster than conda mamba install -c conda-forge dvc

Depending on the remote storage type you plan to use to keep and share your data, you might need to install optional dependencies: dvc-s3, dvc-azure, dvc-gdrive, dvc-gs, dvc-oss, dvc-ssh.

PyPI (Python)

|PyPI|

.. code-block:: bash

pip install dvc

Depending on the remote storage type you plan to use to keep and share your data, you might need to specify one of the optional dependencies: s3, gs, azure, oss, ssh. Or all to include them all. The command should look like this: pip install 'dvc[s3]' (in this case AWS S3 dependencies such as boto3 will be installed automatically).

To install the development version, run:

.. code-block:: bash

pip install git+git://github.com/iterative/dvc

Package (Platform-specific)

|Packages|

Self-contained packages for Linux, Windows, and Mac are available. The latest version of the packages can be found on the GitHub releases page <https://github.com/iterative/dvc/releases>_.

Ubuntu / Debian (deb) ^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash

sudo wget https://dvc.org/deb/dvc.list -O /etc/apt/sources.list.d/dvc.list wget -qO - https://dvc.org/deb/iterative.asc | sudo apt-key add - sudo apt update sudo apt install dvc

Fedora / CentOS (rpm) ^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash

sudo wget https://dvc.org/rpm/dvc.repo -O /etc/yum.repos.d/dvc.repo sudo rpm --import https://dvc.org/rpm/iterative.asc sudo yum update sudo yum install dvc

Contributing

|Maintainability|

Contributions are welcome! Please see our Contributing Guide <https://dvc.org/doc/user-guide/contributing/core>_ for more details. Thanks to all our contributors!

|Contribs|

Community and Support

Copyright

This project is distributed under the Apache license version 2.0 (see the LICENSE file in the project root).

By submitting a pull request to this project, you agree to license your contribution under the Apache license version 2.0 to this project.

Citation

|DOI|

Iterative, DVC: Data Version Control - Git for Data & Models (2020) DOI:10.5281/zenodo.012345 <https://doi.org/10.5281/zenodo.3677553>_.

Barrak, A., Eghan, E.E. and Adams, B. On the Co-evolution of ML Pipelines and Source Code - Empirical Study of DVC Projects <https://mcis.cs.queensu.ca/publications/2021/saner.pdf>_ , in Proceedings of the 28th IEEE International Conference on Software Analysis, Evolution, and Reengineering, SANER 2021. Hawaii, USA.

.. |Banner| image:: https://dvc.org/img/logo-github-readme.png :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

.. |Maintainability| image:: https://codeclimate.com/github/iterative/dvc/badges/gpa.svg :target: https://codeclimate.com/github/iterative/dvc :alt: Code Climate

.. |Python Version| image:: https://img.shields.io/pypi/pyversions/dvc :target: https://pypi.org/project/dvc :alt: Python Version

.. |Coverage| image:: https://codecov.io/gh/iterative/dvc/branch/main/graph/badge.svg :target: https://codecov.io/gh/iterative/dvc :alt: Codecov

.. |Snap| image:: https://img.shields.io/badge/snap-install-82BEA0.svg?logo=snapcraft :target: https://snapcraft.io/dvc :alt: Snapcraft

.. |Choco| image:: https://img.shields.io/chocolatey/v/dvc?label=choco :target: https://chocolatey.org/packages/dvc :alt: Chocolatey

.. |Brew| image:: https://img.shields.io/homebrew/v/dvc?label=brew :target: https://formulae.brew.sh/formula/dvc :alt: Homebrew

.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/dvc.svg?label=conda&logo=conda-forge :target: https://anaconda.org/conda-forge/dvc :alt: Conda-forge

.. |PyPI| image:: https://img.shields.io/pypi/v/dvc.svg?label=pip&logo=PyPI&logoColor=white :target: https://pypi.org/project/dvc :alt: PyPI

.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/dvc.svg?color=blue&label=Downloads&logo=pypi&logoColor=gold :target: https://pypi.org/project/dvc :alt: PyPI Downloads

.. |Packages| image:: https://img.shields.io/badge/deb|pkg|rpm|exe-blue :target: https://dvc.org/doc/install :alt: deb|pkg|rpm|exe

.. |DOI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.3677553-blue.svg :target: https://doi.org/10.5281/zenodo.3677553 :alt: DOI

.. |Flowchart| image:: https://dvc.org/img/flow.gif :target: https://dvc.org/img/flow.gif :alt: how_dvc_works

.. |Contribs| image:: https://contrib.rocks/image?repo=iterative/dvc :target: https://github.com/iterative/dvc/graphs/contributors :alt: Contributors

.. |VS Code| image:: https://img.shields.io/visual-studio-marketplace/v/Iterative.dvc?color=blue&label=VSCode&logo=visualstudiocode&logoColor=blue :target: https://marketplace.visualstudio.com/items?itemName=Iterative.dvc :alt: VS Code Extension