plots: document images support #2839

pared · 2021-09-20T17:21:54Z

What we need to document:

images support
plots modify will not have an effect on image plots (not restricting it as we support dirs, which can have mixed content)

closes #2807

shcheklein · 2021-09-20T21:51:37Z

content/docs/command-reference/plots/index.md

+Data series plots utilize [Vega-Lite](https://vega.github.io/vega-lite/) for
+rendering. Vega-Lite is a declarative grammar for defining plots using JSON. The
+plots can also be saved as SVG or PNG image filed from the browser. Image type
+plots are rendered using `<img>` tag.


out of curiosity - how do we deal with an image file from a past commit? when I do dvc plots diff? do we embed it into HTML, copy it nearby?

Currently we just insert files with identical path into same <div> tag.:

During treeverse/dvc#6603 I will try to make it look less terrible.

yep, but where does it take the image itself from HEAD? the png file - how does it read from the Git history?

We read it as a binary file and later write the same way into the webpage.

It can become problematic (memory-wise) in case of multiple images and revision, so further development assumes
using cache URL instead of binary data (in cached plots use case). In the case of git, well this approach will probably have to remain.

related:
treeverse/dvc#6145 (comment)

@shcheklein Not sure if you meant how images are collected or how they are sourced into the HTML. If you meant the latter, dvc plots diff now generates a directory that looks like:

dvc_plots ├── index.html └── static ├── HEAD_image.png └── workspace_image.png

Thanks @dberenbaum ! I'm not sure if then We read it as a binary file by Pawel is still relevant?

I was asking this because we'll need access to these data from the VS Code env. We are iterating right now on the requirements and I'm curious what kind of interface we can expect/build for it.

I think the comment from @pared is relevant for Studio, but probably not for VSCode. We don't have any --show-json or other machine-readable output from dvc plots diff today for images, so either VSCode can read directly from the generated dvc_plots directory, or we will need to add some other option to provide the needed info.

I think it's fine for us to start with dvc plots diff if it supports experiments/checkpoints. But it doesn't sound like a very efficient thing. Ideally yes, we'll need an interface to see the list of available things across commits/experiments and either path to those or a command that would stream them for us (if it's a Git history) and/or find another way.

cc @rogermparent ^^

But it doesn't sound like a very efficient thing.

Do you mean by compute, memory, or storage? @pared linked to the discussion about memory concerns above, where we can make optimizations if needed. We chose to make copies of the files in the dvc_plots directory so that the results are self-contained and can be shared, moved, etc. This seems like a case where the user requirements and downstream product requirements might not align well.

dberenbaum · 2021-09-21T12:27:54Z

Related: treeverse/dvc#6431

content/docs/command-reference/plots/index.md

jorgeorpinel · 2021-09-27T02:50:14Z

content/docs/command-reference/plots/index.md

+A set of commands to visualize and compare _plot metrics_:
+[show](/doc/command-reference/plots/show),
 [diff](/doc/command-reference/plots/diff), and
 [modify](/doc/command-reference/plots/modify).


I think we should clarify here (in the usage block below) and in https://dvc.org/doc/command-reference/plots/modify that it only works with structured "data series" file plots.

Related treeverse/dvc#6669

@jorgeorpinel added context to modify
Also created:
treeverse/dvc#6742

jorgeorpinel

A few first quick copy edits (committing)...

content/docs/command-reference/plots/index.md

Co-authored-by: Restyled.io <commits@restyled.io>

jorgeorpinel

More copy edits (committing)

content/docs/command-reference/plots/index.md

Co-authored-by: Restyled.io <commits@restyled.io>

content/docs/command-reference/plots/index.md

content/docs/command-reference/plots/modify.md

content/docs/command-reference/plots/index.md

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

jorgeorpinel · 2021-10-20T16:20:50Z

Sorry for the delay and thanks @pared !

jorgeorpinel · 2021-10-20T22:53:09Z

content/docs/command-reference/plots/index.md

+DVC can work with two types of plots files:

-In contrast to `dvc metrics`, these metrics should be stored as data series.
-Unlike its `dvc metrics` counterpart, `dvc plots diff` cannot calculate numeric
-differences between the metrics in different experiments.
+1. Data series files, which can be JSON, YAML, CSV or TSV.
+2. Image files in JPEG, GIF, or PNG format.


You know what we're going to need to revisit this explanation. I think... We already have 2 types of metrics in this same doc so this is going to be confusing... I'm not sure how or where else to present this feature so that it's clearer though 🤔

Maybe the handling of different types of plots should be explained in a separate document?

Yeah not sure... Maybe the types of metrics (metrics vs. plots) shouldn't be there. Moved to #2956

pared changed the title ~~Plots images~~ plots: document images support Sep 20, 2021

pared changed the title ~~plots: document images support~~ [WIP] plots: document images support Sep 20, 2021

shcheklein temporarily deployed to dvc-org-plots-images-dxygj9x6v September 20, 2021 17:22 Inactive

