Skip to main content

Metric logger for ML projects.

Project description

DVCLive

GHA Tests Codecov Donate

PyPI

DVCLive is an open-source library for monitoring the progress of metrics during training of machine learning models. It’s built with Git and MLOps principles in mind:

  1. Codification of data. Tracked metrics are stored in readable text files that can be versioned by Git or other version control tools.

  2. Distributed. No services or servers are required. Metrics are stored in a Git repository as text files, or pointers to files in DVC storage.

  3. GitOps API. Plots are generated through DVC using Git commit SHAs or branch names, e.g.: dvc plots diff --target logs master.

https://dvc.org/static/cdc4ec4dabed1d7de6b8606667ebfc83/9da93/dvclive-diff-html.png
  1. Automation. DVCLive metrics are easy to use by any automation, DevOps, or MLOps tool such as CI/CD (including CML), custom scripts, or ML platforms.

DVCLive integrates seamlessly with DVC; the logs/summaries it produces can be fed as dvc plots/dvc metrics.

However, DVC is not required to work with dvclive logs/summaries, and since they’re saved as easily parsable .tsv/.json files, you can use your preferred visualization method.

Quick Start

Please read the Get Started for a detailed version.

DVCLive is a Python library. The interface consists of three main steps:

  1. Initialize DVCLive

from dvclive import Live

live = Live()
  1. Log metrics

live.log("metric", 1)
  1. Increase the step number

live.next_step()

If you are ussing a ML training framework, check the existing ML Frameworks page.

Installation

pip (PyPI)

PyPI

pip install dvclive

Depending on the ML framework you plan to use to train your model, you might need to specify one of the optional dependencies: mmcv, tf, xgb. Or all to include them all. The command should look like this: pip install dvclive[tf] (in this case TensorFlow and it’s dependencies will be installed automatically).

To install the development version, run:

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

Call to collaboration

Today only Python is supported (while DVC is language agnostic), along with the following ML frameworks:

The DVCLive team is happy to extend the functionality as needed. Please create an issue or check the existing ones to start a discussion!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dvclive-0.4.2.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dvclive-0.4.2-py2.py3-none-any.whl (25.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file dvclive-0.4.2.tar.gz.

File metadata

  • Download URL: dvclive-0.4.2.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for dvclive-0.4.2.tar.gz
Algorithm Hash digest
SHA256 661f6e8edcb91618fc29303129514b6d745975eec297150807f44222b36a04ef
MD5 c17bdd041696f7ca4216d989cf48c41c
BLAKE2b-256 83a19c6ba78dfeb6230dcc2d8fde32a99a15db9cf29ca61fbf363d0fa0aca0ef

See more details on using hashes here.

File details

Details for the file dvclive-0.4.2-py2.py3-none-any.whl.

File metadata

  • Download URL: dvclive-0.4.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 25.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for dvclive-0.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0a9c0595d5125dc4f66cf78b69f83e04ebe97d9cac0b278403f00f74c6f4b5a9
MD5 6dd72a32c6be015209742420c8b18d86
BLAKE2b-256 626d31b3f97db1ce74f807e7ca755fd2c28ba8a8191cc220a6d793857b054e06

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page