Skip to content

ExperimentState

Source code in docs_src/capo_fis/types/experiment_state.py
class ExperimentState(TypedDict, closed=True):
    status: NotRequired["capo_fis.types.experiment_status.ExperimentStatus"]
    """<p>The state of the experiment.</p>"""
    reason: NotRequired[
        "capo_fis.types.experiment_status_reason.ExperimentStatusReason"
    ]
    """<p>The reason for the state.</p>"""
    error: NotRequired["capo_fis.types.experiment_error.ExperimentError"]
    """<p>The error information of the experiment when the action has <code>failed</code>.</p>"""

error instance-attribute

error: NotRequired[ExperimentError]

The error information of the experiment when the action has failed.

reason instance-attribute

reason: NotRequired[ExperimentStatusReason]

The reason for the state.

status instance-attribute

status: NotRequired[ExperimentStatus]

The state of the experiment.