Skip to main content

SHAPley Interaction Quantification (SHAP-IQ) for Explainable AI

Project description

shapiq_logo

Documentation Status PyPi PyPi_status
  </a>
  <!-- License -->
  <a href= mit_license

SHAP-IQ: SHAP Interaction Quantification

An interaction may speak more than a thousand main effects.

🛠️ Install

shapiq is intended to work with Python 3.9 and above. Installation can be done via pip:

pip install shapiq

⭐ Quickstart

📈 Compute n-SII values

📊 Visualize your Interactions

One handy way of visualizing interaction scores (up to order 2) are network plots. You can see an example of such a plot below. The nodes represent attribution scores and the edges represent the interactions. The strength and size of the nodes and edges are proportional to the absolute value of the attribution scores and interaction scores, respectively.

from shapiq.plot import network_plot

network_plot(
    first_order_values=n_sii_first_order,  # first order n-SII values
    second_order_values=n_sii_second_order # second order n-SII values
)

The pseudo-code above can produce the following plot (here also an image is added):

network_plot_example

📖 Documentation

The documentation for shapiq can be found here.

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

shapiq-0.0.3.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

shapiq-0.0.3-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file shapiq-0.0.3.tar.gz.

File metadata

  • Download URL: shapiq-0.0.3.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for shapiq-0.0.3.tar.gz
Algorithm Hash digest
SHA256 184645e99bc5b11fc0025097942ef0beed615cf01a9fe89e82437bba67ea9c03
MD5 9b6cd63f737dcbefb16b55431e1ff19f
BLAKE2b-256 fd2244252a7dc446e0a379ff121363431e30977b6b770f1fcf26eaae3e615e3a

See more details on using hashes here.

Provenance

File details

Details for the file shapiq-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: shapiq-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for shapiq-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b8eff2e9cdd674c504ab90a67deff07676aeaefb4d4d24d3642d71feff0440ce
MD5 abe3a4d93e9680a5644b680f35da1f10
BLAKE2b-256 399d63016e8692c0582beea4be302ad5788a6f03a6290934d1f8c36e1628694e

See more details on using hashes here.

Provenance

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