Live()
初始化一个 DVCLive 日志记录器。
class Live:
def __init__(
self,
dir: str = "dvclive",
resume: bool = False,
report: Literal["md", "notebook", "html", None] = None,
save_dvc_exp: bool = True,
dvcyaml: Optional[str] = "dvc.yaml",
cache_images: bool = False,
exp_name: Optional[str] = None,
exp_message: Optional[str] = None,
monitor_system: bool = False,
):用法
from dvclive import Live
with Live() as live:
...描述
要记录机器学习参数、指标和其他元数据，必须使用 Live() 实例。
除非 resume=True，否则 Live() 会删除 dir 下所有与 DVCLive 相关的文件。
你可以将 Live() 用作上下文管理器。退出上下文管理器时，将自动调用 Live.end()。
属性
-
step- 请参见Live.next_step()。 -
summary- 请参见Live.make_summary()。 -
dir- 存储 输出 的目录路径。 -
dvc_file-dvc.yaml文件的路径。 -
metrics_file-{Live.dir}/metrics.json。 -
params_file-{Live.dir}/params.yaml。 -
plots_dir-{Live.dir}/plots。 -
report_file-{Live.dir}/report.{format}。其中format可为 HTML（.html）或 Markdown（.md），具体取决于report参数的值。
参数
-
dir- 保存 DVCLive 输出的位置，默认为dvclive。 -
resume- 若为True，DVCLive 将尝试从metrics_file中读取上一次的step并从该点继续。默认为False。 -
report- 可选值为html、notebook、md或None。详见Live.make_report()。默认为None。 -
save_dvc_exp- 若为True，DVCLive 将在Live.end()执行时创建一个新的 DVC 实验。默认为True。若在 DVC 流水线 中使用 DVCLive 并通过
dvc exp run运行，则此选项将被忽略。 -
dvcyaml- 指定dvc.yaml文件的写入位置，该文件会在Live.next_step()和Live.end()中添加用于指标、图表和参数的 DVC 配置。若为None，则不写入dvc.yaml文件。默认为dvc.yaml。详见Live.make_dvcyaml()。若传入类似
subdir/dvc.yaml的字符串，DVCLive 将把配置写入该路径（文件必须命名为dvc.yaml）。若为
False，DVCLive 将不写入dvc.yaml（适用于你独立跟踪 DVCLive 的指标、图表和参数，以避免重复）。 -
cache_images- 若为True，DVCLive 将在Live.end()中缓存通过Live.log_image()记录的所有图像。默认为False。若运行 DVC 流水线，
cache_images将被忽略，应将图像作为流水线的 输出 进行缓存。 -
exp_name- 若不为None且save_dvc_exp为True，则提供的字符串将作为参数传递给dvc exp save --name。如果在
dvc exp run内部使用 DVCLive，该选项将被忽略，请改用dvc exp run --name。 -
exp_message— 如果不为None且save_dvc_exp为True，则提供的字符串将传递给dvc exp save --message。如果在
dvc exp run内部使用 DVCLive，该选项将被忽略，请改用dvc exp run --message。 -
monitor_system— 如果为True，DVCLive 将记录 系统指标，包括 GPU、CPU、RAM 和磁盘使用情况。默认值为False。