Package com.google.cloud.aiplatform.v1

Class IntegratedGradientsAttribution

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.IntegratedGradientsAttribution
All Implemented Interfaces:
IntegratedGradientsAttributionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class IntegratedGradientsAttribution extends com.google.protobuf.GeneratedMessage implements IntegratedGradientsAttributionOrBuilder
 An attribution method that computes the Aumann-Shapley value taking advantage
 of the model's fully differentiable structure. Refer to this paper for
 more details: https://arxiv.org/abs/1703.01365
Protobuf type google.cloud.aiplatform.v1.IntegratedGradientsAttribution
See Also:

  • Field Details

    • STEP_COUNT_FIELD_NUMBER

      public static final int STEP_COUNT_FIELD_NUMBER
      See Also:

    • SMOOTH_GRAD_CONFIG_FIELD_NUMBER

      public static final int SMOOTH_GRAD_CONFIG_FIELD_NUMBER
      See Also:

    • BLUR_BASELINE_CONFIG_FIELD_NUMBER

      public static final int BLUR_BASELINE_CONFIG_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

    • getStepCount

      public int getStepCount()
       Required. The number of steps for approximating the path integral.
 A good value to start is 50 and gradually increase until the
 sum to diff property is within the desired error range.

 Valid range of its value is [1, 100], inclusively.
      int32 step_count = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStepCount in interface IntegratedGradientsAttributionOrBuilder
      Returns:
      The stepCount.

    • hasSmoothGradConfig

      public boolean hasSmoothGradConfig()
       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
      .google.cloud.aiplatform.v1.SmoothGradConfig smooth_grad_config = 2;
      Specified by:
      hasSmoothGradConfig in interface IntegratedGradientsAttributionOrBuilder
      Returns:
      Whether the smoothGradConfig field is set.

    • getSmoothGradConfig

      public SmoothGradConfig getSmoothGradConfig()
       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
      .google.cloud.aiplatform.v1.SmoothGradConfig smooth_grad_config = 2;
      Specified by:
      getSmoothGradConfig in interface IntegratedGradientsAttributionOrBuilder
      Returns:
      The smoothGradConfig.

    • getSmoothGradConfigOrBuilder

      public SmoothGradConfigOrBuilder getSmoothGradConfigOrBuilder()
       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
      .google.cloud.aiplatform.v1.SmoothGradConfig smooth_grad_config = 2;
      Specified by:
      getSmoothGradConfigOrBuilder in interface IntegratedGradientsAttributionOrBuilder

    • hasBlurBaselineConfig

      public boolean hasBlurBaselineConfig()
       Config for IG with blur baseline.

 When enabled, a linear path from the maximally blurred image to the input
 image is created. Using a blurred baseline instead of zero (black image) is
 motivated by the BlurIG approach explained here:
 https://arxiv.org/abs/2004.03383
      .google.cloud.aiplatform.v1.BlurBaselineConfig blur_baseline_config = 3;
      Specified by:
      hasBlurBaselineConfig in interface IntegratedGradientsAttributionOrBuilder
      Returns:
      Whether the blurBaselineConfig field is set.

    • getBlurBaselineConfig

      public BlurBaselineConfig getBlurBaselineConfig()
       Config for IG with blur baseline.

 When enabled, a linear path from the maximally blurred image to the input
 image is created. Using a blurred baseline instead of zero (black image) is
 motivated by the BlurIG approach explained here:
 https://arxiv.org/abs/2004.03383
      .google.cloud.aiplatform.v1.BlurBaselineConfig blur_baseline_config = 3;
      Specified by:
      getBlurBaselineConfig in interface IntegratedGradientsAttributionOrBuilder
      Returns:
      The blurBaselineConfig.

    • getBlurBaselineConfigOrBuilder

      public BlurBaselineConfigOrBuilder getBlurBaselineConfigOrBuilder()
       Config for IG with blur baseline.

 When enabled, a linear path from the maximally blurred image to the input
 image is created. Using a blurred baseline instead of zero (black image) is
 motivated by the BlurIG approach explained here:
 https://arxiv.org/abs/2004.03383
      .google.cloud.aiplatform.v1.BlurBaselineConfig blur_baseline_config = 3;
      Specified by:
      getBlurBaselineConfigOrBuilder in interface IntegratedGradientsAttributionOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static IntegratedGradientsAttribution parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static IntegratedGradientsAttribution parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static IntegratedGradientsAttribution parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static IntegratedGradientsAttribution.Builder newBuilder()

    • newBuilder

      public static IntegratedGradientsAttribution.Builder newBuilder(IntegratedGradientsAttribution prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static IntegratedGradientsAttribution getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<IntegratedGradientsAttribution> parser()

    • getParserForType

      public com.google.protobuf.Parser<IntegratedGradientsAttribution> 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 IntegratedGradientsAttribution getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder