Package com.google.cloud.aiplatform.v1

Class SmoothGradConfig

  • All Implemented Interfaces:
    SmoothGradConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SmoothGradConfig
extends com.google.protobuf.GeneratedMessageV3
implements SmoothGradConfigOrBuilder
     Config for SmoothGrad approximation of gradients.

 When enabled, the gradients are approximated by averaging the gradients from
 noisy samples in the vicinity of the inputs. Adding noise can help improve
 the computed gradients. Refer to this paper for more details:
 https://arxiv.org/pdf/1706.03825.pdf
    Protobuf type google.cloud.aiplatform.v1.SmoothGradConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SmoothGradConfig.Builder
      Config for SmoothGrad approximation of gradients.
      static class  SmoothGradConfig.GradientNoiseSigmaCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FEATURE_NOISE_SIGMA_FIELD_NUMBER  
      static int NOISE_SIGMA_FIELD_NUMBER  
      static int NOISY_SAMPLE_COUNT_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • NOISE_SIGMA_FIELD_NUMBER

        public static final int NOISE_SIGMA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEATURE_NOISE_SIGMA_FIELD_NUMBER

        public static final int FEATURE_NOISE_SIGMA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NOISY_SAMPLE_COUNT_FIELD_NUMBER

        public static final int NOISY_SAMPLE_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • hasNoiseSigma

        public boolean hasNoiseSigma()
         This is a single float value and will be used to add noise to all the
 features. Use this field when all features are normalized to have the
 same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where
 features are normalized to have 0-mean and 1-variance. Learn more about
 [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization).

 For best results the recommended value is about 10% - 20% of the standard
 deviation of the input feature. Refer to section 3.2 of the SmoothGrad
 paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.

 If the distribution is different per feature, set
 [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma]
 instead for each feature.
        float noise_sigma = 1;
        Specified by:
        hasNoiseSigma in interface SmoothGradConfigOrBuilder
        Returns:
        Whether the noiseSigma field is set.

      • getNoiseSigma

        public float getNoiseSigma()
         This is a single float value and will be used to add noise to all the
 features. Use this field when all features are normalized to have the
 same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where
 features are normalized to have 0-mean and 1-variance. Learn more about
 [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization).

 For best results the recommended value is about 10% - 20% of the standard
 deviation of the input feature. Refer to section 3.2 of the SmoothGrad
 paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1.

 If the distribution is different per feature, set
 [feature_noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.feature_noise_sigma]
 instead for each feature.
        float noise_sigma = 1;
        Specified by:
        getNoiseSigma in interface SmoothGradConfigOrBuilder
        Returns:
        The noiseSigma.

      • hasFeatureNoiseSigma

        public boolean hasFeatureNoiseSigma()
         This is similar to
 [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma],
 but provides additional flexibility. A separate noise sigma can be
 provided for each feature, which is useful if their distributions are
 different. No noise is added to features that are not set. If this field
 is unset,
 [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
 will be used for all features.
        .google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;
        Specified by:
        hasFeatureNoiseSigma in interface SmoothGradConfigOrBuilder
        Returns:
        Whether the featureNoiseSigma field is set.

      • getFeatureNoiseSigma

        public FeatureNoiseSigma getFeatureNoiseSigma()
         This is similar to
 [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma],
 but provides additional flexibility. A separate noise sigma can be
 provided for each feature, which is useful if their distributions are
 different. No noise is added to features that are not set. If this field
 is unset,
 [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
 will be used for all features.
        .google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;
        Specified by:
        getFeatureNoiseSigma in interface SmoothGradConfigOrBuilder
        Returns:
        The featureNoiseSigma.

      • getFeatureNoiseSigmaOrBuilder

        public FeatureNoiseSigmaOrBuilder getFeatureNoiseSigmaOrBuilder()
         This is similar to
 [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma],
 but provides additional flexibility. A separate noise sigma can be
 provided for each feature, which is useful if their distributions are
 different. No noise is added to features that are not set. If this field
 is unset,
 [noise_sigma][google.cloud.aiplatform.v1.SmoothGradConfig.noise_sigma]
 will be used for all features.
        .google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;
        Specified by:
        getFeatureNoiseSigmaOrBuilder in interface SmoothGradConfigOrBuilder

      • getNoisySampleCount

        public int getNoisySampleCount()
         The number of gradient samples to use for
 approximation. The higher this number, the more accurate the gradient
 is, but the runtime complexity increases by this factor as well.
 Valid range of its value is [1, 50]. Defaults to 3.
        int32 noisy_sample_count = 3;
        Specified by:
        getNoisySampleCount in interface SmoothGradConfigOrBuilder
        Returns:
        The noisySampleCount.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 SmoothGradConfig parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SmoothGradConfig parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SmoothGradConfig parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SmoothGradConfig parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SmoothGradConfig parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static SmoothGradConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SmoothGradConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<SmoothGradConfig> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public SmoothGradConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder