Skip to main content

A stripped and opiniated version of Scott Lundberg's SHAP (SHapley Additive exPlanations)

Project description


example workflow

Baby Shap is a stripped and opiniated version of SHAP (SHapley Additive exPlanations), a game theoretic approach to explain the output of any machine learning model by Scott Lundberg. It connects optimal credit allocation with local explanations using the classic Shapley values from game theory and their related extensions (see papers for details and citations).

Baby Shap solely implements and maintains the Linear and Kernel Explainer and a limited range of plots, while limiting the number of dependencies, conflicts and raised warnings and errors.

Install

Baby SHAP can be installed from either PyPI:

pip install baby-shap

Model agnostic example with KernelExplainer (explains any function)

Kernel SHAP uses a specially-weighted local linear regression to estimate SHAP values for any model. Below is a simple example for explaining a multi-class SVM on the classic iris dataset.

import baby_shap
from sklearn import datasets, svm, model_selection

# print the JS visualization code to the notebook
baby_shap.initjs()

# train a SVM classifier
d = datasets.load_iris()
X = pd.DataFrame(data=d.data, columns=d.feature_names)
y = d.target

X_train, X_test, Y_train, Y_test = model_selection.train_test_split(X, y, test_size=0.2, random_state=0)
clf = svm.SVC(kernel='rbf', probability=True)
clf.fit(X_train.to_numpy(), Y_train)

# use Kernel SHAP to explain test set predictions
explainer = baby_shap.KernelExplainer(svm.predict_proba, X_train, link="logit")
shap_values = explainer.shap_values(X_test, nsamples=100)

# plot the SHAP values for the Setosa output of the first instance
baby_shap.force_plot(explainer.expected_value[0], shap_values[0][0,:], X_test.iloc[0,:], link="logit")

The above explanation shows four features each contributing to push the model output from the base value (the average model output over the training dataset we passed) towards zero. If there were any features pushing the class label higher they would be shown in red.

If we take many explanations such as the one shown above, rotate them 90 degrees, and then stack them horizontally, we can see explanations for an entire dataset. This is exactly what we do below for all the examples in the iris test set:

# plot the SHAP values for the Setosa output of all instances
baby_shap.force_plot(explainer.expected_value[0], shap_values[0], X_test, link="logit")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

baby_shap-0.0.6.tar.gz (182.9 kB view details)

Uploaded Source

Built Distribution

baby_shap-0.0.6-py3-none-any.whl (190.6 kB view details)

Uploaded Python 3

File details

Details for the file baby_shap-0.0.6.tar.gz.

File metadata

  • Download URL: baby_shap-0.0.6.tar.gz
  • Upload date:
  • Size: 182.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.9 Darwin/22.3.0

File hashes

Hashes for baby_shap-0.0.6.tar.gz
Algorithm Hash digest
SHA256 76f7b24d5807ed88e34dd5d63dd6445d25b5b1a44541b07c3c80381a6acdf8a8
MD5 b0851c555e9cb8c070c0f63353bc96aa
BLAKE2b-256 f76b8499710ecf5543ed7e6a0c662d22fca05aba579bf1da5838d8bedad4289e

See more details on using hashes here.

File details

Details for the file baby_shap-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: baby_shap-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 190.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.9 Darwin/22.3.0

File hashes

Hashes for baby_shap-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a4e4c58d5ccae5117dbbb057ab01741f14604916988fd4b0c4e8fbbf9f46aa96
MD5 6077ba4d80e872418500b770701410c2
BLAKE2b-256 80b7ab881676900cf15d4f543a7f63a460e597b3efd9c984a19dfc9bcadbf4b7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page