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.2.tar.gz (43.7 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.2-py3-none-any.whl (52.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jax-relax-0.1.2.tar.gz
  • Upload date:
  • Size: 43.7 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.2.tar.gz
Algorithm Hash digest
SHA256 38d14bffeff4470e6bb7a0822feee504e7552d4a6446051905b2bb28782b12f7
MD5 678babe08cc0fae008533637f336510d
BLAKE2b-256 200edc909e275dc757414368be28352a0130247d2cbe20f266efb0ca6f270cba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jax_relax-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 52.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c743ddb7cc630bb65ec8c939e1899117c1e3cb558b4f785278cc0bd93b1fc74f
MD5 8f79558bc68096c750e4e0060d5e02f2
BLAKE2b-256 ecc195212b8d91aed5858a56bf95bab82a3fedb95cffe63b73132a9bf570f355

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