dvclive: docs for log_param/log_params #3994
Conversation
dtrifiro
added
A: docs
Link Check Report
All 3 links passed! |
dtrifiro
force-pushed
the
dvclive-log-params
branch
from
5f3180f to
7dcfcaf
Compare
| @@ -38,6 +38,9 @@ other metadata. | |||
| - `dir` - Location of the directory to store | |||
| [outputs](/doc/dvclive/get-started#outputs). | |||
|
|
|||
| - `params_path` - `{Live.params_path}`. Location of the parameters logged via | |||
| [`log_param`](/doc/dvclive/api-reference/live/log_param#description)/[`log_params`](/doc/dvclive/api-reference/live/log_params#description). | |||
|
|
|||
| - `summary_path` - `{Live.dir}.json`. Location of the | |||
There was a problem hiding this comment.
cc @daavoo Should this be called a "metrics summary" now to distinguish from params? Should we update the attribute name?
There was a problem hiding this comment.
+1
Maybe we should also consider rethinking the summary/report names, they're somehow similar and it can be confusing
There was a problem hiding this comment.
Commented in iterative/dvclive#246
dtrifiro
force-pushed
the
dvclive-log-params
branch
from
7dcfcaf to
1db6995
Compare
Link Check ReportThere were no links to check!
|
dtrifiro
force-pushed
the
dvclive-log-params
branch
from
1db6995 to
ff9e808
Compare
|
@dtrifiro Let me know when it's ready for another review, thanks! |
|
@dberenbaum ready for review |
dtrifiro
force-pushed
the
dvclive-log-params
branch
from
ff9e808 to
e92a37a
Compare
dtrifiro
force-pushed
the
dvclive-log-params
branch
from
e92a37a to
46657cc
Compare
dtrifiro
force-pushed
the
dvclive-log-params
branch
from
46657cc to
8bc9477
Compare
| - `Live.get_step()` | ||
| - `Live.log()` | ||
| - `Live.log_image()` | ||
| - `Live.log_param()` | ||
| - `Live.log_params()` | ||
| - `Live.log_plot()` | ||
| - `Live.make_report()` | ||
| - `Live.get_step()` |
There was a problem hiding this comment.
Why was get_step moved up? (Differs from the order in sidebar.json)
There was a problem hiding this comment.
I think it was made alphabetical, but good catch that it doesn't match the sidebar. If you're fine with it, we can update the sidebar also. Probably easier for users to find things that way than trying to guess some order of importance.
There was a problem hiding this comment.
Sure up to you. I was just pointing out a possible discrepancy I saw.
documentation for
log_param/log_params(iterative/dvclive#292)