Skip to content

documentation: Mark baseline as optional in KernelSHAP. #2515

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.

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
merged 6 commits into from
Jul 29, 2021
Merged
Changes from all commits
Commits
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
9 changes: 5 additions & 4 deletions src/sagemaker/clarify.py
Original file line number Diff line number Diff line change
Expand Up @@ -305,10 +305,11 @@ def __init__(
"""Initializes config for SHAP.

Args:
baseline (str or list): A list of rows (at least one) or S3 object URI to be used as
the baseline dataset in the Kernel SHAP algorithm. The format should be the same
as the dataset format. Each row should contain only the feature columns/values
and omit the label column/values.
baseline (None or str or list): None or S3 object Uri or A list of rows (at least one)
to be used asthe baseline dataset in the Kernel SHAP algorithm. The format should
be the same as the dataset format. Each row should contain only the feature
columns/values and omit the label column/values. If None a baseline will be
calculated automatically by using K-means or K-prototypes in the input dataset.
num_samples (int): Number of samples to be used in the Kernel SHAP algorithm.
This number determines the size of the generated synthetic dataset to compute the
SHAP values.
Expand Down