tensorflow / tensorflow/tensorboard
[doc] document how to develop plugin using data_provider
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 1
Description
With generic_data_apis.md design, TensorBoard now can better understand, manage, and support different data types all plugins write. To that end, we introduced the DataProvider and soft deprecated *Event{Accumulator,Multiplex}.
We need to update our examples and documentations accordingly. For instance, ./ADDING_A_PLUGIN.md and the example plugin still uses the event multiplexer.
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
Start by reading docs/design/generic_data_apis.md and ./ADDING_A_PLUGIN.md, then inspect the example plugin references to the event multiplexer. Done means the plugin development examples and documentation use DataProvider consistently instead of the soft-deprecated event accumulator and multiplexer APIs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100