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

Interface ClarifyShapConfig.Builder

    • Method Detail

      • 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.

      • 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.