Skip to content

MetricDefinition

Source code in docs_src/capo_sagemaker/types/metric_definition.py 
12
13
14
15
16
class MetricDefinition(TypedDict, closed=True):
    name: NotRequired["capo_sagemaker.types.metric_name.MetricName"]
    """<p>The name of the metric.</p>"""
    regex: NotRequired["capo_sagemaker.types.metric_regex.MetricRegex"]
    """<p>A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html">Defining metrics and environment variables</a>.</p>"""

name instance-attribute 

name: NotRequired[MetricName]

The name of the metric.

regex instance-attribute 

regex: NotRequired[MetricRegex]

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining metrics and environment variables.