TrackioConfig

from modal_dojo import TrackioConfig

Trackio logging configuration shared across all frameworks.

Attributes

project str

Metric project name. Default: ""

group str

Group tag for related runs. Default: ""

exp_name str

Run display name. Default: ""

disable_random_suffix bool

Preserve the configured run name. Default: True

space_id str

Optional Hugging Face Space id such as owner/trackio. Default: ""

server_url str

Optional self-hosted Trackio server URL. Leave empty to use hosted Trackio. Default: ""

dashboard_url str

Dashboard URL. Derived from space_id or server_url when empty. Default: ""

bucket_id str

Hugging Face Bucket used by the Trackio Space. Default: ""

modal_secret_name str

Modal Secret with HF_TOKEN or TRACKIO_WRITE_TOKEN. Default: "huggingface-secret"

TRACKIO_PACKAGE_VERSION str

Trackio release installed in the training image and by deploy_to_modal. Default: "0.34.0"

deploy_to_modal

deploy_to_modal(*, project: str = '', group: str = '', exp_name: str = '', disable_random_suffix: bool = True, app_name: str = 'training-gym-trackio', volume_name: str = '', modal_secret_name: str = '', TRACKIO_PACKAGE_VERSION: str = '0.34.0') -> Self

Deploy a persistent Trackio server to Modal and return its config.

The app, Volume, and write-token Secret are reused on subsequent calls with the same names. Ingestion and dashboard mutations require the write token stored in the Secret. Reads are open unless a dashboard password was set with modal-dojo set-password, which gates this dashboard behind the same HTTP Basic Auth as the observability dashboard.

metadata

metadata(*, entity: str = '', run_id: str = '') -> dict[str, str]

runtime_env

runtime_env(*, run_id: str, entity: str = '') -> dict[str, str]

url

url(*, entity: str = '', run_id: str = '') -> str | None