Package com.google.cloud.aiplatform.v1

Class StudySpec.MetricSpec.SafetyMetricConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig
All Implemented Interfaces:
StudySpec.MetricSpec.SafetyMetricConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
StudySpec.MetricSpec
public static final class StudySpec.MetricSpec.SafetyMetricConfig extends com.google.protobuf.GeneratedMessage implements StudySpec.MetricSpec.SafetyMetricConfigOrBuilder
 Used in safe optimization to specify threshold levels and risk tolerance.
Protobuf type google.cloud.aiplatform.v1.StudySpec.MetricSpec.SafetyMetricConfig
See Also:

  • Field Details

    • SAFETY_THRESHOLD_FIELD_NUMBER

      public static final int SAFETY_THRESHOLD_FIELD_NUMBER
      See Also:

    • DESIRED_MIN_SAFE_TRIALS_FRACTION_FIELD_NUMBER

      public static final int DESIRED_MIN_SAFE_TRIALS_FRACTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getSafetyThreshold in interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder
      Returns:
      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;
      Specified by:
      hasDesiredMinSafeTrialsFraction in interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder
      Returns:
      Whether the desiredMinSafeTrialsFraction field is set.

    • 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;
      Specified by:
      getDesiredMinSafeTrialsFraction in interface StudySpec.MetricSpec.SafetyMetricConfigOrBuilder
      Returns:
      The desiredMinSafeTrialsFraction.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StudySpec.MetricSpec.SafetyMetricConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilder()

    • newBuilder

      public static StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilder(StudySpec.MetricSpec.SafetyMetricConfig prototype)

    • toBuilder

      public StudySpec.MetricSpec.SafetyMetricConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StudySpec.MetricSpec.SafetyMetricConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StudySpec.MetricSpec.SafetyMetricConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<StudySpec.MetricSpec.SafetyMetricConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public StudySpec.MetricSpec.SafetyMetricConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder