Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ClarifyShapConfig = ClarifyShapConfig' {}
- newClarifyShapConfig :: ClarifyShapBaselineConfig -> ClarifyShapConfig
- clarifyShapConfig_numberOfSamples :: Lens' ClarifyShapConfig (Maybe Natural)
- clarifyShapConfig_seed :: Lens' ClarifyShapConfig (Maybe Int)
- clarifyShapConfig_textConfig :: Lens' ClarifyShapConfig (Maybe ClarifyTextConfig)
- clarifyShapConfig_useLogit :: Lens' ClarifyShapConfig (Maybe Bool)
- clarifyShapConfig_shapBaselineConfig :: Lens' ClarifyShapConfig ClarifyShapBaselineConfig
Documentation
data ClarifyShapConfig Source #
The configuration for SHAP analysis using SageMaker Clarify Explainer.
See: newClarifyShapConfig
smart constructor.
ClarifyShapConfig' | |
|
Instances
Create a value of ClarifyShapConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numberOfSamples:ClarifyShapConfig'
, clarifyShapConfig_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.
$sel:seed:ClarifyShapConfig'
, clarifyShapConfig_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.
$sel:textConfig:ClarifyShapConfig'
, clarifyShapConfig_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.
$sel:useLogit:ClarifyShapConfig'
, clarifyShapConfig_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.
$sel:shapBaselineConfig:ClarifyShapConfig'
, clarifyShapConfig_shapBaselineConfig
- The configuration for the SHAP baseline of the Kernal SHAP algorithm.
clarifyShapConfig_numberOfSamples :: Lens' ClarifyShapConfig (Maybe Natural) Source #
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_seed :: Lens' ClarifyShapConfig (Maybe Int) Source #
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_textConfig :: Lens' ClarifyShapConfig (Maybe ClarifyTextConfig) Source #
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.
clarifyShapConfig_useLogit :: Lens' ClarifyShapConfig (Maybe Bool) Source #
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_shapBaselineConfig :: Lens' ClarifyShapConfig ClarifyShapBaselineConfig Source #
The configuration for the SHAP baseline of the Kernal SHAP algorithm.