/AWS1/CL_SGMCLARIFYSHAPBASEL00

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

• 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.

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_mimetype TYPE /AWS1/SGMCLARIFYMIMETYPE /AWS1/SGMCLARIFYMIMETYPE

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

iv_shapbaseline TYPE /AWS1/SGMCLARIFYSHAPBASELINE /AWS1/SGMCLARIFYSHAPBASELINE

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.

iv_shapbaselineuri TYPE /AWS1/SGMURL /AWS1/SGMURL

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.

---

Queryable Attributes

MimeType

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

Accessible with the following methods

Method	Description
GET_MIMETYPE()	Getter for MIMETYPE, with configurable default
ASK_MIMETYPE()	Getter for MIMETYPE w/ exceptions if field has no value
HAS_MIMETYPE()	Determine if MIMETYPE has a value

ShapBaseline

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.

Accessible with the following methods

Method	Description
GET_SHAPBASELINE()	Getter for SHAPBASELINE, with configurable default
ASK_SHAPBASELINE()	Getter for SHAPBASELINE w/ exceptions if field has no value
HAS_SHAPBASELINE()	Determine if SHAPBASELINE has a value

ShapBaselineUri

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.

Accessible with the following methods

Method	Description
GET_SHAPBASELINEURI()	Getter for SHAPBASELINEURI, with configurable default
ASK_SHAPBASELINEURI()	Getter for SHAPBASELINEURI w/ exceptions if field has no val
HAS_SHAPBASELINEURI()	Determine if SHAPBASELINEURI has a value