shcheklein reviewed Sep 20, 2021

View reviewed changes

shcheklein temporarily deployed to dvc-org-plots-images-dxygj9x6v September 21, 2021 22:02 Inactive

shcheklein reviewed Sep 21, 2021

View reviewed changes

content/docs/command-reference/plots/index.md Outdated Show resolved Hide resolved

shcheklein temporarily deployed to dvc-org-plots-images-dxygj9x6v September 22, 2021 08:21 Inactive

plots: support images

4ead01e

pared force-pushed the plots_images branch from 7dc731f to 4ead01e Compare September 22, 2021 09:17

shcheklein temporarily deployed to dvc-org-plots-images-dxygj9x6v September 22, 2021 09:17 Inactive

pared changed the title ~~[WIP] plots: document images support~~ plots: document images support Sep 22, 2021

pared requested a review from shcheklein September 22, 2021 09:23

shcheklein requested a review from jorgeorpinel September 22, 2021 19:56

dberenbaum mentioned this pull request Sep 22, 2021

html: render without dvc integration? treeverse/dvclive#163

Closed

jorgeorpinel mentioned this pull request Sep 27, 2021

plots: introduce support for images treeverse/dvc#6431

Merged

2 tasks

jorgeorpinel reviewed Sep 27, 2021

View reviewed changes

content/docs/command-reference/plots/index.md Outdated Show resolved Hide resolved

content/docs/command-reference/plots/index.md Outdated Show resolved Hide resolved

content/docs/command-reference/plots/index.md Outdated Show resolved Hide resolved

ref: copy edit plots index intro

7010f3d

restyled-io bot mentioned this pull request Sep 27, 2021

Restyle plots: document images support #2854

Merged

jorgeorpinel temporarily deployed to dvc-org-plots-images-dxygj9x6v September 27, 2021 03:00 Inactive

jorgeorpinel reviewed Sep 27, 2021

View reviewed changes

content/docs/command-reference/plots/index.md Outdated Show resolved Hide resolved

Restyled by prettier (#2854)

1873e92

Co-authored-by: Restyled.io <commits@restyled.io>

jorgeorpinel temporarily deployed to dvc-org-plots-images-dxygj9x6v September 27, 2021 03:02 Inactive

jorgeorpinel reviewed Sep 27, 2021

View reviewed changes

ref: copy edit body of plots index

7fb2e07

jorgeorpinel temporarily deployed to dvc-org-plots-images-dxygj9x6v September 27, 2021 03:12 Inactive

restyled-io bot mentioned this pull request Sep 27, 2021

Restyle plots: document images support #2855

Merged

Restyled by prettier (#2855)

3c0641e

Co-authored-by: Restyled.io <commits@restyled.io>

jorgeorpinel temporarily deployed to dvc-org-plots-images-dxygj9x6v September 27, 2021 03:13 Inactive

pared mentioned this pull request Sep 30, 2021

plots: expand supported images extensions treeverse/dvc#6714

Closed

plots: add note to modify about images

4a49d5e

shcheklein temporarily deployed to dvc-org-plots-images-dxygj9x6v October 4, 2021 16:28 Inactive

pared mentioned this pull request Oct 4, 2021

plots: modify: add note on modyfying image type plots treeverse/dvc#6742

Merged

2 tasks

jorgeorpinel reviewed Oct 11, 2021

View reviewed changes

content/docs/command-reference/plots/index.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Oct 11, 2021

View reviewed changes

content/docs/command-reference/plots/modify.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Oct 11, 2021

View reviewed changes

content/docs/command-reference/plots/index.md Outdated Show resolved Hide resolved

jorgeorpinel assigned pared Oct 11, 2021

pared and others added 3 commits October 11, 2021 11:32

Update content/docs/command-reference/plots/index.md

54f5d18

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

Update content/docs/command-reference/plots/modify.md

d093d1e

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

Update content/docs/command-reference/plots/index.md

2835e77

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

shcheklein temporarily deployed to dvc-org-plots-images-dxygj9x6v October 11, 2021 09:33 Inactive

jorgeorpinel approved these changes Oct 20, 2021

View reviewed changes

jorgeorpinel merged commit d59a8c7 into master Oct 20, 2021

jorgeorpinel deleted the plots_images branch October 20, 2021 16:20

jorgeorpinel reviewed Oct 20, 2021

View reviewed changes

jorgeorpinel mentioned this pull request Oct 22, 2021

ref: clarify about types of metrics/plots #2956

Closed

plots: document images support #2839

plots: document images support #2839

Uh oh!

Conversation

pared commented Sep 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pared Sep 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dberenbaum commented Sep 21, 2021

Uh oh!

Uh oh!

jorgeorpinel Sep 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jorgeorpinel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jorgeorpinel commented Oct 20, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

pared commented Sep 20, 2021 •

edited

Loading

pared Sep 21, 2021 •

edited

Loading

jorgeorpinel Sep 27, 2021 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading