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 Classes: SafetyMetricConfig

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Required. The optimization goal of the metric.

Returns:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 266

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

  # Used in safe optimization to specify threshold levels and risk tolerance.
  # @!attribute [rw] safety_threshold
  #   @return [::Float]
  #     Safety threshold (boundary value between safe and unsafe). NOTE that if
  #     you leave SafetyMetricConfig unset, a default value of 0 will be used.
  # @!attribute [rw] desired_min_safe_trials_fraction
  #   @return [::Float]
  #     Desired minimum fraction of safe trials (over total number of trials)
  #     that should be targeted by the algorithm at any time during the
  #     study (best effort). This should be between 0.0 and 1.0 and a value of
  #     0.0 means that there is no minimum and an algorithm proceeds without
  #     targeting any specific fraction. A value of 1.0 means that the
  #     algorithm attempts to only Suggest safe Trials.
  class SafetyMetricConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 266

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

  # Used in safe optimization to specify threshold levels and risk tolerance.
  # @!attribute [rw] safety_threshold
  #   @return [::Float]
  #     Safety threshold (boundary value between safe and unsafe). NOTE that if
  #     you leave SafetyMetricConfig unset, a default value of 0 will be used.
  # @!attribute [rw] desired_min_safe_trials_fraction
  #   @return [::Float]
  #     Desired minimum fraction of safe trials (over total number of trials)
  #     that should be targeted by the algorithm at any time during the
  #     study (best effort). This should be between 0.0 and 1.0 and a value of
  #     0.0 means that there is no minimum and an algorithm proceeds without
  #     targeting any specific fraction. A value of 1.0 means that the
  #     algorithm attempts to only Suggest safe Trials.
  class SafetyMetricConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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

#safety_config ⇒ ::Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::SafetyMetricConfig

Returns Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

Returns:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 266

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

  # Used in safe optimization to specify threshold levels and risk tolerance.
  # @!attribute [rw] safety_threshold
  #   @return [::Float]
  #     Safety threshold (boundary value between safe and unsafe). NOTE that if
  #     you leave SafetyMetricConfig unset, a default value of 0 will be used.
  # @!attribute [rw] desired_min_safe_trials_fraction
  #   @return [::Float]
  #     Desired minimum fraction of safe trials (over total number of trials)
  #     that should be targeted by the algorithm at any time during the
  #     study (best effort). This should be between 0.0 and 1.0 and a value of
  #     0.0 means that there is no minimum and an algorithm proceeds without
  #     targeting any specific fraction. A value of 1.0 means that the
  #     algorithm attempts to only Suggest safe Trials.
  class SafetyMetricConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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