Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Attribution (v0.31.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Attribution.

Attribution that explains a particular prediction output.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#approximation_error

def approximation_error() -> ::Float
Returns
  • (::Float) — 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][google.cloud.aiplatform.v1.ExplanationParameters.xrai_attribution], increasing step_count might reduce the error.

    See this introduction for more information.

#baseline_output_value

def baseline_output_value() -> ::Float
Returns
  • (::Float) — 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.

#feature_attributions

def feature_attributions() -> ::Google::Protobuf::Value
Returns
  • (::Google::Protobuf::Value) — Output only. Attributions of each explained feature. Features are extracted from the [prediction instances][google.cloud.aiplatform.v1.ExplainRequest.instances] according to [explanation metadata for inputs][google.cloud.aiplatform.v1.ExplanationMetadata.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).

#instance_output_value

def instance_output_value() -> ::Float
Returns
  • (::Float) — Output only. Model predicted output on the corresponding [explanation instance][ExplainRequest.instances]. 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.

#output_display_name

def output_display_name() -> ::String
Returns
  • (::String) — 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.

#output_index

def output_index() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — 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.

#output_name

def output_name() -> ::String
Returns