Skip to content

MetricDatum

Source code in docs_src/capo_sagemaker/types/metric_datum.py
class MetricDatum(TypedDict, closed=True):
    metric_name: NotRequired[
        "capo_sagemaker.types.auto_ml_metric_enum.AutoMLMetricEnum"
    ]
    """<p>The name of the metric.</p>"""
    standard_metric_name: NotRequired[
        "capo_sagemaker.types.auto_ml_metric_extended_enum.AutoMLMetricExtendedEnum"
    ]
    """<p>The name of the standard metric. </p> <note> <p>For definitions of the standard metrics, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-metrics"> <code>Autopilot candidate metrics</code> </a>.</p> </note>"""
    value: NotRequired["capo_sagemaker.types.float.Float"]
    """<p>The value of the metric.</p>"""
    set: NotRequired["capo_sagemaker.types.metric_set_source.MetricSetSource"]
    """<p>The dataset split from which the AutoML job produced the metric.</p>"""

metric_name instance-attribute

metric_name: NotRequired[AutoMLMetricEnum]

The name of the metric.

set instance-attribute

set: NotRequired[MetricSetSource]

The dataset split from which the AutoML job produced the metric.

standard_metric_name instance-attribute

standard_metric_name: NotRequired[AutoMLMetricExtendedEnum]

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

value instance-attribute

value: NotRequired[Float]

The value of the metric.