Class MetricSpec (1.26.1)

Version 1.26.1

• 1.48.0 (latest)
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

MetricSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a metric to optimize.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
metric_id	str Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.
goal	google.cloud.aiplatform_v1.types.StudySpec.MetricSpec.GoalType Required. The optimization goal of the metric.
safety_config	google.cloud.aiplatform_v1.types.StudySpec.MetricSpec.SafetyMetricConfig Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric. This field is a member of oneof_ _safety_config.

Inheritance

builtins.object > proto.message.Message > MetricSpec

Classes

GoalType

GoalType(value)

The available types of optimization goals.

Values: GOAL_TYPE_UNSPECIFIED (0): Goal Type will default to maximize. MAXIMIZE (1): Maximize the goal metric. MINIMIZE (2): Minimize the goal metric.

SafetyMetricConfig

SafetyMetricConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Used in safe optimization to specify threshold levels and risk tolerance.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields