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.

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

dvc: Deprecation of live section. #225

Closed
6 tasks done
Tracked by #223
daavoo opened this issue Mar 3, 2022 · 0 comments
Closed
6 tasks done
Tracked by #223

dvc: Deprecation of live section. #225

daavoo opened this issue Mar 3, 2022 · 0 comments
Labels
A: frameworks Area: ML Framework integration

Comments

@daavoo
Copy link
Contributor

daavoo commented Mar 3, 2022

Motivation

Having a separate section named live can create confusion when introducing DVCLive to users already familiar with metrics and plots.

Apart from tracking the metrics and plots generated by DVCLive, the live section is used internally to potentially configure DVCLive (i.e. summary ) and generate an HTML report.

The configuration of the Live Python object through dvc.yaml results in having 2 ways of doing the same thing and can cause errors among users. Given that there are no internal reasons to configure the Live object through dvc.yaml, the removal of the live section would result in having a single source of truth for configuring DVCLive (the Python code).

Given that summary has been removed (#217), if the HTML generation is decoupled from the dvc.yaml and instead moved to DVCLive, the live section could be replaced with the existing metrics and plots sections without losing any features.

This would simplify the integration between DVC and DVCLive and reduce the friction for introducing DVCLive to users already familiar metrics and plots


Implementation

Replace:

stages:
  train:
    cmd: python train.py
    deps:
      - train.py
    live:
      training_metrics:
        summary: true
        html: true

With:

stages:
  train:
    cmd: python train.py
    deps:
      - train.py
    metrics:
      - dvclive.json:
          cache: false
    plots:
      - dvclive/scalars:
          cache: false
      - dvclive/images

Tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: frameworks Area: ML Framework integration
Projects
None yet
Development

No branches or pull requests

1 participant