Skip to content

HPOObjective

Source code in docs_src/capo_personalize/types/hpo_objective.py
class HPOObjective(TypedDict, closed=True):
    type: NotRequired["capo_personalize.types.hpo_objective_type.HPOObjectiveType"]
    """<p>The type of the metric. Valid values are <code>Maximize</code> and <code>Minimize</code>.</p>"""
    metric_name: NotRequired["capo_personalize.types.metric_name.MetricName"]
    """<p>The name of the metric.</p>"""
    metric_regex: NotRequired["capo_personalize.types.metric_regex.MetricRegex"]
    """<p>A regular expression for finding the metric in the training job logs.</p>"""

metric_name instance-attribute

metric_name: NotRequired[MetricName]

The name of the metric.

metric_regex instance-attribute

metric_regex: NotRequired[MetricRegex]

A regular expression for finding the metric in the training job logs.

type instance-attribute

type: NotRequired[HPOObjectiveType]

The type of the metric. Valid values are Maximize and Minimize.