Class XraiAttribution (2.9.7)

public final class XraiAttribution extends GeneratedMessageV3 implements XraiAttributionOrBuilder

An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models.

Protobuf type google.cloud.aiplatform.v1.XraiAttribution

Static Fields

BLUR_BASELINE_CONFIG_FIELD_NUMBER

public static final int BLUR_BASELINE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SMOOTH_GRAD_CONFIG_FIELD_NUMBER

public static final int SMOOTH_GRAD_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

STEP_COUNT_FIELD_NUMBER

public static final int STEP_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static XraiAttribution getDefaultInstance()
Returns
TypeDescription
XraiAttribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static XraiAttribution.Builder newBuilder()
Returns
TypeDescription
XraiAttribution.Builder

newBuilder(XraiAttribution prototype)

public static XraiAttribution.Builder newBuilder(XraiAttribution prototype)
Parameter
NameDescription
prototypeXraiAttribution
Returns
TypeDescription
XraiAttribution.Builder

parseDelimitedFrom(InputStream input)

public static XraiAttribution parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static XraiAttribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static XraiAttribution parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static XraiAttribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static XraiAttribution parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static XraiAttribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static XraiAttribution parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static XraiAttribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static XraiAttribution parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static XraiAttribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static XraiAttribution parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static XraiAttribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XraiAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<XraiAttribution> parser()
Returns
TypeDescription
Parser<XraiAttribution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBlurBaselineConfig()

public BlurBaselineConfig getBlurBaselineConfig()

Config for XRAI 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
TypeDescription
BlurBaselineConfig

The blurBaselineConfig.

getBlurBaselineConfigOrBuilder()

public BlurBaselineConfigOrBuilder getBlurBaselineConfigOrBuilder()

Config for XRAI 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
TypeDescription
BlurBaselineConfigOrBuilder

getDefaultInstanceForType()

public XraiAttribution getDefaultInstanceForType()
Returns
TypeDescription
XraiAttribution

getParserForType()

public Parser<XraiAttribution> getParserForType()
Returns
TypeDescription
Parser<XraiAttribution>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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.aiplatform.v1.SmoothGradConfig smooth_grad_config = 2;

Returns
TypeDescription
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
TypeDescription
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 met within the desired error range. Valid range of its value is [1, 100], inclusively.

int32 step_count = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The stepCount.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasBlurBaselineConfig()

public boolean hasBlurBaselineConfig()

Config for XRAI 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
TypeDescription
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
TypeDescription
boolean

Whether the smoothGradConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public XraiAttribution.Builder newBuilderForType()
Returns
TypeDescription
XraiAttribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected XraiAttribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
XraiAttribution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public XraiAttribution.Builder toBuilder()
Returns
TypeDescription
XraiAttribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException