Class ClarifyShapConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ClarifyShapConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>
@Generated("software.amazon.awssdk:codegen") public final class ClarifyShapConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>

The configuration for SHAP analysis using SageMaker Clarify Explainer.

See Also:

  • Method Details

    • shapBaselineConfig

      public final ClarifyShapBaselineConfig shapBaselineConfig()

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

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

    • numberOfSamples

      public final 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.

      Returns:
      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.

    • useLogit

      public final 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.

      Returns:
      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.

    • seed

      public final 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.

      Returns:
      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.

    • textConfig

      public final 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.

      Returns:
      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.

    • toBuilder

      public ClarifyShapConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>
      Returns:
      a builder for type T

    • builder

      public static ClarifyShapConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClarifyShapConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.