Class IntegratedGradientsAttribution (1.48.0) 

public final class IntegratedGradientsAttribution extends 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.vertexai.v1.IntegratedGradientsAttribution

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > IntegratedGradientsAttribution

Static Fields

BLUR_BASELINE_CONFIG_FIELD_NUMBER

public static final int BLUR_BASELINE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SMOOTH_GRAD_CONFIG_FIELD_NUMBER

public static final int SMOOTH_GRAD_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

STEP_COUNT_FIELD_NUMBER

public static final int STEP_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IntegratedGradientsAttribution getDefaultInstance()
Returns
Type Description
IntegratedGradientsAttribution

getDescriptor()

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

newBuilder()

public static IntegratedGradientsAttribution.Builder newBuilder()
Returns
Type Description
IntegratedGradientsAttribution.Builder

newBuilder(IntegratedGradientsAttribution prototype)

public static IntegratedGradientsAttribution.Builder newBuilder(IntegratedGradientsAttribution prototype)
Parameter
Name Description
prototype IntegratedGradientsAttribution
Returns
Type Description
IntegratedGradientsAttribution.Builder

parseDelimitedFrom(InputStream input)

public static IntegratedGradientsAttribution parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IntegratedGradientsAttribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IntegratedGradientsAttribution parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IntegratedGradientsAttribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IntegratedGradientsAttribution parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IntegratedGradientsAttribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IntegratedGradientsAttribution parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IntegratedGradientsAttribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IntegratedGradientsAttribution parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IntegratedGradientsAttribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IntegratedGradientsAttribution parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IntegratedGradientsAttribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IntegratedGradientsAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IntegratedGradientsAttribution> parser()
Returns
Type Description
Parser<IntegratedGradientsAttribution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.vertexai.v1.BlurBaselineConfig blur_baseline_config = 3;

Returns
Type Description
BlurBaselineConfig

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.vertexai.v1.BlurBaselineConfig blur_baseline_config = 3;

Returns
Type Description
BlurBaselineConfigOrBuilder

getDefaultInstanceForType()

public IntegratedGradientsAttribution getDefaultInstanceForType()
Returns
Type Description
IntegratedGradientsAttribution

getParserForType()

public Parser<IntegratedGradientsAttribution> getParserForType()
Returns
Type Description
Parser<IntegratedGradientsAttribution>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.vertexai.v1.SmoothGradConfig smooth_grad_config = 2;

Returns
Type Description
SmoothGradConfig

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.vertexai.v1.SmoothGradConfig smooth_grad_config = 2;

Returns
Type Description
SmoothGradConfigOrBuilder

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];

Returns
Type Description
int

The stepCount.

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.vertexai.v1.BlurBaselineConfig blur_baseline_config = 3;

Returns
Type Description
boolean

Whether the blurBaselineConfig field is set.

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.vertexai.v1.SmoothGradConfig smooth_grad_config = 2;

Returns
Type Description
boolean

Whether the smoothGradConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IntegratedGradientsAttribution.Builder newBuilderForType()
Returns
Type Description
IntegratedGradientsAttribution.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected IntegratedGradientsAttribution.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IntegratedGradientsAttribution.Builder
Overrides

toBuilder()

public IntegratedGradientsAttribution.Builder toBuilder()
Returns
Type Description
IntegratedGradientsAttribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException