Update custom scalar plugin docs with info on margin plots #878

chihuahua · 2018-01-16T04:54:11Z

Documentation for the custom scalar plugin had not described how to create margin plots. This change describes that feature and adds/replaces screenshots.

We also remove the sample code from the documentation and instead link to custom_scalar_demo.py.

nfelt

A bit of an aside, but I noticed the top-level README.md has a few questions that are a little stale now that the custom scalars dashboard exists. Would be good to update those.

https://github.com/chihuahua/tensorboard/blob/1b8c53556751b4598defaf793f3f607e24c69db8/README.md#can-i-overlap-multiple-plots
https://github.com/chihuahua/tensorboard/blob/1b8c53556751b4598defaf793f3f607e24c69db8/README.md#can-i-create-scatterplots-or-other-custom-plots (you still can't create scatterplots, but you can create margin plots now!)

nfelt · 2018-01-19T00:58:17Z

tensorboard/plugins/custom_scalar/README.md

@@ -6,7 +6,8 @@ The *custom* scalar dashboard lets users

 1. Create line charts with custom combinations of runs and tags by assigning
 each chart a list of regular expressions for tags.
-2. Lay out the dashboard in a customized way.
+2. Create margin plots (for visualizing confidence intervals).


nit: maybe use an unordered list? Since these are just a set of features, there's no real inherent sequence to them.

nfelt · 2018-01-19T01:05:28Z

tensorboard/plugins/custom_scalar/README.md

