Shap
Explain and audit machine-learning predictions with SHAP. Use for selecting SHAP explainers and maskers, computing and validating feature attributions, handling multi-output explanations, and producing local or global SHAP visualizations.
- Skill ID
- k-dense-ai/scientific-agent-skills/shap
- Publisher
- k-dense-ai
- Repository
- scientific-agent-skills
- Installs
- 0
- Files
- 10
- License
- MIT
- Requires
- Requires Python 3.12+ and uv for SHAP 0.52.0; model-specific libraries are optional.
- Synced
- Sep 23, 2026
Open any RiverX project, open the Skills panel in the chat, and search for this identifier. The files are fetched from the source repository at install time.
k-dense-ai/scientific-agent-skills/shapInstalls these files- SKILL.md
- references/data-maskers.md
- references/explainers.md
- references/migration.md
- references/modalities.md
- references/plots.md
- references/theory.md
- references/troubleshooting.md
- references/workflows.md
- scripts/tabular_report.py
What this skill tells the agent
SHAP
Use SHAP to describe how a fitted predictive model maps inputs to outputs. Work from the modern shap.Explanation API, make the explained output and background distribution explicit, and validate every explanation before interpreting it.
This skill is aligned with SHAP 0.52.0 (released 2026-05-28). That release requires Python 3.12 or newer.
Operating Rules
- Explain a fixed, evaluated model; do not use SHAP as a substitute for predictive validation.
- Use held-out or clearly labeled analysis rows for explanations. Choose background rows only from an appropriate training or reference population.
- State the explained output: regression value, raw margin, probability, log loss, logit, or another model method.
- Keep explanations as
shap.Explanationobjects. Callexplainer(X); use.shap_values(X)only when maintaining legacy code. - For multi-output models, select one output before using tabular plots:
explanation[..., output_index]. - Check
base_values + values.sum(...)against the exact model output being explained. - Treat SHAP as a description of model behavior under a masking/background choice. It does not establish causality, fairness, recourse, or scientific mechanism.
- Never silence an additivity failure until input shape, preprocessing, model version, output space, and row ordering have been checked.
- Do not load untrusted pickle, joblib, model, or explainer artifacts; those formats can execute code during deserialization.
Install
Create an isolated environment and pin the documented release:
uv venv --python 3.12
source .venv/bin/activate
uv pip install "shap[plots]==0.52.0"shap[plots] installs the plotting dependencies. Add the fitted model's package at a version compatible with the project. For older Python compatibility, read references/migration.md instead of silently installing a different SHAP release.
Confirm the environment before debugging an API mismatch:
import platform
import shap
print("Python:", platform.python_version())
print("SHAP:", shap.__version__)Standard Workflow
1. Define the explanation target
Record:
- model and preprocessing version;
- exact callable or model method being explained;
- output name/index and units;
- evaluation rows;
- background/reference population;
- masker and explainer algorithm;
- SHAP and model-library versions.
For classifiers, decide whether the task needs raw margins or probabilities. Defaults differ by model family; never infer units from the plot color or sign.
2. Select an explainer and masker
Start with shap.Explainer(model, masker) when automatic dispatch is sufficient. Instantiate a specialized explainer when its assumptions or output controls matter.
| Situation | Preferred choice | Important constraint |
|---|---|---|
| Supported tree ensemble | TreeExplainer | model_output="probability" and "log_loss" require interventional masking and background data |
| Linear model | LinearExplainer | The masker determines interventional versus correlation-aware behavior |
| Small feature space | ExactExplainer | Cost grows quickly with unconstrained feature count |
| General tabular callable | PermutationExplainer | Budget at least one full forward/reverse permutation |
| Hierarchical feature groups, text, or image | PartitionExplainer | The partition tree changes the cooperative game |
| Differentiable neural network | DeepExplainer or GradientExplainer | Framework support, output shape, and background choice require testing |
| Legacy Kernel SHAP workflow | KernelExplainer | Usually much slower than model-specific methods |
Use the detailed decision guide in references/explainers.md. Use references/data-maskers.md when features are correlated, structured, sparse, or semantically grouped.
3. Compute a modern Explanation
This complete binary-classification example uses an explicit background and selects the positive-class output:
import numpy as np
import shap
from sklearn.datasets import load_breast_cancer
from sklearn.ensemble import RandomForestClassifier
from sklearn.model_selection import train_test_split
X, y = load_breast_cancer(as_frame=True, return_X_y=True)
X_train, X_test, y_train, y_test = train_test_split(
X,
y,
test_size=0.2,
stratify=y,
random_state=7,
)
model = RandomForestClassifier(
n_estimators=200,
min_samples_leaf=3,
random_state=7,
n_jobs=-1,
).fit(X_train, y_train)
background = shap.sample(X_train, 100, random_state=7)
explainer = shap.Explainer(model, background, algorithm="tree")
all_outputs = explainer(X_test)
# sklearn tree classifiers expose one output per class.
positive = all_outputs[..., 1]
assert positive.values.shape == X_test.shape
reconstructed = np.asarray(positive.base_values) + positive.values.sum(axis=1)
expected = model.predict_proba(X_test)[:, 1]
np.testing.assert_allclose(reconstructed, expected, rtol=1e-5, atol=1e-6)
shap.plots.beeswarm(positive, max_display=15)
shap.plots.waterfall(positive[0], max_display=15)Output shape is model-dependent:
- one tabular output:
(samples, features); - multiple tabular outputs:
(samples, features, outputs); - multiple model inputs: often a list of arrays or explanations;
- image/text explanations: feature axes follow the input representation, with output selection on the final axis when present.
Do not use the pre-0.45 pattern values[class_index] for a modern multi-output array. Use values[..., class_index] or slice the Explanation itself.
4. Control tree output semantics when needed
For a supported tree classifier, probability-space explanations must be explicit:
background = shap.sample(X_train, 200, random_state=7)
explainer = shap.TreeExplainer(
model,
data=background,
feature_perturbation="interventional",
model_output="probability",
)
probability_exp = explainer(X_test)In SHAP 0.52:
feature_perturbation="auto"uses interventional semantics when background data is supplied and tree-path-dependent semantics otherwise;- probability and log-loss output modes are supported only with interventional semantics;
- pass
approximate=Truetoexplainer(X, approximate=True)if deliberately using the lower-fidelity tree approximation; do not pass it to the constructor.
5. Use a model-agnostic callable deliberately
Pass the exact callable whose outputs will be interpreted:
masker = shap.maskers.Independent(background, max_samples=100)
explainer = shap.Explainer(
model.predict_proba,
masker,
algorithm="permutation",
output_names=[str(label) for label in model.classes_],
seed=7,
)
budget = 2 * X_test.shape[1] + 1
all_outputs = explainer(X_test.iloc[:20], max_evals=budget)
positive = all_outputs[..., 1]Increase max_evals to average over more permutations when estimates are unstable. Keep the seed, background sample, and evaluation budget in the report.
6. Visualize the question, not merely the available plot
| Question | Plot |
|---|---|
| Which features have the largest average attribution magnitude? | shap.plots.bar(exp) |
| How do direction, magnitude, and observed values vary globally? | shap.plots.beeswarm(exp) |
| Why did one prediction differ from its baseline? | shap.plots.waterfall(exp[i]) |
| How does one feature's attribution vary over its values? | shap.plots.scatter(exp[:, feature]) |
| Do explanations form sample-level patterns? | shap.plots.heatmap(exp) |
| How do predefined cohorts differ descriptively? | shap.plots.bar(exp.cohorts(labels).abs.mean(0)) |
| Which tokens or image regions contribute to an output? | shap.plots.text(exp) or shap.plots.image(exp) |
Read references/plots.md before customizing or saving figures.
7. Report limitations with results
At minimum, report:
More from k-dense-ai
Use this skill in a project
Open any RiverX project, search the Skills panel for k-dense-ai/scientific-agent-skills/shap, and install it in one click.
