Class StudySpec.MetricSpec.SafetyMetricConfig.Builder (3.43.0)

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.v1.StudySpec.MetricSpec.SafetyMetricConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

build()

public StudySpec.MetricSpec.SafetyMetricConfig build()
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig

buildPartial()

public StudySpec.MetricSpec.SafetyMetricConfig buildPartial()
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig

clear()

public StudySpec.MetricSpec.SafetyMetricConfig.Builder clear()
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

clearDesiredMinSafeTrialsFraction()

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;

Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

clearSafetyThreshold()

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;

Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder

This builder for chaining.

clone()

public StudySpec.MetricSpec.SafetyMetricConfig.Builder clone()
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

getDefaultInstanceForType()

public StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstanceForType()
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDesiredMinSafeTrialsFraction()

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.

getSafetyThreshold()

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.

hasDesiredMinSafeTrialsFraction()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StudySpec.MetricSpec.SafetyMetricConfig other)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(StudySpec.MetricSpec.SafetyMetricConfig other)
Parameter
Name Description
other StudySpec.MetricSpec.SafetyMetricConfig
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MetricSpec.SafetyMetricConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

setDesiredMinSafeTrialsFraction(double value)

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.

Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StudySpec.MetricSpec.SafetyMetricConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides

setSafetyThreshold(double value)

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.

Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final StudySpec.MetricSpec.SafetyMetricConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StudySpec.MetricSpec.SafetyMetricConfig.Builder
Overrides