Skip to content

Commit

Permalink
documentation: fix the ClarifyCheckStep documentation to mention PDP (#…
Browse files Browse the repository at this point in the history
…4259)

* documentation: fix the ClarifyCheckStep documentation to mention PDP support

* fix: break the lines to meet pylint requirement

---------

Co-authored-by: Shing Lyu <shinglyu@amazon.nl>
  • Loading branch information
shinglyu and Shing Lyu committed Feb 13, 2024
1 parent e75865f commit 5c26c4e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/sagemaker/workflow/clarify_check_step.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,10 @@ class ModelExplainabilityCheckConfig(ClarifyCheckConfig):
Attributes:
model_config (ModelConfig): Config of the model and its endpoint to be created.
explainability_config (SHAPConfig): Config of the specific explainability method.
Currently, only SHAP is supported.
explainability_config (SHAPConfig or PDPConfig): Config of the explainability method.
Supports SHAP or PDP.
For `PDPConfig`, `features` must be specified.
`top_k_features` based on SHAP is currently not supported.
model_scores (str or int or ModelPredictedLabelConfig): Index or JMESPath expression
to locate the predicted scores in the model output (default: None).
This is not required if the model output is a single score. Alternatively,
Expand Down

0 comments on commit 5c26c4e

Please sign in to comment.