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. By leveraging vectorization though vmap/pmap and just-in-time compilation in jax, ReLax offers massive speed improvements in generating individual (or local) explanations.

Some of the key features:

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

  • 🚀 Accelerated over cpu, gpu, tpu.

  • 🪓 Extensive recourse methods implemented for benchmarking.

  • 👐 Customizable API to enable building entire modeling and interpreting pipeline.

Installation

The latest ReLax release can directly be installed from PyPI:

pip install jax-relax

or install 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.1.tar.gz (35.5 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.1-py3-none-any.whl (43.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jax-relax-0.1.1.tar.gz
  • Upload date:
  • Size: 35.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.15

File hashes

Hashes for jax-relax-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6fe3ca43755cf1353eaf9b3e9822ff151b3eab78fc4d504dbbdeb1eab2ec648a
MD5 c855a8ec5dfc4baf63bf1cdee7020ca5
BLAKE2b-256 8c0086e24352cfb3e41661cdf8d48dad916110fd2005220fe3d9e9fc3d597c02

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jax_relax-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 43.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.15

File hashes

Hashes for jax_relax-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5ac0b93ad7c8d8a9742f75a4e0becb4ae9f5cc32967844d636864a6274356e83
MD5 c7a00d05f301f9414e0b20e5b715dbc3
BLAKE2b-256 3d7576493cd69fae4d549ebd0f58606f407598584e0f8df8b5b489ee24354935

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