Class CfnEndpointConfig.ClarifyShapBaselineConfigProperty

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

Inheritance

object

CfnEndpointConfig.ClarifyShapBaselineConfigProperty

Implements

CfnEndpointConfig.IClarifyShapBaselineConfigProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEndpointConfig.ClarifyShapBaselineConfigProperty : CfnEndpointConfig.IClarifyShapBaselineConfigProperty

Syntax (vb)

Public Class CfnEndpointConfig.ClarifyShapBaselineConfigProperty Implements CfnEndpointConfig.IClarifyShapBaselineConfigProperty

Remarks

<ul></ul>

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var clarifyShapBaselineConfigProperty = new ClarifyShapBaselineConfigProperty {
                 MimeType = "mimeType",
                 ShapBaseline = "shapBaseline",
                 ShapBaselineUri = "shapBaselineUri"
             };

Synopsis

Constructors

ClarifyShapBaselineConfigProperty()

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

Properties

MimeType	The MIME type of the baseline data.
ShapBaseline	The inline SHAP baseline data in string format.
ShapBaselineUri	The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored.

Constructors

ClarifyShapBaselineConfigProperty()

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

public ClarifyShapBaselineConfigProperty()

Remarks

<ul></ul>

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var clarifyShapBaselineConfigProperty = new ClarifyShapBaselineConfigProperty {
                 MimeType = "mimeType",
                 ShapBaseline = "shapBaseline",
                 ShapBaselineUri = "shapBaselineUri"
             };

Properties

MimeType

The MIME type of the baseline data.

public string? MimeType { get; set; }

Property Value

string

Remarks

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

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

ShapBaseline

The inline SHAP baseline data in string format.

public string? ShapBaseline { get; set; }

Property Value

string

Remarks

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.

ShapBaselineUri

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

public string? ShapBaselineUri { get; set; }

Property Value

string

Remarks

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 .

Implements

CfnEndpointConfig.IClarifyShapBaselineConfigProperty