Class: Aws::SageMaker::Types::ClarifyShapBaselineConfig

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ClarifyShapBaselineConfig

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

The configuration for the [SHAP baseline] (also called the background or reference dataset) of the Kernal SHAP algorithm.

<note markdown=“1”> * The number of records in the baseline data determines the size of

the synthetic dataset, which has an impact on latency of
explainability requests. For more information, see the **Synthetic
data** of [Configure and create an endpoint][2].

• ‘ShapBaseline` and `ShapBaselineUri` are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.

</note>

[1]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #mime_type ⇒ String

  The MIME type of the baseline data.

• #shap_baseline ⇒ String

  The inline SHAP baseline data in string format.

• #shap_baseline_uri ⇒ String

  The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored.

Instance Attribute Details

#mime_type ⇒ String

The MIME type of the baseline data. Choose from ‘’text/csv’‘ or `’application/jsonlines’‘. Defaults to `’text/csv’‘.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3735

class ClarifyShapBaselineConfig < Struct.new(
  :mime_type,
  :shap_baseline,
  :shap_baseline_uri)
  SENSITIVE = []
  include Aws::Structure
end

#shap_baseline ⇒ String

The inline SHAP baseline data in string format. ‘ShapBaseline` can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the `Granularity` of the `TextConfig` parameter. The size limit for `ShapBasline` is 4 KB. Use the `ShapBaselineUri` parameter if you want to provide more than 4 KB of baseline data.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3735

class ClarifyShapBaselineConfig < Struct.new(
  :mime_type,
  :shap_baseline,
  :shap_baseline_uri)
  SENSITIVE = []
  include Aws::Structure
end

#shap_baseline_uri ⇒ String

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ‘ShapBaselineUri` should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see [Give SageMaker access to Resources in your Amazon Virtual Private Cloud].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 3735

class ClarifyShapBaselineConfig < Struct.new(
  :mime_type,
  :shap_baseline,
  :shap_baseline_uri)
  SENSITIVE = []
  include Aws::Structure
end