Update README.md to include no-data example #5163
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added an example of what good and bad event files might contain. As a less than full-time user of TB, I see this problem a lot, and I would really love to see good and bad examples so I more easily know what I'm seeing. Alternative suggestions welcome.
nfelt
reviewed
Aug 2, 2021
README.md
Outdated
|
|
||
| `tensorboard --inspect --logdir DIRECTORY_PATH` | ||
|
|
||
| An empty event file (from a Keras job that starts output at batch 2) might look like this: |
There was a problem hiding this comment.
It might be worth a little clarification here that this event file isn't exactly "empty" (in that it does contain some events, as indicated by the non-zero steps) but that it doesn't show any summary data.
E.g. perhaps word as something like:
The output for an event file corresponding to a blank TensorBoard may still sometimes show a few steps, representing a few initial events that aren't shown by TensorBoard (for example, when using the Keras TensorBoard callback):
[output]
In contrast, the output for an event file with more data might look like this:
[output]
There was a problem hiding this comment.
Thanks. Much better now.
nfelt
approved these changes
Aug 4, 2021
yatbear
pushed a commit
to yatbear/tensorboard
that referenced
this pull request
Mar 27, 2023
* Update README.md to include no-data example Added an example of what good and bad event files might contain. As a less than full-time user of TB, I see this problem a lot, and I would really love to see good and bad examples so I more easily know what I'm seeing. Alternative suggestions welcome. * Better description of the state of the event files. * Better explanation of empty event file * Removing white space at the end of the line
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added an example of what good and bad event files might contain.
As a less than full-time user of TB, I see this problem a lot, and I would really love to see good and bad examples so I more easily know what I'm seeing.
Alternative suggestions welcome.
Motivation for features / changes: It wasn't clear to this user what an empty event file looked like. Let alone a good one.
Technical description of changes: Added the --inspect output from a good and a bad event file.
Screenshots of UI changes: N/A
Detailed steps to verify changes work correctly (as executed by you): Documentation change only.
Alternate designs / implementations considered: Would love to see better examples.