+The baz chart is a margin plot. Zoom in (by dragging a rectangle) or hover over
+points to view margin values. Lines within the margin plot may leave the
+visualized margins because the primary lines are smoothened across time (but the
+margins are not smoothened because smoothing margins might not make statistical


It seems kinda strange to smooth the primary line but not the margins. I wonder if maybe we should just make smoothing not affect margin plots at all?

That makes sense! #903

I think the text here still needs to be updated? There's a broken link to the old screenshot of the line going out of bounds.

Ah, thanks! Done.

nfelt · 2018-01-19T01:08:11Z

tensorboard/plugins/custom_scalar/README.md

@@ -144,6 +93,16 @@ obtained by the regular expression `r'loss.*'`. Because the 2 tags are for the
 same run, the 2 lines differ in markers (One uses squares, while the other uses
 diamonds.) to be distinct from each other. Color still encodes the run.

+The baz chart is a margin plot. Zoom in (by dragging a rectangle) or hover over


Can we make the margins in the baz chart bigger to make it more obvious that it's a margin plot in the sample_code_dashboard.png shown above? I didn't realize it was a margin chart without reading this and then going to the file and zooming in.

Great idea! #923

nfelt · 2018-01-24T06:26:12Z

tensorboard/plugins/custom_scalar/README.md

-    summary = sess.run(merged_summary, feed_dict={step: i})
-    writer.add_summary(summary, global_step=i)
-```
+See [custom_scalar_demo.py](custom_scalar_demo.py) for an example of collecting


(Grr at GitHub for not letting me comment on the appropriate line.)

Line 83 in the new file says "The above logic produces this custom scalar dashboard." However, now that we're just referencing the demo.py file, "above logic" isn't quite right. Also, the demo.py itself doesn't produce that exact dashboard shown in the screenshot since it now shows a margin plot for losses.

I think we probably just want to change the wording to say "Example of the custom scalar dashboard UI" or something generic?

Thanks for catching the outdated comments! We now use that title and show an updated screenshot.

nfelt · 2018-01-24T06:35:11Z

Oh, and sorry about the long latency on this review... slipped my mind.

Documentation for the custom scalar plugin had not described how to create margin plots. This change describes that feature and adds/replaces screenshots. We also remove the sample code from the documentation and instead link to custom_scalar_demo.py.

googlebot · 2018-02-05T02:57:23Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this State. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

chihuahua

Indeed, we should update the main README for TensorBoard. I will do that in a separate PR.

chihuahua · 2018-02-05T03:03:06Z

tensorboard/plugins/custom_scalar/README.md

-    summary = sess.run(merged_summary, feed_dict={step: i})
-    writer.add_summary(summary, global_step=i)
-```
+See [custom_scalar_demo.py](custom_scalar_demo.py) for an example of collecting


Thanks for catching the outdated comments! We now use that title and show an updated screenshot.

nfelt · 2018-02-05T18:00:15Z

LGTM. Do we know how to fix googlebot?

jart · 2018-02-05T18:08:38Z

Use your owner privileges to ignore @googlebot for this PR
Please configure your ~/.gitconfig to have something like the following:

[user]
  name = Justine Tunney
  email = jart@google.com

Because the author "name" appears to be what's triggering that @googlebot warning.

commit 1f5b70c2439ec4471e1e6a2c2a6e1d125e1e560d (HEAD, chizeng/docs)
Author: chihuahua <chizeng@google.com>
Date:   Sun Feb 4 19:00:47 2018 -0800

    Change overview screenshot

commit adfbe61183afb42f619659c740de38aebe628840
Author: chihuahua <chizeng@google.com>
Date:   Sun Feb 4 18:56:06 2018 -0800

    Replace demo deashashboard screenshot

commit 2a208c220f2649a19df35891572d1de5fd102e06
Author: chihuahua <chizeng@google.com>
Date:   Sun Feb 4 18:51:20 2018 -0800

    Use bullet points

commit b8fc8ab68e252767f1c8518d7dec95465dee7eee
Author: Chi Zeng <chizeng@google.com>
Date:   Mon Jan 15 16:53:26 2018 -0800

    Update custom scalar plugin docs with info on margin plots
    
    Documentation for the custom scalar plugin had not described how to create margin plots. This change describes that feature and adds/replaces screenshots.
    
    We also remove the sample code from the documentation and instead link to custom_scalar_demo.py.

jart · 2018-02-05T18:10:15Z

Also please wrap commit message paragraphs at 72 chars. Possibly less. I noticed GitHub's GUI will render them wrong possibly at a lower number. Still working on figuring out the optimal.

chihuahua · 2018-02-06T01:00:38Z

Thanks @jart - where do you see the paragraphs in commit messages rendered? Mainly just curious.

Also, I think googlebot was triggered by me accidentally rebasing to a very old commit and thus pushing many unrelated commits to this PR. I got rid of them via a rebase, but googlebot's message stayed.

…w#878) Documentation for the custom scalar plugin had not described how to create margin plots. This change describes that feature and adds/replaces screenshots. We also remove the sample code from the documentation and instead link to custom_scalar_demo.py.

Documentation for the custom scalar plugin had not described how to create margin plots. This change describes that feature and adds/replaces screenshots. We also remove the sample code from the documentation and instead link to custom_scalar_demo.py.

chihuahua added the plugin:custom-scalars label Jan 16, 2018

chihuahua requested review from jart and nfelt January 16, 2018 04:54

chihuahua force-pushed the docs branch from 937fa49 to 1b8c535 Compare January 16, 2018 04:55

nfelt approved these changes Jan 24, 2018

View reviewed changes

chihuahua added 3 commits February 4, 2018 18:57

Use bullet points

2a208c2

Replace demo deashashboard screenshot

adfbe61

chihuahua force-pushed the docs branch from 98d0acc to adfbe61 Compare February 5, 2018 02:57

Change overview screenshot

1f5b70c

chihuahua commented Feb 5, 2018

View reviewed changes

Remove broken image

76f5dac

chihuahua merged commit 4b02721 into tensorflow:master Feb 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update custom scalar plugin docs with info on margin plots #878

Update custom scalar plugin docs with info on margin plots #878

chihuahua commented Jan 16, 2018

nfelt left a comment

nfelt Jan 19, 2018

chihuahua Feb 5, 2018

nfelt Jan 19, 2018

chihuahua Jan 24, 2018

nfelt Feb 5, 2018

chihuahua Feb 6, 2018

nfelt Jan 19, 2018

chihuahua Jan 31, 2018

nfelt Jan 24, 2018

chihuahua Feb 5, 2018

nfelt commented Jan 24, 2018

googlebot commented Feb 5, 2018

chihuahua left a comment

chihuahua Feb 5, 2018

nfelt commented Feb 5, 2018

jart commented Feb 5, 2018

jart commented Feb 5, 2018

chihuahua commented Feb 6, 2018 •

edited

Loading

Update custom scalar plugin docs with info on margin plots #878

Update custom scalar plugin docs with info on margin plots #878

Conversation

chihuahua commented Jan 16, 2018

nfelt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nfelt commented Jan 24, 2018

googlebot commented Feb 5, 2018

chihuahua left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nfelt commented Feb 5, 2018

jart commented Feb 5, 2018

jart commented Feb 5, 2018

chihuahua commented Feb 6, 2018 • edited Loading

chihuahua commented Feb 6, 2018 •

edited

Loading