1.1.1

What's Changed

• _init_dvc: Skip experiment save if inside repo has stages. by @daavoo in #382
• update template by @dtrifiro in #386
• lightning: record actual training step by @dberenbaum in #383
• write out dvcyaml at each step with relevant outputs by @dberenbaum in #385
• lightning: log params by @dberenbaum in #388
• live.end: Don't increment step value. by @daavoo in #390

Full Changelog: 1.1.0...1.1.1

1.1.0: DVCLive experiments

DVCLive Experiments

Can be enabled by passing save_dvc_exp=True.

# foo.py
import random
from dvclive import Live

with Live(save_dvc_exp=True) as live:
    live.log_param("fooparam", random.random())
    for i in range(4):
        live.log_metric("foo", i * random.random())
        live.next_step()

When inside a DVC repository and DVC is available as a Python library, DVCLive will create a new DVC experiment as part of live.end (called on exit of context manager and inside the integrations with ML frameworks).

$ python foo.py
$ dvc exp show
 ───────────────────────────────────────────────────────────────── 
  Experiment                 Created        foo   step   fooparam  
 ───────────────────────────────────────────────────────────────── 
  workspace                  -          0.56773      4   0.20543   
  master                     03:45 PM         -      -   -         
  └── fbed990 [rowdy-vase]   07:25 PM   0.56773      4   0.20543   
 ───────────────────────────────────────────────────────────────── 
$ python foo.py
$ dvc exp show
 ───────────────────────────────────────────────────────────────── 
  Experiment                 Created        foo   step   fooparam  
 ───────────────────────────────────────────────────────────────── 
  workspace                  -           2.2236      4   0.65216   
  master                     03:45 PM         -      -   -         
  ├── 4ec327f [shock-weka]   07:25 PM    2.2236      4   0.65216   
  └── fbed990 [rowdy-vase]   07:25 PM   0.56773      4   0.20543   
 ───────────────────────────────────────────────────────────────── 

What's Changed

• Create DVC experiment on live.end. by @daavoo in #366
• fast.ai: Handle resuming. by @daavoo in #379

Full Changelog: 1.0.3...1.1.0

1.0.3

What's Changed

• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in #351
• report: Handle custom names used in sklearn_plots. by @daavoo in #372

Full Changelog: 1.0.2...1.0.3

1.0.2

What's Changed

• add bandit, a security linter by @skshetry in #363
• integration: dvc: test checkpoint file creation by @pared in #342
• frameworks: Call live.end at the end of training. by @daavoo in #364
• lightning: support report kwarg by @dberenbaum in #369

Full Changelog: 1.0.1...1.0.2

1.0.1

What's Changed

• [bug] lightning default dir integration fix by @shcheklein in #362

Full Changelog: 1.0...1.0.1

1.0.0

1.0

Breaking changes

• Changes to the structure of the output directory and where methods write to #322

Method	Before	Now
live.log_image	dvclive/images	dvclive/plots/images
live.log_metric	dvclive/scalars	dvclive/plots/metrics
live.log_sklearn_plot	dvclive/plots	dvclive/plots/sklearn
live.make_summary	dvclive.json	dvclive/summary.json

• live.log renamed to live.log_metric #343
• live.log_plot renamed to live.log_sklearn_plot #322
• Removed live.get_step() and live.set_step() in favor of live.step property. #357
• live.log_image No longer creates step subfolder. Instead overrides the previous step #331
  The subfolder structure can be still manually created:

for i in range(2):
    live.log_image(f"{live.step}/img.png", img)

• live.log_metric No longer calls live.make_summary #353
• live.log_sklearn_plot No longer raises error on step logging. Instead overrides previous step.
• Dropped support for live section in dvc.yaml #337

New Features

• Live can now be used as a context manager #354

with Live() as live:
    live.log_metric("foo", 0.1)

• New Live.summary can be used to add metrics directly to the summary #354

with Live() as live:
    for epoch in range(EPOCHS):
        live.log_metric("loss", 0.1)
    live.summary["additional_metric"] = 1.0

• Option to provide custom name for Live.log_sklearn_plot

live.log_sklearn_plot("confusion_matrix", y_true, y_pred, name="train/cm")

Full Changelog: 0.12.1...1.0

1.0 💥

1.0

Breaking changes

• Changes to the structure of the output directory and where methods write to #322

Method	Before	Now
live.log_image	dvclive/images	dvclive/plots/images
live.log_metric	dvclive/scalars	dvclive/plots/metrics
live.log_sklearn_plot	dvclive/plots	dvclive/plots/sklearn
live.make_summary	dvclive.json	dvclive/summary.json

• live.log renamed to live.log_metric #343
• live.log_plot renamed to live.log_sklearn_plot #322
• Removed live.get_step() and live.set_step() in favor of live.step property. #357
• live.log_image No longer creates step subfolder. Instead overrides the previous step #331
  The subfolder structure can be still manually created:

for i in range(2):
    live.log_image(f"{live.step}/img.png", img)

• live.log_metric No longer calls live.make_summary #353
• live.log_sklearn_plot No longer raises error on step logging. Instead overrides previous step.
• Dropped support for live section in dvc.yaml #337

New Features

• Live can now be used as a context manager #354

with Live() as live:
    live.log_metric("foo", 0.1)

• New Live.summary can be used to add metrics directly to the summary #354

with Live() as live:
    for epoch in range(EPOCHS):
        live.log_metric("loss", 0.1)
    live.summary["additional_metric"] = 1.0

• Option to provide custom name for Live.log_sklearn_plot

live.log_sklearn_plot("confusion_matrix", y_true, y_pred, name="train/cm")

Full Changelog: 0.12.1...1.0

0.12.1

What's Changed

• simplify/speedup catalyst tests by @skshetry in #327
• report: Don't set md if matplotlib is not installed. by @daavoo in #334

Full Changelog: 0.12.0...0.12.1

0.12.0

What's Changed

• pyproject: fix coverage config by @dtrifiro in #304
• cleanup log param by @dtrifiro in #307
• keras: add ability to pass live into callback by @shcheklein in #302
• Run safety only against real dvclive deps. by @daavoo in #314
• bump mypy to 0.981, enable recursive type aliases by @dtrifiro in #308
• Update catalyst integration for >22. by @daavoo in #313
• Add post_to_studio by @daavoo in #297
• live: get rid of ParameterAlreadyLoggedError by @dtrifiro in #316
• Add ability to pass logger instance to frameworks by @shcheklein in #318
• integrations: lightning: migrate to simpler model by @pared in #319
• report: Add table for params by @daavoo in #320
• tests: Simplify huggingface tests. by @daavoo in #321

New Contributors

• @shcheklein made their first contribution in #302

Full Changelog: 0.11.0...0.12.0

0.11.0: Use py-template and add `log_param`

What's Changed

• lightning: Update test. by @daavoo in #276
• tests: Remove hardcoded name by @daavoo in #275
• readme: remove donate badge by @skshetry in #280
• use py-template by @dtrifiro in #281
• data: Don't use with_suffix in output_path. by @daavoo in #285
• template: fix cruft.json by @skshetry in #294
• update template by @github-actions in #295
• Bump lightning by @daavoo and @avKostanov in #296
• add log_param/log_params by @dtrifiro in #292
• integrations: fastai speed up tests by @pared in #301
• gha: pin 3.10 to 3.10.6 by @dtrifiro in #303

New Contributors

• @skshetry made their first contribution in #274
• @dtrifiro made their first contribution in #281
• @avKostanov made their first contribution in #296

Full Changelog: 0.10.0...0.11.0