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.6.tar.gz (56.2 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.6-py3-none-any.whl (67.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jax-relax-0.1.6.tar.gz
  • Upload date:
  • Size: 56.2 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.6.tar.gz
Algorithm Hash digest
SHA256 8ea2500fa0186f0962bcf09d66484b077cdff9c8b312fd805db3eddfd487eb62
MD5 3e6cfb0547f733dcf181191d99230e5e
BLAKE2b-256 bd074c68d3e822d274d86fbc97bacc924ca12a7340e4b6d4c7783d8d42e920c0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jax_relax-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 67.5 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a2a4894b2ba1e46c763e8434a3ad52e13c967d51da09a800e40fdd157abb9fa8
MD5 98a11c8b967b4b4655bcbf0ff04411ad
BLAKE2b-256 6e7b4c8924041f39a29cbecc45000d3b94967851cf6fd78c8de1ea287355bef1

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