stormlog.wandb_integration

Optional Weights & Biases export helpers for Stormlog outputs.

class stormlog.wandb_integration.WandbExportConfig(enabled=False, project=None, entity=None, mode=None, run_id=None, run_name=None, group=None, job_type=None, log_tables=True, log_artifacts=False, log_attribution=False)[source]

Bases: object

Runtime configuration for optional W&B exports.

Parameters:

  • enabled (bool)

  • project (str | None)

  • entity (str | None)

  • mode (str | None)

  • run_id (str | None)

  • run_name (str | None)

  • group (str | None)

  • job_type (str | None)

  • log_tables (bool)

  • log_artifacts (bool)

  • log_attribution (bool)

enabled: bool = False
project: str | None = None
entity: str | None = None
mode: str | None = None
run_id: str | None = None
run_name: str | None = None
group: str | None = None
job_type: str | None = None
log_tables: bool = True
log_artifacts: bool = False
log_attribution: bool = False
stormlog.wandb_integration.add_wandb_arguments(parser)[source]

Attach shared optional W&B flags to a CLI parser.

Parameters:

parser (Any)

Return type:

None

stormlog.wandb_integration.ensure_wandb_available(config)[source]

Fail fast when the W&B feature is enabled without dependencies installed.

Parameters:

config (WandbExportConfig)

Return type:

None

stormlog.wandb_integration.export_diagnose_bundle_to_wandb(config, *, command_name, artifact_dir)[source]

Export one diagnose bundle directory to W&B.

Parameters:
Return type:

None

stormlog.wandb_integration.export_tracking_run_to_wandb(config, *, command_name, session_summary, stats, events, output_path=None, telemetry_sink_dir=None, oom_dump_path=None, attribution_bundle_dir=None)[source]

Export one completed tracking session to W&B.

Parameters:

  • config (WandbExportConfig)

  • command_name (str)

  • session_summary (SessionSummary | None)

  • stats (Mapping[str, Any])

  • events (Sequence[Any])

  • output_path (str | Path | None)

  • telemetry_sink_dir (str | Path | None)

  • oom_dump_path (str | Path | None)

  • attribution_bundle_dir (str | Path | None)

Return type:

None

stormlog.wandb_integration.wandb_config_from_namespace(args)[source]

Build a W&B export config from CLI args or a similar namespace.

Parameters:

args (Any)

Return type:

WandbExportConfig