You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ The package contains two workhorses to calculate SHAP values for *any* model:
19
19
-`kernelshap()`: Kernel SHAP algorithm of [2] and [3]. By default, exact Kernel SHAP is used for up to $p=8$ features, and an almost exact hybrid algorithm otherwise.
20
20
21
21
Furthermore, the function `additive_shap()` produces SHAP values for additive models fitted via `lm()`, `glm()`, `mgcv::gam()`, `mgcv::bam()`, `gam::gam()`,
22
-
`survival::coxph()`, or `survival::survreg()`.
22
+
`survival::coxph()`, or `survival::survreg()`. It is exponentially faster than `permshap()` and `kernelshap()` and provides identical results.
23
23
24
24
### Kernel SHAP or permutation SHAP?
25
25
@@ -41,6 +41,7 @@ If the training data is small, use the full training data. In cases with a natur
41
41
- Factor-valued predictions are automatically turned into one-hot-encoded columns.
42
42
- Case weights are supported via the argument `bg_w`.
43
43
- By changing the defaults in `kernelshap()`, the iterative pure sampling approach in [3] can be enforced.
44
+
- The `additive_shap()` explainer is easier to use: Only the model and `X` are required.
44
45
45
46
## Installation
46
47
@@ -218,6 +219,18 @@ sv_dependence(ps, xvars)
218
219
219
220

220
221
222
+
### Additive SHAP
223
+
224
+
The additive explainer extracts the additive contribution of each feature from a model of suitable class.
0 commit comments