Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpointConfig.ClarifyExplainerConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointConfig.ClarifyExplainerConfigProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfig

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

The configuration parameters for the SageMaker Clarify explainer.

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.*;
 ClarifyExplainerConfigProperty clarifyExplainerConfigProperty = ClarifyExplainerConfigProperty.builder()
         .shapConfig(ClarifyShapConfigProperty.builder()
                 .shapBaselineConfig(ClarifyShapBaselineConfigProperty.builder()
                         .mimeType("mimeType")
                         .shapBaseline("shapBaseline")
                         .shapBaselineUri("shapBaselineUri")
                         .build())
                 // the properties below are optional
                 .numberOfSamples(123)
                 .seed(123)
                 .textConfig(ClarifyTextConfigProperty.builder()
                         .granularity("granularity")
                         .language("language")
                         .build())
                 .useLogit(false)
                 .build())
         // the properties below are optional
         .enableExplanations("enableExplanations")
         .inferenceConfig(ClarifyInferenceConfigProperty.builder()
                 .contentTemplate("contentTemplate")
                 .featureHeaders(List.of("featureHeaders"))
                 .featuresAttribute("featuresAttribute")
                 .featureTypes(List.of("featureTypes"))
                 .labelAttribute("labelAttribute")
                 .labelHeaders(List.of("labelHeaders"))
                 .labelIndex(123)
                 .maxPayloadInMb(123)
                 .maxRecordCount(123)
                 .probabilityAttribute("probabilityAttribute")
                 .probabilityIndex(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEndpointConfig.ClarifyExplainerConfigProperty.Builder	builder()
default String	getEnableExplanations()	A JMESPath boolean expression used to filter which records to explain.
default Object	getInferenceConfig()	The inference configuration parameter for the model container.
Object	getShapConfig()	The configuration for SHAP analysis.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getShapConfig

@Stability(Stable)
@NotNull
Object getShapConfig()

The configuration for SHAP analysis.

See Also:

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

getEnableExplanations

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

A JMESPath boolean expression used to filter which records to explain.

Explanations are activated by default. See EnableExplanations for additional information.

See Also:

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

getInferenceConfig

@Stability(Stable)
@Nullable
default Object getInferenceConfig()

The inference configuration parameter for the model container.

See Also:

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

builder

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

Returns:

a CfnEndpointConfig.ClarifyExplainerConfigProperty.Builder of CfnEndpointConfig.ClarifyExplainerConfigProperty