Interface AttributionOrBuilder (3.50.0)

Version 3.50.0

• 3.54.0 (latest)
• 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 interface AttributionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApproximationError()

public abstract double getApproximationError()

Output only. Error of feature_attributions caused by approximation used in the explanation method. Lower value means more precise attributions.

• For Sampled Shapley attribution, increasing path_count might reduce the error.
• For Integrated Gradients attribution, increasing step_count might reduce the error.

• For XRAI attribution, increasing step_count might reduce the error.

  See this introduction for more information.

double approximation_error = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
double	The approximationError.

getBaselineOutputValue()

public abstract double getBaselineOutputValue()

Output only. Model predicted output if the input instance is constructed from the baselines of all the features defined in ExplanationMetadata.inputs. The field name of the output is determined by the key in ExplanationMetadata.outputs.

If the Model's predicted output has multiple dimensions (rank > 1), this is the value in the output located by output_index.

If there are multiple baselines, their output values are averaged.

double baseline_output_value = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
double	The baselineOutputValue.

getFeatureAttributions()

public abstract Value getFeatureAttributions()

Output only. Attributions of each explained feature. Features are extracted from the prediction instances according to explanation metadata for inputs.

The value is a struct, whose keys are the name of the feature. The values are how much the feature in the instance contributed to the predicted result.

The format of the value is determined by the feature's input format:

• If the feature is a scalar value, the attribution value is a floating number.

• If the feature is an array of scalar values, the attribution value is an array.

• If the feature is a struct, the attribution value is a struct. The keys in the attribution value struct are the same as the keys in the feature struct. The formats of the values in the attribution struct are determined by the formats of the values in the feature struct.

  The ExplanationMetadata.feature_attributions_schema_uri field, pointed to by the ExplanationSpec field of the Endpoint.deployed_models object, points to the schema file that describes the features and their attribution values (if it is populated).

.google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Value	The featureAttributions.

getFeatureAttributionsOrBuilder()

public abstract ValueOrBuilder getFeatureAttributionsOrBuilder()

Output only. Attributions of each explained feature. Features are extracted from the prediction instances according to explanation metadata for inputs.

The value is a struct, whose keys are the name of the feature. The values are how much the feature in the instance contributed to the predicted result.

The format of the value is determined by the feature's input format:

• If the feature is a scalar value, the attribution value is a floating number.

• If the feature is an array of scalar values, the attribution value is an array.

• If the feature is a struct, the attribution value is a struct. The keys in the attribution value struct are the same as the keys in the feature struct. The formats of the values in the attribution struct are determined by the formats of the values in the feature struct.

  The ExplanationMetadata.feature_attributions_schema_uri field, pointed to by the ExplanationSpec field of the Endpoint.deployed_models object, points to the schema file that describes the features and their attribution values (if it is populated).

.google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ValueOrBuilder

getInstanceOutputValue()

public abstract double getInstanceOutputValue()

Output only. Model predicted output on the corresponding explanation instance. The field name of the output is determined by the key in ExplanationMetadata.outputs.

If the Model predicted output has multiple dimensions, this is the value in the output located by output_index.

double instance_output_value = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
double	The instanceOutputValue.

getOutputDisplayName()

public abstract String getOutputDisplayName()

Output only. The display name of the output identified by output_index. For example, the predicted class name by a multi-classification Model.

This field is only populated iff the Model predicts display names as a separate field along with the explained output. The predicted display name must has the same shape of the explained output, and can be located using output_index.

string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The outputDisplayName.

getOutputDisplayNameBytes()

public abstract ByteString getOutputDisplayNameBytes()

Output only. The display name of the output identified by output_index. For example, the predicted class name by a multi-classification Model.

This field is only populated iff the Model predicts display names as a separate field along with the explained output. The predicted display name must has the same shape of the explained output, and can be located using output_index.

string output_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for outputDisplayName.

getOutputIndex(int index)

public abstract int getOutputIndex(int index)

Output only. The index that locates the explained prediction output.

If the prediction output is a scalar value, output_index is not populated. If the prediction output has multiple dimensions, the length of the output_index list is the same as the number of dimensions of the output. The i-th element in output_index is the element index of the i-th dimension of the output vector. Indices start from 0.

repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
int	The outputIndex at the given index.

getOutputIndexCount()

public abstract int getOutputIndexCount()

Output only. The index that locates the explained prediction output.

If the prediction output is a scalar value, output_index is not populated. If the prediction output has multiple dimensions, the length of the output_index list is the same as the number of dimensions of the output. The i-th element in output_index is the element index of the i-th dimension of the output vector. Indices start from 0.

repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The count of outputIndex.

getOutputIndexList()

public abstract List<Integer> getOutputIndexList()

Output only. The index that locates the explained prediction output.

If the prediction output is a scalar value, output_index is not populated. If the prediction output has multiple dimensions, the length of the output_index list is the same as the number of dimensions of the output. The i-th element in output_index is the element index of the i-th dimension of the output vector. Indices start from 0.

repeated int32 output_index = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Integer>	A list containing the outputIndex.

getOutputName()

public abstract String getOutputName()

Output only. Name of the explain output. Specified as the key in ExplanationMetadata.outputs.

string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The outputName.

getOutputNameBytes()

public abstract ByteString getOutputNameBytes()

Output only. Name of the explain output. Specified as the key in ExplanationMetadata.outputs.

string output_name = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for outputName.

hasFeatureAttributions()

public abstract boolean hasFeatureAttributions()

Output only. Attributions of each explained feature. Features are extracted from the prediction instances according to explanation metadata for inputs.

The value is a struct, whose keys are the name of the feature. The values are how much the feature in the instance contributed to the predicted result.

The format of the value is determined by the feature's input format:

• If the feature is a scalar value, the attribution value is a floating number.

• If the feature is an array of scalar values, the attribution value is an array.

• If the feature is a struct, the attribution value is a struct. The keys in the attribution value struct are the same as the keys in the feature struct. The formats of the values in the attribution struct are determined by the formats of the values in the feature struct.

  The ExplanationMetadata.feature_attributions_schema_uri field, pointed to by the ExplanationSpec field of the Endpoint.deployed_models object, points to the schema file that describes the features and their attribution values (if it is populated).

.google.protobuf.Value feature_attributions = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the featureAttributions field is set.