Skip to content

ExperimentReportState

Source code in docs_src/capo_fis/types/experiment_report_state.py
class ExperimentReportState(TypedDict, closed=True):
    status: NotRequired[
        "capo_fis.types.experiment_report_status.ExperimentReportStatus"
    ]
    """<p>The state of the experiment report generation.</p>"""
    reason: NotRequired[
        "capo_fis.types.experiment_report_reason.ExperimentReportReason"
    ]
    """<p>The reason for the state of the experiment report generation.</p>"""
    error: NotRequired["capo_fis.types.experiment_report_error.ExperimentReportError"]
    """<p>The error information of the experiment when the experiment report generation has failed.</p>"""

error instance-attribute

error: NotRequired[ExperimentReportError]

The error information of the experiment when the experiment report generation has failed.

reason instance-attribute

reason: NotRequired[ExperimentReportReason]

The reason for the state of the experiment report generation.

status instance-attribute

status: NotRequired[ExperimentReportStatus]

The state of the experiment report generation.