Live()

Initializes a DVCLive logger.

class Live:

    def __init__(
        self,
        dir: str = "dvclive",
        resume: bool = False,
        report: Optional[str] = None,
        save_dvc_exp: bool = True,
        dvcyaml: Union[str, bool] = "dvc.yaml",
        cache_images: bool = False,
        exp_name: Optional[str] = None,
        exp_message: Optional[str] = None,
    ):

Usage

from dvclive import Live

with Live() as live:
    ...

Description

A Live() instance is required in order to log machine learning parameters, metrics and other metadata.

Live() will remove all existing DVCLive related files under dir unless resume=True.

You can use Live() as a context manager. When exiting the context manager, Live.end() will be called.

Properties

step - See Live.next_step().
summary - See Live.make_summary().
dir - Location of the directory to store outputs.
dvc_file - Path for dvc.yaml file.
metrics_file - {Live.dir}/metrics.json.
params_file - {Live.dir}/params.yaml.
plots_dir - {Live.dir}/plots.
report_file - {Live.dir}/report.{format}. The format can be HTML (.html) or Markdown (.md) depending on the value of the report parameter.

Parameters

dir - Where to save DVCLive's outputs. Defaults to dvclive.
resume - If True, DVCLive will try to read the previous step from the metrics_file and start from that point. Defaults to False.
report - Any of html, notebook, md or None. See Live.make_report(). Defaults to None.
save_dvc_exp - If True , DVCLive will create a new DVC experiment as part of Live.end(). Defaults to True.

If you are using DVCLive inside a DVC Pipeline and running with dvc exp run, the option will be ignored.
dvcyaml - Where to write dvc.yaml file, which adds DVC configuration for metrics, plots, and parameters as part of Live.next_step() and Live.end(). If None, no dvc.yaml file is written. Defaults to dvc.yaml. See Live.make_dvcyaml().

If a string like subdir/dvc.yaml, DVCLive will write the configuration to that path (file must be named dvc.yaml).

If False, DVCLive will not write to dvc.yaml (useful if you are tracking DVCLive metrics, plots, and parameters independently and want to avoid duplication).
cache_images - If True, DVCLive will cache any images logged with Live.log_image() as part of Live.end(). Defaults to False.

If running a DVC pipeline, cache_images will be ignored, and you should instead cache images as pipeline outputs.
exp_name - If not None, and save_dvc_exp is True, the provided string will be passed to dvc exp save --name.

If DVCLive is used inside dvc exp run, the option will be ignored, use dvc exp run --name instead.
exp_message - If not None, and save_dvc_exp is True, the provided string will be passed to dvc exp save --message.

If DVCLive is used inside dvc exp run, the option will be ignored, use dvc exp run --message instead.