Package software.amazon.awssdk.services.sagemaker.model

Interface ClarifyShapConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>, SdkBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>, SdkPojo
Enclosing class:
ClarifyShapConfig
public static interface ClarifyShapConfig.Builder extends SdkPojo, CopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>

  • Method Details

    • shapBaselineConfig

      ClarifyShapConfig.Builder shapBaselineConfig(ClarifyShapBaselineConfig shapBaselineConfig)

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

      Parameters:
      shapBaselineConfig - The configuration for the SHAP baseline of the Kernal SHAP algorithm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shapBaselineConfig

      default ClarifyShapConfig.Builder shapBaselineConfig(Consumer<ClarifyShapBaselineConfig.Builder> shapBaselineConfig)

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

      This is a convenience method that creates an instance of the ClarifyShapBaselineConfig.Builder avoiding the need to create one manually via ClarifyShapBaselineConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to shapBaselineConfig(ClarifyShapBaselineConfig).

      Parameters:
      shapBaselineConfig - a consumer that will call methods on ClarifyShapBaselineConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • numberOfSamples

      ClarifyShapConfig.Builder numberOfSamples(Integer numberOfSamples)

      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.

      Parameters:
      numberOfSamples - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useLogit

      ClarifyShapConfig.Builder useLogit(Boolean useLogit)

      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.

      Parameters:
      useLogit - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • seed

      ClarifyShapConfig.Builder seed(Integer seed)

      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.

      Parameters:
      seed - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • textConfig

      ClarifyShapConfig.Builder textConfig(ClarifyTextConfig textConfig)

      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.

      Parameters:
      textConfig - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • textConfig

      default ClarifyShapConfig.Builder textConfig(Consumer<ClarifyTextConfig.Builder> textConfig)

      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.

      This is a convenience method that creates an instance of the ClarifyTextConfig.Builder avoiding the need to create one manually via ClarifyTextConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to textConfig(ClarifyTextConfig).

      Parameters:
      textConfig - a consumer that will call methods on ClarifyTextConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: