run
Run
Operations for running NannyML model analysis.
trigger
classmethod
trigger(model_id: str) -> RunSummary
Trigger analysis of new data for a model.
This method starts analysis for a model. The run is scheduled to start immediately, but the function returns before the run has started. The returned summary information can be used to track the progress of the run.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
model_id |
str
|
The ID of the model to run. |
required |
Returns:
| Type | Description |
|---|---|
RunSummary
|
Summary information for the newly started run. |
RunSummary
Bases: TypedDict
Summary information for NannyML analysis of a model, a run.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
str
|
Unique identifier for the run (generated by NannyML Cloud). |
state |
RunState
|
Current state of the run. |
scheduledFor |
Optional[datetime]
|
Date and time the run was scheduled to start. |
startedAt |
Optional[datetime]
|
Date and time the run started. |
completedAt |
Optional[datetime]
|
Date and time the run completed. |
ranSuccessfully |
Optional[bool]
|
Whether the run completed successfully. |