public static final class StudySpec.MetricSpec.SafetyMetricConfig.Builder extends GeneratedMessageV3.Builder<StudySpec.MetricSpec.SafetyMetricConfig.Builder> implements StudySpec.MetricSpec.SafetyMetricConfigOrBuilder
Used in safe optimization to specify threshold levels and risk tolerance.
Protobuf type
google.cloud.aiplatform.v1beta1.StudySpec.MetricSpec.SafetyMetricConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
public StudySpec.MetricSpec.SafetyMetricConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig build()
Returns
public StudySpec.MetricSpec.SafetyMetricConfig buildPartial()
Returns
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clear()
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearDesiredMinSafeTrialsFraction()
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;
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearSafetyThreshold()
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;
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clone()
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstanceForType()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
public 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;
| Type | Description |
double | The desiredMinSafeTrialsFraction.
|
public 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;
| Type | Description |
double | The safetyThreshold.
|
public 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;
| Type | Description |
boolean | Whether the desiredMinSafeTrialsFraction field is set.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(StudySpec.MetricSpec.SafetyMetricConfig other)
Parameter
Returns
public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder setDesiredMinSafeTrialsFraction(double value)
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;
| Name | Description |
value | double
The desiredMinSafeTrialsFraction to set.
|
Returns
public StudySpec.MetricSpec.SafetyMetricConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder setSafetyThreshold(double value)
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;
| Name | Description |
value | double
The safetyThreshold to set.
|
Returns
public final StudySpec.MetricSpec.SafetyMetricConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
