TrackioConfig

"# TrackioConfig\n\n```python\nfrom modal_training_gym.common.trackio import TrackioConfig\n```\n\nTrackio logging configuration shared across all frameworks.\n\nTrackio can log to a Hugging Face Space or a self-hosted server. Training\nimages install Trackio automatically and adapt the W&B calls made by the\nunderlying framework.\n\n## Fields\n\nproject : str\n Trackio project name. Default `\"\"` (uses `\"training-gym\"`).\ngroup : str\n Group tag for related runs. Default `\"\"`.\nexp_name : str\n Run display name. Default `\"\"`.\ndisable_random_suffix : bool\n Whether the framework should preserve the configured group name.\n Default `True`.\nspace_id : str\n Hugging Face Space ID, such as `\"owner/trackio\"`. Optional.\nserver_url : str\n URL of a self-hosted Trackio server. Optional.\ndashboard_url : str\n Explicit dashboard URL. Optional; otherwise derived from `space_id`\n or `server_url`.\nbucket_id : str\n Hugging Face Bucket used by the Trackio Space. Optional.\nmodal_secret_name : str\n Modal Secret containing `HF_TOKEN` or `TRACKIO_WRITE_TOKEN`.\n The standard optional `\"huggingface-secret\"` is used by default.\nTRACKIO_PACKAGE_VERSION : str\n Trackio release installed in the training image, and in the server\n deployed by `deploy_to_modal`. Defaults to the version this release\n of Training Gym is tested against; bump it to pick up a newer Trackio.\n\n**Attributes**\n\n<div class=\"tg-param\">\n<p><strong>project</strong> <code>str</code></p>\n<p>Metric project name. <span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>group</strong> <code>str</code></p>\n<p>Group tag for related runs. <span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>exp_name</strong> <code>str</code></p>\n<p>Run display name. <span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>disable_random_suffix</strong> <code>bool</code></p>\n<p>Preserve the configured run name. <span class=\"tg-param-default\">Default: True</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>space_id</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>server_url</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>dashboard_url</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>bucket_id</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>modal_secret_name</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"huggingface-secret\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>TRACKIO_PACKAGE_VERSION</strong> <code>str</code></p>\n<p><span class=\"tg-param-default\">Default: \"0.34.0\"</span></p>\n</div>\n\n## `deploy_to_modal`\n\n```python\ndeploy_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\n```\n\nDeploy a persistent Trackio server to Modal and return its config.\n\nThe app, Volume, and write-token Secret are reused on subsequent calls\nwith the same names. Ingestion and dashboard mutations require the write\ntoken stored in the Secret. Reads are open unless a dashboard password\nwas set with `training-gym set-password`, which gates this dashboard\nbehind the same HTTP Basic Auth as the observability dashboard.\n\n## `metadata`\n\n```python\nmetadata(*, entity: str = '', run_id: str = '') -> dict[str, str]\n```\n\n## `runtime_env`\n\n```python\nruntime_env(*, run_id: str, entity: str = '') -> dict[str, str]\n```\n\n## `url`\n\n```python\nurl(*, entity: str = '', run_id: str = '') -> str | None\n```\n"

from modal_training_gym.common.trackio import TrackioConfig

Trackio logging configuration shared across all frameworks.

Trackio can log to a Hugging Face Space or a self-hosted server. Training images install Trackio automatically and adapt the W&B calls made by the underlying framework.

Fields

project : str Trackio project name. Default "" (uses "training-gym"). group : str Group tag for related runs. Default "". exp_name : str Run display name. Default "". disable_random_suffix : bool Whether the framework should preserve the configured group name. Default True. space_id : str Hugging Face Space ID, such as "owner/trackio". Optional. server_url : str URL of a self-hosted Trackio server. Optional. dashboard_url : str Explicit dashboard URL. Optional; otherwise derived from space_id or server_url. bucket_id : str Hugging Face Bucket used by the Trackio Space. Optional. modal_secret_name : str Modal Secret containing HF_TOKEN or TRACKIO_WRITE_TOKEN. The standard optional "huggingface-secret" is used by default. TRACKIO_PACKAGE_VERSION : str Trackio release installed in the training image, and in the server deployed by deploy_to_modal. Defaults to the version this release of Training Gym is tested against; bump it to pick up a newer Trackio.

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

Default: ""

server_url str

Default: ""

dashboard_url str

Default: ""

bucket_id str

Default: ""

modal_secret_name str

Default: "huggingface-secret"

TRACKIO_PACKAGE_VERSION str

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 training-gym 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