Class SmoothGradConfig (3.45.0)

public final class SmoothGradConfig extends 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

Static Fields

FEATURE_NOISE_SIGMA_FIELD_NUMBER

public static final int FEATURE_NOISE_SIGMA_FIELD_NUMBER
Field Value
Type Description
int

NOISE_SIGMA_FIELD_NUMBER

public static final int NOISE_SIGMA_FIELD_NUMBER
Field Value
Type Description
int

NOISY_SAMPLE_COUNT_FIELD_NUMBER

public static final int NOISY_SAMPLE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SmoothGradConfig getDefaultInstance()
Returns
Type Description
SmoothGradConfig

getDescriptor()

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

newBuilder()

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

newBuilder(SmoothGradConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SmoothGradConfig getDefaultInstanceForType()
Returns
Type Description
SmoothGradConfig

getFeatureNoiseSigma()

public FeatureNoiseSigma getFeatureNoiseSigma()

This is similar to 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 will be used for all features.

.google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;

Returns
Type Description
FeatureNoiseSigma

The featureNoiseSigma.

getFeatureNoiseSigmaOrBuilder()

public FeatureNoiseSigmaOrBuilder getFeatureNoiseSigmaOrBuilder()

This is similar to 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 will be used for all features.

.google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;

Returns
Type Description
FeatureNoiseSigmaOrBuilder

getGradientNoiseSigmaCase()

public SmoothGradConfig.GradientNoiseSigmaCase getGradientNoiseSigmaCase()
Returns
Type Description
SmoothGradConfig.GradientNoiseSigmaCase

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.

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 instead for each feature.

float noise_sigma = 1;

Returns
Type Description
float

The noiseSigma.

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;

Returns
Type Description
int

The noisySampleCount.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasFeatureNoiseSigma()

public boolean hasFeatureNoiseSigma()

This is similar to 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 will be used for all features.

.google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;

Returns
Type Description
boolean

Whether the featureNoiseSigma field is set.

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.

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 instead for each feature.

float noise_sigma = 1;

Returns
Type Description
boolean

Whether the noiseSigma field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SmoothGradConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SmoothGradConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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