software.amazon.awssdk.services.sagemaker.model

Class ClarifyShapConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ClarifyShapConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClarifyShapConfig.Builder

Method Summary

Modifier and Type	Method and Description
static ClarifyShapConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfSamples() The number of samples to be used for analysis by the Kernal SHAP algorithm.
List<SdkField<?>>	sdkFields()
Integer	seed() The starting value used to initialize the random number generator in the explainer.
static Class<? extends ClarifyShapConfig.Builder>	serializableBuilderClass()
ClarifyShapBaselineConfig	shapBaselineConfig() The configuration for the SHAP baseline of the Kernal SHAP algorithm.
ClarifyTextConfig	textConfig() A parameter that indicates if text features are treated as text and explanations are provided for individual units of text.
ClarifyShapConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	useLogit() A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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