public static interface ClarifyShapConfig.Builder extends SdkPojo, CopyableBuilder<ClarifyShapConfig.Builder,ClarifyShapConfig>
| Modifier and Type | Method and Description |
|---|---|
ClarifyShapConfig.Builder |
numberOfSamples(Integer numberOfSamples)
The number of samples to be used for analysis by the Kernal SHAP algorithm.
|
ClarifyShapConfig.Builder |
seed(Integer seed)
The starting value used to initialize the random number generator in the explainer.
|
ClarifyShapConfig.Builder |
shapBaselineConfig(ClarifyShapBaselineConfig shapBaselineConfig)
The configuration for the SHAP baseline of the Kernal SHAP algorithm.
|
default ClarifyShapConfig.Builder |
shapBaselineConfig(Consumer<ClarifyShapBaselineConfig.Builder> shapBaselineConfig)
The configuration for the SHAP baseline of the Kernal SHAP algorithm.
|
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.
|
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.
|
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.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildClarifyShapConfig.Builder shapBaselineConfig(ClarifyShapBaselineConfig shapBaselineConfig)
The configuration for the SHAP baseline of the Kernal SHAP algorithm.
shapBaselineConfig - The configuration for the SHAP baseline of the Kernal SHAP algorithm.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 theClarifyShapBaselineConfig.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).
shapBaselineConfig - a consumer that will call methods on ClarifyShapBaselineConfig.BuildershapBaselineConfig(ClarifyShapBaselineConfig)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.
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.
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.
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.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.
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.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.
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.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 theClarifyTextConfig.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).
textConfig - a consumer that will call methods on ClarifyTextConfig.BuildertextConfig(ClarifyTextConfig)Copyright © 2023. All rights reserved.