Streamlit component for SHAP
Project description
streamlit-shap
This component provides a wrapper to display SHAP plots in Streamlit.
Installation
First install Streamlit (of course!) then pip install this library:
pip install streamlit
pip install git+https://github.com/snehankekre/streamlit-shap`
Example
import streamlit as st
from streamlit_shap import st_shap
import shap
from sklearn.model_selection import train_test_split
import xgboost
import numpy as np
import pandas as pd
@st.experimental_memo
def load_data():
return shap.datasets.adult()
@st.experimental_memo
def load_model(X, y):
X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=7)
d_train = xgboost.DMatrix(X_train, label=y_train)
d_test = xgboost.DMatrix(X_test, label=y_test)
params = {
"eta": 0.01,
"objective": "binary:logistic",
"subsample": 0.5,
"base_score": np.mean(y_train),
"eval_metric": "logloss",
"n_jobs": -1,
}
model = xgboost.train(params, d_train, 10, evals = [(d_test, "test")], verbose_eval=100, early_stopping_rounds=20)
return model
st.title("SHAP in Streamlit")
# train XGBoost model
X,y = load_data()
X_display,y_display = shap.datasets.adult(display=True)
model = load_model(X, y)
# compute SHAP values
explainer = shap.Explainer(model, X)
shap_values = explainer(X)
st_shap(shap.plots.waterfall(shap_values[0]), height=300)
st_shap(shap.plots.beeswarm(shap_values), height=300)
explainer = shap.TreeExplainer(model)
shap_values = explainer.shap_values(X)
st_shap(shap.force_plot(explainer.expected_value, shap_values[0,:], X_display.iloc[0,:]), height=200, width=1000)
st_shap(shap.force_plot(explainer.expected_value, shap_values[:1000,:], X_display.iloc[:1000,:]), height=400, width=1000)
Notes
Colorbar changes in matplotlib>3.4.3
introduced bugs (#22625, #22087) that cause the colorbar of certain shap plots (e.g. beeswarm
) to not display properly. If colorbars are not displayed properly, try downgrading matplotlib
to 3.4.3
.
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
streamlit-shap-1.0.0.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for streamlit_shap-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca5ff4f312dba96573147513f7276c2f93052a143be1648fdb8fcded1ff01ad6 |
|
MD5 | fcf4a0dde56d7a695861d2747e848a6b |
|
BLAKE2b-256 | 24e39a033df2f7702cf7a85f7f9e5ea82c58ef9e898981a4d71f68f6f013252d |