OnRunState

Class wandb.automations.OnRunState

A run state changes.

*,
event_type: Literal[RUN_STATE] = RUN_STATE,
scope: wandb.automations.scopes.ProjectScope,
filter: Annotated[wandb.automations.events.RunStateFilter, Json, BeforeValidator(func=<function ensure_json>, json_schema_input_type=PydanticUndefined), PlainSerializer(func=<function to_json>, return_type=PydanticUndefined, when_used='always')]

Args

Literal[RUN_STATE]

wandb.automations.scopes.ProjectScope

The scope of the event: must be a project.

Annotated[wandb.automations.events.RunStateFilter, Json, BeforeValidator(func= None, json_schema_input_type=PydanticUndefined), PlainSerializer(func= None, return_type=PydanticUndefined, when_used='always')]

Run state condition(s) that must be satisfied for this event to trigger.

Examples

Define an event that triggers for any run in project “my-project” when its state changes to “finished” (i.e. succeeded) or “failed”:

from wandb import Api
from wandb.automations import OnRunState

api = Api()
project = api.project(name="my-project")

event = OnRunState(
    scope=project,
    filter=RunEvent.state.in_(["finished", "failed"]),
)

W&B Models

W&B Weave

Serverless Inference

Serverless Training

Class wandb.automations.OnRunState

Args

Examples

​Class wandb.automations.OnRunState

​Args

​Examples

Class wandb.automations.OnRunState

Args

Examples