diff --git a/content/docs/dvclive/api-reference/live/index.md b/content/docs/dvclive/api-reference/live/index.md index 3fc26b521c..10995487f5 100644 --- a/content/docs/dvclive/api-reference/live/index.md +++ b/content/docs/dvclive/api-reference/live/index.md @@ -63,9 +63,9 @@ other metadata. -- `report` - If `auto`,`html`, or `md`, DVCLive will call `Live.make_report()` on - each step update. The `auto` mode (default) will use `md` format if a `CI` env - var is present, otherwise it will use `html`. +- `report` - If `auto`,`html`, or `md`, DVCLive will call `Live.make_report()` + on each step update. The `auto` mode (default) will use `md` format if a `CI` + env var is present, otherwise it will use `html`. If `report` is `None`, `Live.make_report()` won't be called automatically. diff --git a/content/docs/dvclive/api-reference/live/make_report.md b/content/docs/dvclive/api-reference/live/make_report.md index b8cae003ba..3d8075e884 100644 --- a/content/docs/dvclive/api-reference/live/make_report.md +++ b/content/docs/dvclive/api-reference/live/make_report.md @@ -22,8 +22,7 @@ On each call, DVCLive will collect all the data logged in `{Live.dir}`, generate a report and save it in `{Live.dir}/report.{format}`. The `format` can be HTML) or Markdown depending on the value of the `report` -argument passed to -[`Live()`](/doc/dvclive/api-reference/live#parameters). +argument passed to [`Live()`](/doc/dvclive/api-reference/live#parameters). ![](/img/dvclive-html.gif) diff --git a/content/docs/dvclive/get-started.md b/content/docs/dvclive/get-started.md index 5bbbfec3f9..c3398ad339 100644 --- a/content/docs/dvclive/get-started.md +++ b/content/docs/dvclive/get-started.md @@ -117,8 +117,7 @@ If and when `step` is updated, DVCLive generates or updates a report in ![](/img/dvclive-html.gif) The `format` can be HTML) or Markdown depending on the value of the `report` -argument passed to -[`Live()`](/doc/dvclive/api-reference/live#parameters). +argument passed to [`Live()`](/doc/dvclive/api-reference/live#parameters).