Jax-based Recourse Explanation Library
Project description
ReLax
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jax_relax-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c743ddb7cc630bb65ec8c939e1899117c1e3cb558b4f785278cc0bd93b1fc74f |
|
MD5 | 8f79558bc68096c750e4e0060d5e02f2 |
|
BLAKE2b-256 | ecc195212b8d91aed5858a56bf95bab82a3fedb95cffe63b73132a9bf570f355 |