Class CfnEndpointConfig.ClarifyShapConfigProperty

The configuration for SHAP analysis using SageMaker Clarify Explainer.

Inheritance

object

CfnEndpointConfig.ClarifyShapConfigProperty

Implements

CfnEndpointConfig.IClarifyShapConfigProperty

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.ClarifyShapConfigProperty : CfnEndpointConfig.IClarifyShapConfigProperty

Syntax (vb)

Public Class CfnEndpointConfig.ClarifyShapConfigProperty Implements CfnEndpointConfig.IClarifyShapConfigProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.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 clarifyShapConfigProperty = new ClarifyShapConfigProperty {
                 ShapBaselineConfig = new ClarifyShapBaselineConfigProperty {
                     MimeType = "mimeType",
                     ShapBaseline = "shapBaseline",
                     ShapBaselineUri = "shapBaselineUri"
                 },

                 // the properties below are optional
                 NumberOfSamples = 123,
                 Seed = 123,
                 TextConfig = new ClarifyTextConfigProperty {
                     Granularity = "granularity",
                     Language = "language"
                 },
                 UseLogit = false
             };

Synopsis

Constructors

ClarifyShapConfigProperty()

The configuration for SHAP analysis using SageMaker Clarify Explainer.

Properties

NumberOfSamples	The number of samples to be used for analysis by the Kernal SHAP algorithm.
Seed	The starting value used to initialize the random number generator in the explainer.
ShapBaselineConfig	The configuration for the SHAP baseline of the Kernal SHAP algorithm.
TextConfig	A parameter that indicates if text features are treated as text and explanations are provided for individual units of text.
UseLogit	A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions.

Constructors

ClarifyShapConfigProperty()

The configuration for SHAP analysis using SageMaker Clarify Explainer.

public ClarifyShapConfigProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.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 clarifyShapConfigProperty = new ClarifyShapConfigProperty {
                 ShapBaselineConfig = new ClarifyShapBaselineConfigProperty {
                     MimeType = "mimeType",
                     ShapBaseline = "shapBaseline",
                     ShapBaselineUri = "shapBaselineUri"
                 },

                 // the properties below are optional
                 NumberOfSamples = 123,
                 Seed = 123,
                 TextConfig = new ClarifyTextConfigProperty {
                     Granularity = "granularity",
                     Language = "language"
                 },
                 UseLogit = false
             };

Properties

NumberOfSamples

The number of samples to be used for analysis by the Kernal SHAP algorithm.

public double? NumberOfSamples { get; set; }

Property Value

double?

Remarks

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the <em>Synthetic data</em> of <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html">Configure and create an endpoint</a> .

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

Seed

The starting value used to initialize the random number generator in the explainer.

public double? Seed { get; set; }

Property Value

double?

Remarks

Provide a value for this parameter to obtain a deterministic SHAP result.

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

ShapBaselineConfig

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

public object ShapBaselineConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnEndpointConfig.IClarifyShapBaselineConfigProperty

TextConfig

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text.

public object? TextConfig { get; set; }

Property Value

object

Remarks

Required for natural language processing (NLP) explainability only.

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

Type union: either IResolvable or CfnEndpointConfig.IClarifyTextConfigProperty

UseLogit

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions.

public object? UseLogit { get; set; }

Property Value

object

Remarks

Defaults to false.

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

Type union: either bool or IResolvable

Implements

CfnEndpointConfig.IClarifyShapConfigProperty