Google Cloud Ai Platform V1 Client - Class SmoothGradConfig (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SmoothGradConfig.

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

Generated from protobuf message google.cloud.aiplatform.v1.SmoothGradConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ noise_sigma float

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.

↳ feature_noise_sigma Google\Cloud\AIPlatform\V1\FeatureNoiseSigma

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.

↳ noisy_sample_count int

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.

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.

Generated from protobuf field float noise_sigma = 1;

Returns
TypeDescription
float

hasNoiseSigma

setNoiseSigma

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.

Generated from protobuf field float noise_sigma = 1;

Parameter
NameDescription
var float
Returns
TypeDescription
$this

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.

Generated from protobuf field .google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\FeatureNoiseSigma|null

hasFeatureNoiseSigma

setFeatureNoiseSigma

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.

Generated from protobuf field .google.cloud.aiplatform.v1.FeatureNoiseSigma feature_noise_sigma = 2;

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\FeatureNoiseSigma
Returns
TypeDescription
$this

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.

Generated from protobuf field int32 noisy_sample_count = 3;

Returns
TypeDescription
int

setNoisySampleCount

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.

Generated from protobuf field int32 noisy_sample_count = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getGradientNoiseSigma

Returns
TypeDescription
string