Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpointConfig.ClarifyShapBaselineConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointConfig.ClarifyShapBaselineConfigProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfig

@Stability(Stable)
public static interface CfnEndpointConfig.ClarifyShapBaselineConfigProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 ClarifyShapBaselineConfigProperty clarifyShapBaselineConfigProperty = ClarifyShapBaselineConfigProperty.builder()
         .mimeType("mimeType")
         .shapBaseline("shapBaseline")
         .shapBaselineUri("shapBaselineUri")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointConfig.ClarifyShapBaselineConfigProperty.Builder	A builder for CfnEndpointConfig.ClarifyShapBaselineConfigProperty
static final class	CfnEndpointConfig.ClarifyShapBaselineConfigProperty.Jsii$Proxy	An implementation for CfnEndpointConfig.ClarifyShapBaselineConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpointConfig.ClarifyShapBaselineConfigProperty.Builder	builder()
default String	getMimeType()	The MIME type of the baseline data.
default String	getShapBaseline()	The inline SHAP baseline data in string format.
default String	getShapBaselineUri()	The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMimeType

@Stability(Stable)
@Nullable
default String getMimeType()

The MIME type of the baseline data.

Choose from 'text/csv' or 'application/jsonlines' . Defaults to 'text/csv' .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-mimetype

getShapBaseline

@Stability(Stable)
@Nullable
default String getShapBaseline()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-shapbaseline

getShapBaselineUri

@Stability(Stable)
@Nullable
default String getShapBaselineUri()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html#cfn-sagemaker-endpointconfig-clarifyshapbaselineconfig-shapbaselineuri

builder

@Stability(Stable)
static CfnEndpointConfig.ClarifyShapBaselineConfigProperty.Builder builder()

Returns:

a CfnEndpointConfig.ClarifyShapBaselineConfigProperty.Builder of CfnEndpointConfig.ClarifyShapBaselineConfigProperty