Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restyle live: markdown report support. #3863

Merged
merged 1 commit into from
Aug 4, 2022
Merged

Restyle live: markdown report support. #3863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/docs/dvclive/api-reference/live/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ other metadata.

</admon>

- `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.

Expand Down
3 changes: 1 addition & 2 deletions content/docs/dvclive/api-reference/live/make_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
3 changes: 1 addition & 2 deletions content/docs/dvclive/get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<admon type="info">

Expand Down