Initializes a DVCLive logger.
class Live:
def __init__(
self,
path: Optional[str] = None,
resume: bool = False,
report: Optional[str] = "html",
):
from dvclive import Live
live = Live()
A Live()
instance is required in order to log machine learning metrics and
other metadata.
Live()
will remove all existing DVCLive related files under path
unless
resume=True
.
dir
- Location of the directory to store
outputs.
summary_path
- {dir}.json
. Location of the
summary.
html_path
- {dir}/report.html
. Location of the
html report.
path
- Where to save DVCLive's outputs. Default: None
.
If None
and DVC is enabled (see
DVCLive with DVC), the path
set by DVC
will be used. If None
and DVC is not enabled, "dvclive"
will be used.
resume
- If True
, DVCLive will try to read the previous step
from the
path
directory and start from that point. Default: False
.
If you are not using steps, don't set resume=True
since DVCLive will
preserve previous run's files and assume that step
has been enabled.
report
- If html
, DVCLive will call Live.make_report()
on each step
update. Default: html
.
auto_open
- If True
, on the first Live.make_report()
call, DVCLive will
automatically open html_path
in a browser. Default: False
.