feat(utils): add Trackio experiment tracking backend#1113
Merged
garrett4wade merged 1 commit intoApr 1, 2026
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request integrates Trackio for experiment tracking, adding a TrackioConfig dataclass and incorporating it into the StatsLogger and logging utilities. The changes include dependency updates, documentation generation, and a comprehensive test suite. A review comment suggests implementing validation for the mode field in TrackioConfig to ensure it only accepts 'disabled', 'online', or 'local'.
Comment on lines
+1906
to
+1925
| class TrackioConfig: | ||
| """Configuration for Trackio experiment tracking (Hugging Face). | ||
|
|
||
| Trackio is a lightweight, local-first experiment tracking library | ||
| with a wandb-compatible API. Dashboards can be viewed locally or | ||
| deployed to Hugging Face Spaces. | ||
|
|
||
| See: https://github.com/gradio-app/trackio | ||
| """ | ||
|
|
||
| mode: str = "disabled" | ||
| """Tracking mode. One of "disabled", "online", or "local".""" | ||
| project: str | None = None | ||
| """Project name. Defaults to experiment_name if not set.""" | ||
| name: str | None = None | ||
| """Run name. Defaults to trial_name if not set.""" | ||
| space_id: str | None = None | ||
| """HF Space ID for remote dashboard deployment (e.g. "user/my-space"). | ||
| When set, metrics are also pushed to the specified Hugging Face Space.""" | ||
|
|
Contributor
There was a problem hiding this comment.
To improve robustness and prevent unexpected behavior with invalid modes, it's a good practice to validate the mode field. Many other configuration dataclasses in this file (e.g., NormConfig, RecoverConfig) already use a __post_init__ method for validation. I suggest adding one here to ensure mode is one of the expected values ('disabled', 'online', or 'local').
@dataclass
class TrackioConfig:
"""Configuration for Trackio experiment tracking (Hugging Face).
Trackio is a lightweight, local-first experiment tracking library
with a wandb-compatible API. Dashboards can be viewed locally or
deployed to Hugging Face Spaces.
See: https://github.com/gradio-app/trackio
"""
mode: str = "disabled"
"""Tracking mode. One of "disabled", "online", or "local"."""
project: str | None = None
"""Project name. Defaults to experiment_name if not set."""
name: str | None = None
"""Run name. Defaults to trial_name if not set."""
space_id: str | None = None
"""HF Space ID for remote dashboard deployment (e.g. "user/my-space").
When set, metrics are also pushed to the specified Hugging Face Space."""
def __post_init__(self):
"""Validate Trackio configuration."""
valid_modes = {"disabled", "online", "local"}
if self.mode not in valid_modes:
raise ValueError(
f"Invalid trackio mode: '{self.mode}'. Must be one of {valid_modes}."
)
Integrate Trackio (Hugging Face) as a new experiment tracking option alongside existing WandB, SwanLab, and TensorBoard backends. Key changes: - Add TrackioConfig dataclass with mode/project/name/space_id fields - Integrate trackio init/log/finish lifecycle in StatsLogger - Add trackio.log() fallback in logging.py helper function - Add trackio to pyproject.toml dependencies - Update CLI docs generator to include TrackioConfig - Add unit tests for config and StatsLogger integration
guozhihao-224
force-pushed
the
feat/trackio-integration
branch
from
March 30, 2026 16:06
939633b to
ced8391
Compare
16 tasks
SathyaGnanakumar
pushed a commit
to danielkiely/AReaL
that referenced
this pull request
Apr 29, 2026
) Integrate Trackio (Hugging Face) as a new experiment tracking option alongside existing WandB, SwanLab, and TensorBoard backends. Key changes: - Add TrackioConfig dataclass with mode/project/name/space_id fields - Integrate trackio init/log/finish lifecycle in StatsLogger - Add trackio.log() fallback in logging.py helper function - Add trackio to pyproject.toml dependencies - Update CLI docs generator to include TrackioConfig - Add unit tests for config and StatsLogger integration
This was referenced May 14, 2026
3 tasks
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
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.
Description
Add Trackio (Hugging Face) as a new experiment tracking backend for AReaL, alongside existing WandB, SwanLab, and TensorBoard support. Trackio is a lightweight, local-first tracking library with a wandb-compatible API that supports local dashboards and Hugging Face Spaces deployment.
Related Issue
#1089
#907
Type of Change
Checklist
pre-commit run --all-files)./docs/build_all.sh)main/review-prcommand/create-prBreaking Change Details (if applicable):
N/A
Additional Context
Key changes:
areal/api/cli_args.py: NewTrackioConfigdataclass withmode/project/name/space_idfields; addedtrackiofield toStatsLoggerConfigareal/utils/stats_logger.py: Trackioinit/log/finishlifecycle integration inStatsLoggerareal/utils/logging.py: Addtrackio.log()with graceful fallback in helper functionpyproject.toml: Addtrackiodependencydocs/generate_cli_docs.py: IncludeTrackioConfigin CLI docs generationtests/test_trackio_backend.py: Unit tests for config defaults andStatsLoggerintegration (mocked)Trackio defaults to
disabledmode, so this change is fully backward-compatible. Enable withstats_logger.trackio.mode=onlineorstats_logger.trackio.mode=local.