2.7.0: `artifacts` section.

New Features

artifacts section

You can now pass metadata to Live.log_artifact that will be written to a new artifacts section in the dvc.yaml located at {Live.dir}/{Live.dvc_file}.

Available metadata fields are:

type: Optional[str] = None,
name: Optional[str] = None,
desc: Optional[str] = None,
labels: Optional[List[str]] = None,
meta: Optional[Dict[str, Any]] = None,

When passing type="model", the artifact will be identified by Studio and automatically included in the Studio Model Registry.

• Example

from pathlib import Path
from dvclive import Live

Path("model.pth").write_text("foo")

with Live(save_dvc_exp=True) as live:
    live.log_artifact(
        "model.pth",
        type="model",
        name="mymodel",
        desc="Finetuned ResNet50",
    )

# dvclive/dvc.yaml
artifacts:
  mymodel:
    path: ../model.pth
    type: model
    desc: Finetuned ResNet50

Auto-initialization of DVC Repo

When inside a non-empty Git Repository, DVCLive will auto-initialize a DVC Repository when needed.

What's Changed

• Add DVCLive-Quickstart by @daavoo in #530
• studio: Support DVC_ env vars. by @daavoo in #533
• Support artifacts section by @daavoo in #521
• feat(sklplots): add confusion matrix normalized option by @shcheklein in #538
• revert get_dvc_stage_template by @dberenbaum in #540
• Auto-initialize DVC repo by @dberenbaum in #539

New Contributors

• @dependabot made their first contribution in #503

Full Changelog: 2.6.4...2.7.0

2.6.4

What's Changed

• Maintenance by @daavoo in #527
• Update README by @daavoo in #528
• studio: Save experiment before posting done event. by @daavoo in #529

Full Changelog: 2.6.3...2.6.4

2.6.3

What's Changed

• Support path to an image in log_image by @shcheklein in #518

Full Changelog: 2.6.2...2.6.3

2.6.2

What's Changed

• live: Be more conservative when git adding paths inside dvc exp run. by @daavoo in #517

Full Changelog: 2.6.1...2.6.2

2.6.1

What's Changed

• optuna: Use summary instead of log_metric. by @daavoo in #514

Full Changelog: 2.6.0...2.6.1

2.6.0

What's Changed

• report: Use base64 images for HTML. by @daavoo in #508
• live: Track self._dir when self._inside_dvc_exp. by @daavoo in #511
• make_dvcyaml: Include metrics section also if live.summary. by @daavoo in #512

Full Changelog: 2.5.1...2.6.0

2.5.1: Require `exp` for Studio updates

What's Changed

• remove dvclive outputs from dvc stage outs by @dberenbaum in #506
• live: Explicitly require exp for sending Studio updates. by @daavoo in #507

Full Changelog: 2.5.0...2.5.1

2.5.0: Optuna callback

New features

dvclive.optuna

import optuna
from dvclive.optuna import DVCLiveCallback

def objective(trial):
    x = trial.suggest_float("x", -10, 10)
    return (x - 2) ** 2

study = optuna.create_study()

study.optimize(
    objective, n_trials=7, callbacks=[DVCLiveCallback()])

What's Changed

• log stage template by @dberenbaum in #497
• Added Optuna callback. by @daavoo in #356
• frameworks: Use log_artifact. by @daavoo in #500

Full Changelog: 2.4.0...2.5.0

2.4.0: `Live.log_artifact`

New features

Live.log_artifact

Tracks an existing directory or file with DVC.

https://dvc.org/doc/dvclive/api-reference/live/log_artifact

What's Changed

• Implement log_artifact method for live by @karajan1001 in #464
• replaces utils functions with funcy by @dberenbaum in #493
• add ruamel.yaml dep by @dberenbaum in #496
• studio: Send paths relative to self._dvc_repo.root_dir. by @daavoo in #502

New Contributors

• @karajan1001 made their first contribution in #464

Full Changelog: 2.3.1...2.4.0

2.3.1

What's Changed

• lightning: prevent conflict with internal step property. by @daavoo in #490

Full Changelog: 2.3.0...2.3.1