A counterfactual explanation library using Jax
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.
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
cfnet-0.0.12.tar.gz
(40.3 kB
view details)
Built Distribution
cfnet-0.0.12-py3-none-any.whl
(89.0 kB
view details)
File details
Details for the file cfnet-0.0.12.tar.gz.
File metadata
- Download URL: cfnet-0.0.12.tar.gz
- Upload date:
- Size: 40.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 12dc4b044ddedd52d96b5109237b83a95c4f32a7608f3c32febf8bfe3fd99c2d |
|
| MD5 | 438e49e4fe4193ce700fd4ac251af499 |
|
| BLAKE2b-256 | ddfb149b8f7b4dbf75aaa6c8f912a94e59e72312c2d5360f405e3cec4227d8ef |
File details
Details for the file cfnet-0.0.12-py3-none-any.whl.
File metadata
- Download URL: cfnet-0.0.12-py3-none-any.whl
- Upload date:
- Size: 89.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8da6865efe8e7c566b582df35db2b59c77202b5164e994f64a0f205c150eb74e |
|
| MD5 | acd1ad32f0b74e10a2cd7f84b397f090 |
|
| BLAKE2b-256 | ab2b7224540e2256b7f175c8871657c36c11d93debb0e2815055757fd86a2bec |
