Skip to main content

causal Responsibility-based eXplanations of black-box-classifiers

Reason this release was yanked:

Wrong version number used

Project description

ReX: Causal Responsibility EXplanations for image classifiers

ReX Logo with dinosaur

Docs Tests License


ReX is a causal explainability tool for image classifiers. It also works on tabular and 3D data.

Given an input image and a classifier, ReX calculates a causal responsibility map across the data and identifies a minimal, sufficient, explanation.

ladybird responsibility map minimal explanation

ReX is black-box, that is, agnostic to the internal structure of the classifier. ReX finds single explanations, non-contiguous explanations (for partially obscured images), multiple independent explanations, contrastive explanations and lots of other things! It has a host of options and parameters, allowing you to fine tune it to your data.

For background information and detailed usage instructions, see our documentation.

Installation

Clone this repository and cd into it.

git clone git@github.com:ReX-XAI/ReX.git
cd ReX/

We recommend creating a virtual environment to install ReX. ReX has been tested using versions of Python >= 3.10. The following instructions assume conda:

conda create -n rex python=3.12
conda activate rex
pip install .

This should install an executable rex in your path.

Note:

By default, onnxruntime will be installed. If you wish to use a GPU, you should uninstall onnxruntime and install onnxruntime-gpu instead. You can alternatively edit the pyproject.toml to read "onnxruntime-gpu >= 1.17.0" rather than "onnxruntime >= 1.17.0".

Feedback

Bug reports, questions, and suggestions for enhancements are welcome - please check the GitHub Issues to see if there is already a relevant issue, or open a new one!

How to Contribute

Your contributions are highly valued and welcomed. To get started, please review the guidelines outlined in the CONTRIBUTING.md file. We look forward to your participation!

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

rex_xai-0.1.2.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rex_xai-0.1.2-py3-none-any.whl (47.6 kB view details)

Uploaded Python 3

File details

Details for the file rex_xai-0.1.2.tar.gz.

File metadata

  • Download URL: rex_xai-0.1.2.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for rex_xai-0.1.2.tar.gz
Algorithm Hash digest
SHA256 942f610e25566fef7143fcb27d1dbe6bd1f340aa564d831ef21e94f6d62b1cb2
MD5 32af1f7af67533eeaf4f9805a90516b0
BLAKE2b-256 1be5ef3e3c44211e61aaa0b698f80d6bc4f87dc4263ece96940a21d942ea771c

See more details on using hashes here.

Provenance

The following attestation bundles were made for rex_xai-0.1.2.tar.gz:

Publisher: publish.yml on ReX-XAI/ReX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rex_xai-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: rex_xai-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 47.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for rex_xai-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b04e35e59a780372bb7f4621ee7c9c501328ab6f68be0dead32f52f17414e2f7
MD5 9aba40f66b995829a9e5eaafb2a50bf5
BLAKE2b-256 b7b1ec558f47c48cf1df78a036b68b5bae0aefa2f7e7c5131495786c6067854a

See more details on using hashes here.

Provenance

The following attestation bundles were made for rex_xai-0.1.2-py3-none-any.whl:

Publisher: publish.yml on ReX-XAI/ReX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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