add Tracker protocol and training tracking guide.#1741
Open
Conversation
- Tracker protocol with TensorBoard implementation and deprecated summary_writer alias for backward compatibility. - - - Update trainers and plot_summary to log via the tracker, and document the new tracking workflow with runnable TensorBoard examples plus adapter patterns for other tools.
❌ 1 Tests Failed:
View the full list of 1 ❄️ flaky test(s)
To view more test analytics, go to the Test Analytics Dashboard |
manuelgloeckler
approved these changes
Feb 3, 2026
Contributor
manuelgloeckler
left a comment
There was a problem hiding this comment.
Thats looks great!
Also nice that one can now e.g. easily switch to e.g. wandb.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
We want a simple, extensible way to log training metrics from
sbithat works withTensorBoard by default while letting users plug in their own experiment trackers.
The previous
summary_writerargument was TensorBoard-specific and hard to extend.What changed
Trackerprotocol (sbi/sbi_types.py) with metric/figure/param logging and alog_dirproperty.TensorBoardTrackerinsbi/utils/tracking.pyas the default implementation.tracker=and log through the protocol;summary_writer=is a deprecated alias that wraps TensorBoard and warns if used.plot_summarynow readslog_dirfrom the tracker and errors with a clear message if a non-TensorBoard tracker is used.Naming choices
Tracker: short and tool-agnostic; aligns better with MLflow/W&B conventionsthan “writer”.
add_figure: mirrors TensorBoard’sSummaryWriter.add_figure, keeping thedefault implementation a thin adapter.
Notes
that satisfy the
Trackerprotocol.summary_writerremains for backward compatibility but is deprecated.