Skip to main content

Jax-based Recourse Explanation Library

Project description

ReLax

Python CI status Docs pypi GitHub License

Overview | Installation | Tutorials | Documentation | Citing ReLax

Overview

ReLax (Recourse Explanation Library in Jax) is a library built on top of jax to generate counterfactual and recourse explanations for Machine Learning algorithms. By leveraging vectorization though vmap/pmap and just-in-time compilation in jax (a high-performance auto-differentiation library). ReLax offers massive speed improvements in generating individual (or local) explanations for predictions made by Machine Learning algorithms.

Some of the key features are as follows:

  • 🏃 Fast recourse generation via jax.jit, jax.vmap/jax.pmap.

  • 🚀 Accelerated over cpu, gpu, tpu.

  • 🪓 Comprehensive set of recourse methods implemented for benchmarking.

  • 👐 Customizable API to enable the building of entire modeling

  • and interpretation pipelines for new recourse algorithms.

Installation

The latest ReLax release can directly be installed from PyPI:

pip install jax-relax

or installed directly from the repository:

pip install git+https://github.com/BirkhoffG/ReLax.git 

To futher unleash the power of accelerators (i.e., GPU/TPU), we suggest to first install this library via pip install jax-relax. Then, follow steps in the official install guidelines to install the right version for GPU or TPU.

An Example of using ReLax

See Getting Started with ReLax.

Citing ReLax

To cite this repository:

@software{relax2023github,
  author = {Hangzhi Guo and Xinchang Xiong and Amulya Yadav},
  title = {{R}e{L}ax: Recourse Explanation Library in Jax},
  url = {http://github.com/birkhoffg/ReLax},
  version = {0.1.0},
  year = {2023},
}

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

jax-relax-0.1.3.tar.gz (52.9 kB view details)

Uploaded Source

Built Distribution

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

jax_relax-0.1.3-py3-none-any.whl (64.6 kB view details)

Uploaded Python 3

File details

Details for the file jax-relax-0.1.3.tar.gz.

File metadata

  • Download URL: jax-relax-0.1.3.tar.gz
  • Upload date:
  • Size: 52.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for jax-relax-0.1.3.tar.gz
Algorithm Hash digest
SHA256 52e45c325f63366cba12a5275c883b90ba165c35ecac10fb55794ac5429bd7c0
MD5 b96b9b46028d9af68d1925d50abe6582
BLAKE2b-256 cdc3803bfa2a3f2c5dcc071ea9ad91514b82537fe74ac361b6fc6f7960e4b334

See more details on using hashes here.

File details

Details for the file jax_relax-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: jax_relax-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 64.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for jax_relax-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3f34269dc87aebda78e71974ce2482766a7eefa10e0a2bd40405922d8ff91018
MD5 6c25e52885f84c771ebcafcc485f74cc
BLAKE2b-256 fea3aca2e7e1503635f70a9653e8b498b12193271e46b392cf8b1e97cfcf2a11

See more details on using hashes here.

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