Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec (v0.40.0)

Version 0.40.0

• 0.61.0 (latest)
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec.

Represents a metric to optimize.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#goal

def goal() -> ::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::GoalType

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::GoalType) — Required. The optimization goal of the metric.

#goal=

def goal=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::GoalType

Parameter

• value (::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::GoalType) — Required. The optimization goal of the metric.

Returns

• (::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::GoalType) — Required. The optimization goal of the metric.

#metric_id

def metric_id() -> ::String

Returns

• (::String) — Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

#metric_id=

def metric_id=(value) -> ::String

Parameter

• value (::String) — Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

Returns

• (::String) — Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

#safety_config

def safety_config() -> ::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::SafetyMetricConfig

Returns

• (::Google::Cloud::AIPlatform::V1::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.

#safety_config=

def safety_config=(value) -> ::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::SafetyMetricConfig

Parameter

• value (::Google::Cloud::AIPlatform::V1::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.

Returns

• (::Google::Cloud::AIPlatform::V1::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.