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": "cfnet",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "some keywords",
"author": "BirkhoffG",
"author_email": "26811230+BirkhoffG@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/dd/fb/149b8f7b4dbf75aaa6c8f912a94e59e72312c2d5360f405e3cec4227d8ef/cfnet-0.0.12.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": "A counterfactual explanation library using Jax",
"version": "0.0.12",
"split_keywords": [
"some",
"keywords"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "acd1ad32f0b74e10a2cd7f84b397f090",
"sha256": "8da6865efe8e7c566b582df35db2b59c77202b5164e994f64a0f205c150eb74e"
},
"downloads": -1,
"filename": "cfnet-0.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "acd1ad32f0b74e10a2cd7f84b397f090",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 89041,
"upload_time": "2022-12-27T01:35:08",
"upload_time_iso_8601": "2022-12-27T01:35:08.460155Z",
"url": "https://files.pythonhosted.org/packages/ab/2b/7224540e2256b7f175c8871657c36c11d93debb0e2815055757fd86a2bec/cfnet-0.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "438e49e4fe4193ce700fd4ac251af499",
"sha256": "12dc4b044ddedd52d96b5109237b83a95c4f32a7608f3c32febf8bfe3fd99c2d"
},
"downloads": -1,
"filename": "cfnet-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "438e49e4fe4193ce700fd4ac251af499",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 40287,
"upload_time": "2022-12-27T01:35:09",
"upload_time_iso_8601": "2022-12-27T01:35:09.751649Z",
"url": "https://files.pythonhosted.org/packages/dd/fb/149b8f7b4dbf75aaa6c8f912a94e59e72312c2d5360f405e3cec4227d8ef/cfnet-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-27 01:35:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "cfnet"
}
JSON