Class: Google::Cloud::AIPlatform::V1::ModelMonitoringObjectiveConfig::ExplanationConfig

Inherits:

Object

Object
Google::Cloud::AIPlatform::V1::ModelMonitoringObjectiveConfig::ExplanationConfig

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb

Overview

The config for integrating with Vertex Explainable AI. Only applicable if the Model has explanation_spec populated.

Defined Under Namespace

Classes: ExplanationBaseline

Instance Attribute Summary collapse

#enable_feature_attributes ⇒ ::Boolean
If want to analyze the Vertex Explainable AI feature attribute scores or not.
#explanation_baseline ⇒ ::Google::Cloud::AIPlatform::V1::ModelMonitoringObjectiveConfig::ExplanationConfig::ExplanationBaseline
Predictions generated by the BatchPredictionJob using baseline dataset.

Instance Attribute Details

#enable_feature_attributes ⇒ `::Boolean`

Returns If want to analyze the Vertex Explainable AI feature attribute scores or not. If set to true, Vertex AI will log the feature attributions from explain response and do the skew/drift detection for them.

Returns:

(::Boolean) —
If want to analyze the Vertex Explainable AI feature attribute scores or not. If set to true, Vertex AI will log the feature attributions from explain response and do the skew/drift detection for them.

# File 'proto_docs/google/cloud/aiplatform/v1/model_monitoring.rb', line 178

class ExplanationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Output from
  # {::Google::Cloud::AIPlatform::V1::BatchPredictionJob BatchPredictionJob} for
  # Model Monitoring baseline dataset, which can be used to generate baseline
  # attribution scores.
  # @!attribute [rw] gcs
  #   @return [::Google::Cloud::AIPlatform::V1::GcsDestination]
  #     Cloud Storage location for BatchExplain output.
  #
  #     Note: The following fields are mutually exclusive: `gcs`, `bigquery`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] bigquery
  #   @return [::Google::Cloud::AIPlatform::V1::BigQueryDestination]
  #     BigQuery location for BatchExplain output.
  #
  #     Note: The following fields are mutually exclusive: `bigquery`, `gcs`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] prediction_format
  #   @return [::Google::Cloud::AIPlatform::V1::ModelMonitoringObjectiveConfig::ExplanationConfig::ExplanationBaseline::PredictionFormat]
  #     The storage format of the predictions generated BatchPrediction job.
  class ExplanationBaseline
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The storage format of the predictions generated BatchPrediction job.
    module PredictionFormat
      # Should not be set.
      PREDICTION_FORMAT_UNSPECIFIED = 0

      # Predictions are in JSONL files.
      JSONL = 2

      # Predictions are in BigQuery.
      BIGQUERY = 3
    end
  end
end

#explanation_baseline ⇒ `::Google::Cloud::AIPlatform::V1::ModelMonitoringObjectiveConfig::ExplanationConfig::ExplanationBaseline`

Returns Predictions generated by the BatchPredictionJob using baseline dataset.