Refactor plots #3994
Refactor plots #3994
Conversation
- separate data collection and rendering - provide a way to use custom template loader - drop hard-coding datafiles in template feature
| def _plot_props(out): | ||
| if not out.plot: | ||
| raise DvcException( | ||
| f"'{out}' is not a plot. Use `dvc plots modify` to change that." |
There was a problem hiding this comment.
plots modify can change a file that is not a plot into a plot? Or maybe I don't understand this message.
There was a problem hiding this comment.
OK thanks. What I meant is that I didn't understand what the sentence meant. Thinking about it now I think I get it: a regular output is being given to a plots command right? And you can make it into a plot with plots modify. So 2 things:
- I recommend something like this for message for now:
"'{out}' is found in stage '{stg}' as an output but not as a plot. You can make it into a plot with `plots modify ...` - Actually, what's the command to make an output into a plot with plots modify? I'd like to document this feature.
- Why not just try to plot the output instead and throw a formatting error if it's not valid?
Thanks
There was a problem hiding this comment.
- Too long, and not any useful information than the one provided already.
dvc plots modify output-file-name-that-is-not-a-plot.file_ext
You can provide any other flags on the same command, like--templatetoo.
There was a problem hiding this comment.
The existing string is hard to read and understand. Can we come up with a better suggestion if mine isn't liked? "to change that" to change what?
There was a problem hiding this comment.
E.g. The given output file is not a known plot. Use `dvc plots modify {out}` to turn it into one.
p.s. why is it bad that a message to the user is relatively long? (2 sentences)
There was a problem hiding this comment.
Also, can plots modify make ANY file into a plot, or only other outputs? What about existing metrics?
Does it validate plot file format?
Thanks
There was a problem hiding this comment.
p.s. why is it bad that a message to the user is relatively long? (2 sentences)
The longer the message the smaller percentage of people will read it.
Also, can plots modify make ANY file into a plot, or only other outputs?
Only outputs. In current dvc-file design only outputs may become metrics or plots. Metric might become a plot. Not sure whether it will stop being a metric.
Does it validate plot file format?
No. dvc run doesn't validate it either. Strictly speaking we don't have such thing as validation here, we can check whether loading it results in an error though.
There was a problem hiding this comment.
The longer the message the smaller percentage of people will read it.
Arguable. But if the text is hard to understand, it doesn't matter how many people read it. I guess I'll just sent a PR with a suggested text instead of arguing here.
Thanks for the other info. TBH it seems a little obscure/ arbitrary behavior but I'm not opposed to it. I just think it would be best to re-think it. Not really my realm so I'll just ping @shcheklein and @efiop here 🙂
dvc run doesn't validate it... we can check whether loading it results in an error
Please note that coincidentally, I opened an issue about this (not related to this conversation originally): #4068
* plot: link to cmd ref in output * plots: change non-plot output error msg per #3994 (comment) * Update dvc/repo/plots/__init__.py Co-authored-by: Ruslan Kuprieiev <kupruser@gmail.com> Co-authored-by: Ruslan Kuprieiev <kupruser@gmail.com>
Closes #3818.