WandbConfig
"# WandbConfig\n\n```python\nfrom modal_training_gym.common.wandb import WandbConfig\n```\n\nWeights & Biases run metadata and credentials.\n\n**Attributes**\n\n<div class=\"tg-param\">\n<p><strong>project</strong> <code>str</code></p>\n<p>W&B project name. <span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>entity</strong> <code>str</code></p>\n<p>W&B entity or team slug. The API key's default entity applies when empty. <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>W&B 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>W&B run display name. <span class=\"tg-param-default\">Default: \"\"</span></p>\n</div>\n\n<div class=\"tg-param\">\n<p><strong>key</strong> <code>str</code></p>\n<p>W&B API key. <code>WANDB_API_KEY</code> takes precedence. <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>modal_wandb_secret_name</strong> <code>str</code></p>\n<p>Modal secret containing the W&B API key. <span class=\"tg-param-default\">Default: \"wandb-secret\"</span></p>\n</div>\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.wandb import WandbConfigWeights & Biases run metadata and credentials.
Attributes
project str
W&B project name. Default: ""
entity str
W&B entity or team slug. The API key's default entity applies when empty. Default: ""
group str
W&B group tag for related runs. Default: ""
exp_name str
W&B run display name. Default: ""
key str
W&B API key. WANDB_API_KEY takes precedence. Default: ""
disable_random_suffix bool
Preserve the configured run name. Default: True
modal_wandb_secret_name str
Modal secret containing the W&B API key. Default: "wandb-secret"
metadata
Section titled “metadata”metadata(*, entity: str = '', run_id: str = '') -> dict[str, str]runtime_env
Section titled “runtime_env”runtime_env(*, run_id: str, entity: str = '') -> dict[str, str]url(*, entity: str = '', run_id: str = '') -> str | None