live: markdown report support. #3856
Conversation
|
Only added "API Reference" updates. Not sure (if) how to document the full "Live metrics" scenario with CML. |
Link Check Report
All 4 links passed! |
| - `dir` - Location of the directory to store | ||
| [outputs](/doc/dvclive/get-started#outputs). | ||
|
|
||
| - `summary_path` - `{dir}.json`. Location of the | ||
| - `summary_path` - `{Live.dir}.json`. Location of the | ||
| [summary](/doc/dvclive/api-reference/live/log#description). |
There was a problem hiding this comment.
Hola. Why this change? Was just dir incorrect? It's listed as just dir above. Same Q applies to a bunch of other changes here.
Seems unrelated to iterative/dvclive#266 too.
There was a problem hiding this comment.
{dir} and {path} were being used inconsistently across docs. I wanted to consolidate a single one.
Here, the dir definition it's right above, but in the other references that context doesn't exist and I wanted to emphasize that it refers to the dir property of the Live class. So I went with Live.dir.
There was a problem hiding this comment.
Seems unrelated to iterative/dvclive#266 too.
It has nothing to do, just something I noticed during this P.R. Could be extracted to other
| - `auto_open` - If `True`, on the first `Live.make_report()` call, DVCLive will | ||
| automatically open `html_path` in a browser. _Default_: `False`. |
There was a problem hiding this comment.
Wait what happened to auto_open?
There was a problem hiding this comment.
Docs were outdated. I just noticed this was still here during this P.R.
It was removed a few versions ago, discussion here iterative/dvclive#241
Co-authored-by: Jorge Orpinel <[email protected]>
Co-authored-by: Jorge Orpinel <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
|
@jorgeorpinel merging the current state. If there are any suggestions left, please comment and I will address them in a follow-up |
| @@ -1,6 +1,6 @@ | |||
| # Live.make_report() | |||
|
|
|||
| Generates an HTML Report from the logged data. | |||
| Generates a metrics report from the logged data. | |||
There was a problem hiding this comment.
should we say "metrics & plots?"
| [html report](/doc/dvclive/api-reference/live/make_report#description). | ||
| - `report_path` - `{Live.dir}/report.{format}`. Location of the | ||
| [metrics report](/doc/dvclive/api-reference/live/make_report). The `format` | ||
| can be HTML) or Markdown depending on the value of the `report` parameter. |
| 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` |
| @@ -62,11 +63,11 @@ other metadata. | |||
|
|
|||
| </admon> | |||
|
|
|||
| - `report` - If `html`, DVCLive will call `Live.make_report()` on each step | |||
| update. _Default_: `html`. | |||
| - `report` - If `auto`,`html`, or `md`, DVCLive will call `Live.make_report()` | |||
There was a problem hiding this comment.
missing space after comma
| @@ -113,16 +113,16 @@ The [metrics summary](/doc/dvclive/api-reference/live/log#description) in | |||
| The [metrics history](/doc/dvclive/api-reference/live/log#step-updates) | |||
| `training_metrics/scalars` can be visualized with `dvc plots`. | |||
|
|
|||
| The [HTML report](/doc/dvclive/api-reference/live/make_report#description) in | |||
| The [metrics report](/doc/dvclive/api-reference/live/make_report) in | |||
| If you don't update the step number, the report won't be generated unless you | ||
| call `Live.make_report()` directly. |
There was a problem hiding this comment.
lots of double negatives; hard to follow. Maybe "Reports are generated if you update the step number or call Live.make_report() directly."
| @@ -109,17 +109,20 @@ not. | |||
|
|
|||
| See `Live.log()`, `Live.log_image()` and `Live.log_plot()` for more details. | |||
|
|
|||
| ### HTML report | |||
| ### Metrics report | |||
|
|
||
|  | ||
|
|
||
| The `format` can be HTML) or Markdown depending on the value of the `report` |
| If you don't update the step number, the report won't be generated unless you | ||
| call `Live.make_report()` directly. |
There was a problem hiding this comment.
"Reports are generated if you update the step number or call Live.make_report() directly."
jorgeorpinel
added
A: docs
|
Did you have a chance to follow-up on @casperdcl's comments @daavoo ? Maybe you can include any updates that still apply to #3923. |
I will include the updates there |
|
Thank you! |
Per iterative/dvclive#266