Skip to content

Commit 9fc5755

Browse files
larroyahsan-z-khan
andauthored
documentation: Mark baseline as optional in KernelSHAP. (#2515)
* documentation: Mark baseline as optional in KernelSHAP. * fix pylint * fix sphinx Co-authored-by: Ahsan Khan <[email protected]>
1 parent 116bcce commit 9fc5755

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/sagemaker/clarify.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -305,10 +305,11 @@ def __init__(
305305
"""Initializes config for SHAP.
306306
307307
Args:
308-
baseline (str or list): A list of rows (at least one) or S3 object URI to be used as
309-
the baseline dataset in the Kernel SHAP algorithm. The format should be the same
310-
as the dataset format. Each row should contain only the feature columns/values
311-
and omit the label column/values.
308+
baseline (None or str or list): None or S3 object Uri or A list of rows (at least one)
309+
to be used asthe baseline dataset in the Kernel SHAP algorithm. The format should
310+
be the same as the dataset format. Each row should contain only the feature
311+
columns/values and omit the label column/values. If None a baseline will be
312+
calculated automatically by using K-means or K-prototypes in the input dataset.
312313
num_samples (int): Number of samples to be used in the Kernel SHAP algorithm.
313314
This number determines the size of the generated synthetic dataset to compute the
314315
SHAP values.

0 commit comments

Comments
 (0)