dvclive: Document more monitoring options #4306
Conversation
Link Check ReportThere were no links to check! |
| [Studio Live Experiments](/doc/studio/user-guide/projects-and-experiments/live-metrics-and-plots), | ||
| DVCLive updates will be displayed in the Studio UI: | ||
|
|
||
|  |
There was a problem hiding this comment.
The live metrics line in the plot in this gif starts at step 9. I think that the live update of this line would be clearer to the user if it started at 3rd or 4th step and continued for another 3-4 steps.
Also, my understanding is that we should upload all the images/gifs used in the docs to the static repo. Don't we use that for the DVCLive docs assets?
There was a problem hiding this comment.
The live metrics line in the plot in this gif starts at step 9. I think that the live update of this line would be clearer to the user if it started at 3rd or 4th step and continued for another 3-4 steps.
👍 will update
Also, my understanding is that we should upload all the images/gifs used in the docs to the static repo. Don't we use that for the DVCLive docs assets?
I was not aware of that. Previously (and this P.R) I added images to https://github.com/iterative/dvc.org/tree/main/static/img . Did something change? Where is the process described?
There was a problem hiding this comment.
Did something change? Where is the process described?
In my very first docs PR, @casperdcl made this suggestion here and here. I believe it was discussed and decided prior to that.
There was a problem hiding this comment.
There was a problem hiding this comment.
@jorgeorpinel Can you weigh in about how to add images? I've also never heard of this before 😅 .
There was a problem hiding this comment.
not sure what the current status is either. AFAIK (at least in https://iterative.ai/blog) we "do the right thing" and use DVC for the images.
There was a problem hiding this comment.
We only add images via DVC in the blog on iterative.ai, all docs images are generally popped into the repo plainly under the /static/img directory. Almost certainly not best practice, but until we get the process fully sorted out in the blog we've opted not to change things for other images since the blog easily has the lion's share of images and much more capacity to grow.
jorgeorpinel
changed the title
jorgeorpinel
added
A: docs
|
Very cool. Lmk if you need an approval, thanks @daavoo ! |
daavoo
changed the title
content/docs/dvclive/get-started.md
Outdated
|
|
||
| </tab> | ||
|
|
||
| <tab title="CML"> |
There was a problem hiding this comment.
cc @casperdcl I think this is the first mention ever in the docs for the "DVCLive + CML" use case
There was a problem hiding this comment.
Isn't matplotlib required? Do we document that anywhere?
There was a problem hiding this comment.
Also, I think it's the most complex and narrow scenario. Should we move it to the last tab?
There was a problem hiding this comment.
Isn't matplotlib required? Do we document that anywhere?
In https://dvc.org/doc/dvclive/api-reference/live#parameters . I also added a mention inside the tab
There was a problem hiding this comment.
Also, I think it's the most complex and narrow scenario. Should we move it to the last tab?
Done
|
LGTM! Should we also document the different modes more in the API ref under the |
notebookfrom report: Addnotebookmode. dvclive#432