Skip to main content

Jax-based Recourse Explanation Library

Project description

Welcome to cfnet

Key Features

  • fast: code runs significantly faster than existing CF explanation libraries.
  • scalable: code can be accelerated over CPU, GPU, and TPU
  • flexible: we provide flexible API for researchers to allow full customization.

TODO: - implement various methods of CF explanations

Install

cfnet is built on top of Jax. It also uses Pytorch to load data.

Running on CPU

If you only need to run cfnet on CPU, you can simply install via pip or clone the GitHub project.

Installation via PyPI:

pip install cfnet

Editable Install:

git clone https://github.com/BirkhoffG/cfnet.git
pip install -e cfnet

Running on GPU or TPU

If you wish to run cfnet on GPU or TPU, please first install this library via pip install cfnet.

Then, you should install the right GPU or TPU version of Jax by following steps in the install guidelines.

An Example of using cfnet

See How to use cfnet.

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.0.11.tar.gz (32.8 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.0.11-py3-none-any.whl (87.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jax-relax-0.0.11.tar.gz
Algorithm Hash digest
SHA256 8be4af1a0087b1663bf1b973f830ca8da1565bf0260bd13a816fdb2f2d432c54
MD5 b01c13dabfefb2cb4465d875814b9596
BLAKE2b-256 7630289a92fb1e3a5a58ff546f97919b252b0d129f0c56081d8cb8976f94f58a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for jax_relax-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 11894ac31c9dd8146ac2266539b595725e98be1e86c67352b22d163d0fed382f
MD5 3ef3e63ba73b3643052e1148acf353df
BLAKE2b-256 be475d4a440051543f80879c9984cff0e1dcf23282995edb48c7f1ab63ad6307

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