Skip to content

Commit 4f1e0a2

Browse files
chihuahuanfelt
authored andcommitted
Update README to consider custom scalars plugin (#951)
The custom scalars plugin lets the user overlap custom run-tag pairs within the same plot as well as visualize margins. This change modifies the main TensorBoard README to note those new features.
1 parent 43e3c2b commit 4f1e0a2

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -325,11 +325,18 @@ If you need access to the full dataset, you can read the event files that
325325
TensorBoard consumes by using the [`summary_iterator`](https://github.com/tensorflow/tensorflow/blob/e7f333b5f8b3c53b21d149d8d14c0cebbde431aa/tensorflow/python/summary/summary_iterator.py#L313)
326326
method.
327327

328+
### Can I customize which lines appear in a plot?
328329

329-
### Can I overlap multiple plots?
330+
Using the [custom scalars plugin](tensorboard/plugins/custom_scalar), you can
331+
create scalar plots with lines for custom run-tag pairs. However, within the
332+
original scalars dashboard, each scalar plot corresponds to data for a specific
333+
tag and contains lines for each run that includes that tag.
330334

331-
Right now, you can overlap plots only if they are from different runs, and both
332-
have the same tag name.
335+
### Can I visualize margins above and below lines?
336+
337+
Margin plots (that visualize lower and upper bounds) may be created with the
338+
[custom scalars plugin](tensorboard/plugins/custom_scalar). The original
339+
scalars plugin does not support visualizing margins.
333340

334341
### Can I create scatterplots (or other custom plots)?
335342

0 commit comments

Comments
 (0)