docs/studio: top-level plots #4121
Conversation
Link Check ReportThere were no links to check! |
There was a problem hiding this comment.
Thanks @ssachkovskaya. I've included top-level plots in the example snippet and updated the text a bit. PTAL.
tapadipti
added
the
C: studio
content/docs/studio/user-guide/projects-and-experiments/visualize-and-compare.md
Outdated
Show resolved
Hide resolved
content/docs/studio/user-guide/projects-and-experiments/visualize-and-compare.md
Outdated
Show resolved
Hide resolved
content/docs/studio/user-guide/projects-and-experiments/visualize-and-compare.md
Outdated
Show resolved
Hide resolved
| directly, | ||
| - data from `runtime_logs/logs.json` will be rendered using the default (linear) | ||
| template. |
There was a problem hiding this comment.
| directly, | |
| - data from `runtime_logs/logs.json` will be rendered using the default (linear) | |
| template. | |
| 2. Images in `output/misclassified_samples` will be displayed directly (a single | |
| image file could be used instead). |
There was a problem hiding this comment.
@jorgeorpinel I didn't make this change as it's not clear a single image file could be used instead "of what?".
There was a problem hiding this comment.
Instead of "Images in output/misclassified_samples". Could also rephrase that to "in the output/misclassified_samples directory", if that's clearer.
| For images, you can also specify a single image file (eg, | ||
| `output/misclassified_sample1.png`) instead of a directory. | ||
|
|
There was a problem hiding this comment.
| For images, you can also specify a single image file (eg, | |
| `output/misclassified_sample1.png`) instead of a directory. |
There was a problem hiding this comment.
Didn't change this. Pls see above comment.
Even with the simplifications I proposed, this doc mainly documents DVC. We could probably remove everything after the numbered list of Types of plots and before How to generate plots.
I see a link to https://dvc.org/doc/command-reference/plots in the doc. Should probably go here instead: https://dvc.org/doc/user-guide/experiment-management/visualizing-plots |
|
Q: what's special about flexible plots in Studio? Does it bring new UI features, screens, etc? Also, are we going to call them "flexible" ? I think it makes more sense in Studio docs as "top-level" refers to how you define them in |
@jorgeorpinel could you pls elaborate what "flexible" means here. Then, we can decide on this. In one discussion I had with @pared, "top-level" was the decided term. |
|
@tapadipti I think that the point of moving the plots definition to the top-level of dvc.yaml (which is an implementation detail) is that you can be more flexible with the data sources. See iterative/dvc#7086, iterative/example-repos-dev#117, et al. BTW, I think the plan is to face out stage-level plot definitions so we probably won't even need the term "flexible" eventually, maybe we can completely avoid special terms in Studio docs, and we can just call them all plots (and link to DVC docs for the details). That said, what's special about flexible plots in Studio? I'm still trying to understand why we're documenting this DVC feature in Studio docs. |
Nothing special about it here, afaik. We're documenting it here so that people understand how they need to codify their plots in dvc if they want to visualize them in Studio. All DVC features that are directly relevant to Studio are documented to some extend in the Studio docs, and we redirect users to the dvc docs for more details. |
|
@jorgeorpinel I'm merging this PR, since the feature has been live in Studio for quite some time now. If there are more pending issues, we can address them in a separate PR. |
|
@tapadipti my main pending concern is that I think we may not need to document this DVC feature in Studio at all. We can just mention plots, where they can come from and maybe how flexible they can be, and then link to https://dvc.org/doc/user-guide/project-structure/dvcyaml-files#plots for formalities. I also think the qualifier "top-level" has very little meaning in the context of Studio, let's just call them all plots regardless of how DVC codified them? |
Related to https://github.com/iterative/studio/issues/4369
@tapadipti I decided not to add lots of text about the feature as it is already described in DVC in details. The idea is to mention that it is supported by Studio and give a link to the description.