Class: Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/study.rb

Overview

Represents a metric to optimize.

Defined Under Namespace

Modules: GoalType

Instance Attribute Summary collapse

Instance Attribute Details

#goal ⇒ ::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::GoalType

Returns Required. The optimization goal of the metric.

Returns:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 222

class MetricSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The available types of optimization goals.
  module GoalType
    # Goal Type will default to maximize.
    GOAL_TYPE_UNSPECIFIED = 0

    # Maximize the goal metric.
    MAXIMIZE = 1

    # Minimize the goal metric.
    MINIMIZE = 2
  end
end

#metric_id ⇒ ::String

Returns 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.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 222

class MetricSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The available types of optimization goals.
  module GoalType
    # Goal Type will default to maximize.
    GOAL_TYPE_UNSPECIFIED = 0

    # Maximize the goal metric.
    MAXIMIZE = 1

    # Minimize the goal metric.
    MINIMIZE = 2
  end
end