tensorflow / tensorflow/tensorboard
Provide a TensorBoard-native summary writer API
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 1
Description
This issue tracks work to provide, within TensorBoard proper, a summary "writer" API for end-users to log data for visualization in TensorBoard. This is intended to be a lightweight way to log to TensorBoard without necessarily depending on TensorFlow, although it should also be usable by eager-mode TensorFlow users.
Note that this API isn't intended to replace tf.summary - the latter will continue to be the recommended approach for TensorFlow users who want to log data from within graphs or tf.functions.
Plan of work. Some of these steps may be done on-demand / as need arises.
- Define initial
Writerobject andOutputinterface with scalar support - Port
tf.summarysummary types- Scalars
- Images
- Audio
- Histograms
- Text
- HParams
- Graph
- PR curves
- Custom scalars
- Mesh
- Embedding
- NPMI
- Add support for generic / extensible summary types
- Add support for tracking a step within the writer itself
- Add
Outputmechanism for logging the version of TensorBoard used to write data - Implement other
Outputtypes- In-memory output
- Logging to stdout
- Implement filesystem support for
DirectoryOutput- Local filesystem
- tf.io.gfile support
- GCS support (without TF)
- Add API documentation
- Add demo (or retrofit existing demos)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are identified in the issue. Begin by narrowing the planned Writer and Output interfaces, then determine the initial scope and acceptance criteria before implementing the listed summary, filesystem, documentation, and demo work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tensorflow
- Domain
- api, data-visualization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100