Class: Google::Cloud::AIPlatform::V1::ExplanationMetadata::OutputMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb

Overview

Metadata of the prediction output to be explained.

Instance Attribute Summary collapse

Instance Attribute Details

#display_name_mapping_key ⇒ ::String

Returns Specify a field name in the prediction to look for the display name.

Use this if the prediction contains the display names for the outputs.

The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.

Note: The following fields are mutually exclusive: display_name_mapping_key, index_display_name_mapping. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Specify a field name in the prediction to look for the display name.

    Use this if the prediction contains the display names for the outputs.

    The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.

    Note: The following fields are mutually exclusive: display_name_mapping_key, index_display_name_mapping. If a field in that set is populated, all other fields in the set will automatically be cleared.



420
421
422
423
 
# File 'proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb', line 420

class OutputMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#index_display_name_mapping ⇒ ::Google::Protobuf::Value

Returns Static mapping between the index and display name.

Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values.

The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.

Note: The following fields are mutually exclusive: index_display_name_mapping, display_name_mapping_key. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Value) —

    Static mapping between the index and display name.

    Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values.

    The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.

    Note: The following fields are mutually exclusive: index_display_name_mapping, display_name_mapping_key. If a field in that set is populated, all other fields in the set will automatically be cleared.



420
421
422
423
 
# File 'proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb', line 420

class OutputMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#output_tensor_name ⇒ ::String

Returns Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.

Returns:

  • (::String) —

    Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.



420
421
422
423
 
# File 'proto_docs/google/cloud/aiplatform/v1/explanation_metadata.rb', line 420

class OutputMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end