Skip to content

documentation: fix the ClarifyCheckStep documentation to mention PDP #4259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
knikure merged 2 commits into from
Feb 13, 2024
Merged

documentation: fix the ClarifyCheckStep documentation to mention PDP #4259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0e27f2
documentation: fix the ClarifyCheckStep documentation to mention PDP …
shinglyu Nov 16, 2023
1e408e4
fix: break the lines to meet pylint requirement
Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/sagemaker/workflow/clarify_check_step.py
View file
Open in desktop
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