- 3.55.0 (latest)
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class StudySpec.MetricSpec.SafetyMetricConfig extends GeneratedMessageV3 implements StudySpec.MetricSpec.SafetyMetricConfigOrBuilder
Used in safe optimization to specify threshold levels and risk tolerance.
Protobuf type google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StudySpec.MetricSpec.SafetyMetricConfigStatic Fields
DESIRED_MIN_SAFE_TRIALS_FRACTION_FIELD_NUMBER
public static final int DESIRED_MIN_SAFE_TRIALS_FRACTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SAFETY_THRESHOLD_FIELD_NUMBER
public static final int SAFETY_THRESHOLD_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstance()
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilder()
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig.Builder |
newBuilder(StudySpec.MetricSpec.SafetyMetricConfig prototype)
public static StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilder(StudySpec.MetricSpec.SafetyMetricConfig prototype)
Parameter | |
---|---|
Name | Description |
prototype |
StudySpec.MetricSpec.SafetyMetricConfig |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig.Builder |
parseDelimitedFrom(InputStream input)
public static StudySpec.MetricSpec.SafetyMetricConfig parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec.MetricSpec.SafetyMetricConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<StudySpec.MetricSpec.SafetyMetricConfig> parser()
Returns | |
---|---|
Type | Description |
Parser<SafetyMetricConfig> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig |
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. |
getParserForType()
public Parser<StudySpec.MetricSpec.SafetyMetricConfig> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<SafetyMetricConfig> |
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. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public StudySpec.MetricSpec.SafetyMetricConfig.Builder toBuilder()
Returns | |
---|---|
Type | Description |
StudySpec.MetricSpec.SafetyMetricConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |