Welcome to cfnet
================
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## 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](https://jax.readthedocs.io/en/latest/index.html). It also uses
[Pytorch](https://pytorch.org/) 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:
``` bash
pip install cfnet
```
Editable Install:
``` bash
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](https://github.com/google/jax#installation).
## An Example of using `cfnet`
See [How to use cfnet](tutorials/how_to_use_cfnet.ipynb).
Raw data
{
"_id": null,
"home_page": "https://github.com/birkhoffg/cfnet/tree/master/",
"name": "jax-rex",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Jax,Recourse,Explanation,Interpretability,Machine Learning",
"author": "BirkhoffG",
"author_email": "26811230+BirkhoffG@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/fd/db/6b48b65059b929c830245a42e46e8d7ba391ba076bc3ac0b83b4ec1a71c8/jax-rex-0.0.11.tar.gz",
"platform": null,
"description": "Welcome to cfnet\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Key Features\n\n- **fast**: code runs significantly faster than existing CF explanation\n libraries.\n- **scalable**: code can be accelerated over *CPU*, *GPU*, and *TPU*\n- **flexible**: we provide flexible API for researchers to allow full\n customization.\n\nTODO: - implement various methods of CF explanations\n\n## Install\n\n`cfnet` is built on top of\n[Jax](https://jax.readthedocs.io/en/latest/index.html). It also uses\n[Pytorch](https://pytorch.org/) to load data.\n\n### Running on CPU\n\nIf you only need to run `cfnet` on CPU, you can simply install via `pip`\nor clone the `GitHub` project.\n\nInstallation via PyPI:\n\n``` bash\npip install cfnet\n```\n\nEditable Install:\n\n``` bash\ngit clone https://github.com/BirkhoffG/cfnet.git\npip install -e cfnet\n```\n\n### Running on GPU or TPU\n\nIf you wish to run `cfnet` on GPU or TPU, please first install this\nlibrary via `pip install cfnet`.\n\nThen, you should install the right GPU or TPU version of Jax by\nfollowing steps in the [install\nguidelines](https://github.com/google/jax#installation).\n\n## An Example of using `cfnet`\n\nSee [How to use cfnet](tutorials/how_to_use_cfnet.ipynb).\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Jax-based Recourse Explanation Library",
"version": "0.0.11",
"split_keywords": [
"jax",
"recourse",
"explanation",
"interpretability",
"machine learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "f8a68c566f4f70ba9764e711292f1daf",
"sha256": "996ee4151fc6b382e1226280a683c710c08bdc413805242dd052772d56253146"
},
"downloads": -1,
"filename": "jax_rex-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8a68c566f4f70ba9764e711292f1daf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 87108,
"upload_time": "2022-12-24T21:55:35",
"upload_time_iso_8601": "2022-12-24T21:55:35.042987Z",
"url": "https://files.pythonhosted.org/packages/32/7a/847ebd1f91a124f7adc8964f7288522d3d32ad90cf9a48c510a862ce59d7/jax_rex-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "b0a4e2efc2cae68ccb9fbeb1c57605bd",
"sha256": "0ab043073c42624e0bb59052857eb20ca984325e0927582f1794ef3db379a0cf"
},
"downloads": -1,
"filename": "jax-rex-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "b0a4e2efc2cae68ccb9fbeb1c57605bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 32765,
"upload_time": "2022-12-24T21:55:36",
"upload_time_iso_8601": "2022-12-24T21:55:36.630590Z",
"url": "https://files.pythonhosted.org/packages/fd/db/6b48b65059b929c830245a42e46e8d7ba391ba076bc3ac0b83b4ec1a71c8/jax-rex-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-24 21:55:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "jax-rex"
}
JSON