Skip to main content

causal Responsibility-based eXplanations of black-box-classifiers

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

ReX can be installed using pip. 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.13
conda activate rex
pip install rex_xai

This should install an executable rex in your path. To check that ReX is installed correctly, run:

ReX --help

To build from source, clone the repository and run:

git clone git@github.com:ReX-XAI/ReX.git
cd ReX
conda create -n rex python=3.13
conda activate rex
pip install .

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 clone the project and edit the pyproject.toml to read "onnxruntime-gpu >= 1.17.0" rather than "onnxruntime >= 1.17.0".

If you want to use ReX with 3D data, you will need to install some optional extra dependencies:

pip install 'rex_xai[3D]'

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.4.1.tar.gz (49.8 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.4.1-py3-none-any.whl (58.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rex_xai-0.4.1.tar.gz
  • Upload date:
  • Size: 49.8 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.4.1.tar.gz
Algorithm Hash digest
SHA256 e2cb9d97e6b85cad0c3c9ae02b5d6079c0e2d6fe5997924970ecbdb9c29d9762
MD5 828593e3f70634294c0e51f707d3fc2d
BLAKE2b-256 5eafb36be9d41665cd80143ec3da941c0ec4b2e45e57eb00a647b358b67d9fe5

See more details on using hashes here.

Provenance

The following attestation bundles were made for rex_xai-0.4.1.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.4.1-py3-none-any.whl.

File metadata

  • Download URL: rex_xai-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 58.7 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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62b30b3f7e7e17c6f3e1c8c04c6233449c4057a0c8b6be917b3020e1395e2ae9
MD5 136d1382a633ac4ac6fcf7bae4e8e79b
BLAKE2b-256 657ba83c304d13edecb85420bc152b9db33fafd50eabbf12657d01ef3ca8f76f

See more details on using hashes here.

Provenance

The following attestation bundles were made for rex_xai-0.4.1-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