A python library to compute Shapley image explanations with data-aware Binary Partition Trees
Project description
ShapBPT: Shapley Image Explanations via Data-Aware Binary Partition Trees
A python library to compute Shapley image explanations with data-aware Binary Partition Trees
ShapBPT is a Python library for generating faithful, data-aware image explanations based on Owen values, a structured variant of Shapley values. Unlike classical SHAP partitioning, where features are grouped using axis-aligned, image-agnostic splits, ShapBPT constructs a Binary Partition Tree (BPT) that mirrors the morphology and structure of the image itself. This leads to explanations aligned with meaningful visual regions rather than arbitrary pixel blocks.
Why ShapBPT? Key Advantages
- Model-agnostic: ShapBPT only requires a masking function, not access to model internals.
- Data-aware explanation structure: Explanations follow meaningful image segments derived from the BPT, improving interpretability.
- Computationally efficient Owen value approximation: Uses hierarchical Owen value recursion to reduce evaluation cost.
- Drop-in replacement for SHAP Partition Explainer: By selecting
method="AA"you can reproduce SHAP’s axis-aligned partitioning within the same interface.
What Is a Binary Partition Tree (BPT)?
A Binary Partition Tree is a hierarchical bottom-up segmentation of an image:
- start from individual pixels,
- iteratively merge adjacent regions that minimize a chosen distance metric,
- continue until a single root region is formed.
This hierarchy provides ShapBPT with a data-aware coalition structure used to compute Shapley feature attributions. Where SHAP’s Partition Explainer uses Axis-Aligned splits, ShapBPT uses morphological clusters guided by the actual image content.
Because regions can be recursively split down to individual pixels, the method gracefully balances efficiency and fidelity.
How it is built and used
A Binary Partition Tree is built bottom-up, starting from the individual pixels and then merging adjacent regions that minimize a distance function, until all regions are merged into a single cluster. The tree that forms is the BPT tree.
In practice, the BPT hierarchy is used top-down, starting from the root cluster and splitting adaptively. ShapBPT uses the BPT hierarchy to generate feature attributions in the form of (Owen approximations) of the Shapley coefficients.
Using ShapBPT
Step 1. Define a masking function
ShapBPT requires a function $$ \nu: N \times H \times W \rightarrow B \times M $$ that takes in input a set of N binary masks and returns model predictions.
Step 2. Run the explainer
import shap_bpt
explainer = shap_bpt.Explainer(
nu, # masking function ν
image_to_explain, # input image (HWC)
num_explained_classes=4, # number of output classes to attribute
verbose=True
)
shap_values = explainer.explain_instance(
max_evals=eval_budget, # maximum number of nu evaluations to generate the explanation
method="BPT", # choose "BPT" (data-aware) or "AA" (axis-aligned)
batch_size=batch_size
)
Step 3. Visualize the attribution map
shap_bpt.plot_owen_values(explainer, shap_values, class_names)
With eval_budget=100 and method='BPT' we obtain the explanation:
With eval_budget=100 and method='AA' we obtain the explanation:
See the provided notebooks for examples on how to setup and run ShapBPT.
How It Works: Owen Value Approximation
ShapBPT evaluates the Owen value over a BPT coalition structure.
The library uses the formula
$$
\widehat{\Omega}i(Q, T) =
\begin{cases}
\displaystyle
\frac{1}{2} \widehat{\Omega}i(Q \cup T{2},, T{1}{\downarrow}) ,+,
\frac{1}{2} \widehat{\Omega}i(Q,, T{1}{\downarrow}) \quad
& \text{if}~T{\downarrow} = {T_{1},, T_{2}}
\[4pt]
\widehat{\varphi}i(Q, T)
& \text{otherwise}
\
\end{cases}
$$
where $i \in T{1}$, and $\widehat{\varphi}i(Q, T) = \frac{1}{|T|} \Delta{T}(Q)$ is the uniform marginal distribution of $T$ w.r.t. $Q$.
This hierarchical structure is what makes ShapBPT efficient, especially compared to full Shapley enumeration.
Installation
Because ShapBPT includes a Cython module, compiling is required.
Unix systems
python setup.py build_ext --inplace
Windows systems
On Windows, the package can be compiled using ming32, with the command:
python setup.py build_ext --inplace --compiler=mingw32
Recommended: To install mingw using conda commands recommended on this page to setup a working mingw32 system, Run following lines.
conda install numpy libpython m2w64-toolchain cython
Note: Make sure that environment having cython is activated before running above line of code.
Alternativly, Follow the instruction on this page
Package installation (all systems)
After compiling, the ShapBPT python module can be installed using:
python setup.py install
To clean up the folder from the intermediate build files, use:
python setup.py clean --all
Examples
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file shap_bpt-0.0.1.tar.gz.
File metadata
- Download URL: shap_bpt-0.0.1.tar.gz
- Upload date:
- Size: 131.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
526ea75b529c6915df5bdde5d3457097c3c563e4121dc0b1d084ca084274caee
|
|
| MD5 |
2896648ebd52380eb0475c1984b78972
|
|
| BLAKE2b-256 |
55d30e1b20627d9f567daf2d6528a23024ab7386fcde132f8322f4cefaf3bbf9
|
File details
Details for the file shap_bpt-0.0.1-cp39-cp39-win_amd64.whl.
File metadata
- Download URL: shap_bpt-0.0.1-cp39-cp39-win_amd64.whl
- Upload date:
- Size: 166.8 kB
- Tags: CPython 3.9, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d7317ced2618a94de19989a769b36b2c3b7dfbed8f30003bef248fdcbbc63bfd
|
|
| MD5 |
b6d6ebc531246f9816468b2b4d00ddf0
|
|
| BLAKE2b-256 |
2f28ed105932146bc40e3be276a42d890c7ee9a6bb95bdcc6a5892fdda0d2380
|