com.google.cloud.aiplatform.v1beta1

Interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

StudySpec.MetricSpec.SafetyMetricConfig, StudySpec.MetricSpec.SafetyMetricConfig.Builder

Enclosing class:

StudySpec.MetricSpec

public static interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
double	getDesiredMinSafeTrialsFraction() 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).
double	getSafetyThreshold() Safety threshold (boundary value between safe and unsafe).
boolean	hasDesiredMinSafeTrialsFraction() 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).

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSafetyThreshold

double getSafetyThreshold()

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

double safety_threshold = 1;

Returns:

The safetyThreshold.

hasDesiredMinSafeTrialsFraction

boolean hasDesiredMinSafeTrialsFraction()

 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.
 

optional double desired_min_safe_trials_fraction = 2;

Returns:

Whether the desiredMinSafeTrialsFraction field is set.

getDesiredMinSafeTrialsFraction

double getDesiredMinSafeTrialsFraction()

 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.
 

optional double desired_min_safe_trials_fraction = 2;

Returns:

The desiredMinSafeTrialsFraction.