Class IntegratedGradientsAttribution (3.18.0)

Version 3.18.0

• 3.56.0 (latest)
• 3.55.0
• 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 final class IntegratedGradientsAttribution extends GeneratedMessageV3 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

Inheritance

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

Implements

IntegratedGradientsAttributionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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;

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.aiplatform.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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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;

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.aiplatform.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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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;

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.aiplatform.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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public IntegratedGradientsAttribution.Builder newBuilderForType()

Returns
Type	Description
IntegratedGradientsAttribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IntegratedGradientsAttribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
IntegratedGradientsAttribution.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public IntegratedGradientsAttribution.Builder toBuilder()

Returns
Type	Description
IntegratedGradientsAttribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException