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

Inherits:

Object

Object
Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::SafetyMetricConfig

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/aiplatform/v1/study.rb

Overview

Used in safe optimization to specify threshold levels and risk tolerance.

Instance Attribute Summary collapse

#desired_min_safe_trials_fraction ⇒ ::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).
#safety_threshold ⇒ ::Float
Safety threshold (boundary value between safe and unsafe).

Instance Attribute Details

#desired_min_safe_trials_fraction ⇒ `::Float`

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

Returns:

(::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.

# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 283

class SafetyMetricConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#safety_threshold ⇒ `::Float`

Returns Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.