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.