# ClarifyShapConfigProperty

The configuration for SHAP analysis using SageMaker Clarify Explainer.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const clarifyShapConfigProperty: sagemaker.CfnEndpointConfig.ClarifyShapConfigProperty = {
  shapBaselineConfig: {
    mimeType: 'mimeType',
    shapBaseline: 'shapBaseline',
    shapBaselineUri: 'shapBaselineUri',
  },

  // the properties below are optional
  numberOfSamples: 123,
  seed: 123,
  textConfig: {
    granularity: 'granularity',
    language: 'language',
  },
  useLogit: false,
};
```

## Properties

- `numberOfSamples`: number — The number of samples to be used for analysis by the Kernal SHAP algorithm.

  > 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 *Synthetic data* of [Configure and create an endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html) .

- `seed`: number — The starting value used to initialize the random number generator in the explainer.

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

- `shapBaselineConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpointConfig.ClarifyShapBaselineConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnEndpointConfig.ClarifyShapBaselineConfigProperty.html) (required) — The configuration for the SHAP baseline of the Kernal SHAP algorithm.

- `textConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEndpointConfig.ClarifyTextConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnEndpointConfig.ClarifyTextConfigProperty.html) — A parameter that indicates if text features are treated as text and explanations are provided for individual units of text.

  Required for natural language processing (NLP) explainability only.

- `useLogit`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions.

  Defaults to false.