Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::StudySpec::MetricSpec::SafetyMetricConfig.
Used in safe optimization to specify threshold levels and risk tolerance.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#desired_min_safe_trials_fraction
def desired_min_safe_trials_fraction() -> ::Float
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.
#desired_min_safe_trials_fraction=
def desired_min_safe_trials_fraction=(value) -> ::Float
Parameter
- value (::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.
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.
#safety_threshold
def safety_threshold() -> ::Float
Returns
- (::Float) — Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.
#safety_threshold=
def safety_threshold=(value) -> ::Float
Parameter
- value (::Float) — Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.
Returns
- (::Float) — Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.