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()
Methods
public StudySpec.MetricSpec.SafetyMetricConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig build()
public StudySpec.MetricSpec.SafetyMetricConfig buildPartial()
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clear()
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)
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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()
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
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;
| Returns |
|---|
| 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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
boolean | Whether the desiredMinSafeTrialsFraction field is set.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(StudySpec.MetricSpec.SafetyMetricConfig other)
public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
public final StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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;
| Parameter |
|---|
| Name | Description |
value | double
The desiredMinSafeTrialsFraction to set.
|
public StudySpec.MetricSpec.SafetyMetricConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public StudySpec.MetricSpec.SafetyMetricConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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;
| Parameter |
|---|
| Name | Description |
value | double
The safetyThreshold to set.
|
public final StudySpec.MetricSpec.SafetyMetricConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
