API Reference

This reference provides the details about the dvclive Python API module, which can be imported regularly, for example:

from dvclive import Live

Basic Workflow

Initialize DVCLive

with Live(save_dvc_exp=True) as live:

See Live() for details.

Log data

live.log_param("num_classes", 10)

params = {
    "num_classes": 10,
    "metrics": ["accuracy", "mae"],
    "optimizer": "adam"
}
live.log_params(params)

live.log_metric("acc", 0.9)

img = np.ones((500, 500, 3), np.uint8)
live.log_image("image.png", img)

y_true = [0, 0, 1, 1]
y_pred = [0.2, 0.5, 0.3, 0.8]
live.log_sklearn_plot("roc", y_true, y_score)

(Optionally) Update the step number

live.next_step()

See Live.next_step().

Under the hood, Live.next_step() calls Live.make_summary() and Live.make_report().

If you want to decouple the step update from the rest of the calls, you can manually modify the Live.step property and call Live.make_summary() / Live.make_report().

Putting it all together

Joining the above snippets, you can include DVCLive in your training code:

# train.py

from dvclive import Live

with Live(save_dvc_exp=True) as live:

    live.log_param("epochs", NUM_EPOCHS)

    for epoch in range(NUM_EPOCHS):
        train_model(...)
        metrics = evaluate_model(...)

        for metric_name, value in metrics.items():
            live.log_metric(metric_name, value)

        live.next_step()

Outputs

After you run your training code, all the logged data will be stored in the dvclive directory. Check the DVCLive outputs page for more details.