Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecMetricSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

Represents a metric to optimize.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1StudySpecMetricSpec

Returns a new instance of GoogleCloudAiplatformV1StudySpecMetricSpec.



25726
25727
25728
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25726

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#goal ⇒ String

Required. The optimization goal of the metric. Corresponds to the JSON property goal

Returns:

  • (String) 


25713
25714
25715
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25713

def goal
  @goal
end

#metric_id ⇒ String

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs. Corresponds to the JSON property metricId

Returns:

  • (String) 


25719
25720
25721
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25719

def metric_id
  @metric_id
end

#safety_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecMetricSpecSafetyMetricConfig

Used in safe optimization to specify threshold levels and risk tolerance. Corresponds to the JSON property safetyConfig

Returns:



25724
25725
25726
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25724

def safety_config
  @safety_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



25731
25732
25733
25734
25735
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25731

def update!(**args)
  @goal = args[:goal] if args.key?(:goal)
  @metric_id = args[:metric_id] if args.key?(:metric_id)
  @safety_config = args[:safety_config] if args.key?(:safety_config)
end