Metadata-Version: 2.1
Name: xai-explainer
Version: 0.3.6
Summary: A package for explaining deep learning models
Home-page: https://gitlab.fachschaften.org/xai/explainer
License: MIT
Keywords: xai,explainer,deep learning,pytorch
Author: Raphael Spiekermann
Author-email: raphael.spiekermann@tu-dortmund.de
Requires-Python: >=3.8,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: geopy
Requires-Dist: grad-cam (>=1.4.8,<2.0.0)
Requires-Dist: lime
Requires-Dist: numpy (>=1.23.5,<2.0.0)
Requires-Dist: opencv-python (==4.5.5.64)
Requires-Dist: pandas
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: s2sphere
Requires-Dist: scikit-image (>=0.21.0,<0.22.0)
Requires-Dist: scikit-learn (>=1.2.2,<2.0.0)
Requires-Dist: scipy (>=1.10.0,<2.0.0)
Requires-Dist: selective-search (>=1.1.0,<2.0.0)
Requires-Dist: timm (>=0.9.2,<0.10.0)
Requires-Dist: torch (>=2.0.0,!=2.0.1)
Requires-Dist: torchvision (>=0.15.0)
Requires-Dist: tqdm (>=4.65.0,<5.0.0)
Requires-Dist: transformers
Requires-Dist: zennit
Project-URL: Repository, https://gitlab.fachschaften.org/xai/explainer
Description-Content-Type: text/markdown

<div align="center">

![PyPI - Version](https://img.shields.io/pypi/v/xai-explainer)
![PyPI - Downloads](https://img.shields.io/pypi/dm/xai-explainer)
![PyPI - License](https://img.shields.io/pypi/l/xai-explainer?color=brightgreen)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/xai-explainer)

</div>

# Installation

All stable versions can be installed from [PyPI] by using [pip] or your favorite package manager

    pip install xai-explainer

# Development

**Requirements:**
- Python 3.8 or higher
- [poetry] 1.2 or higher
- [make]

For installing the development environment run

```bash
make setup
```

Configure poetry for vscode
```bash
poetry config virtualenvs.in-project true
poetry install # or alternatively: "make setup"
```

Run scripts using poetry
```bash
poetry run python script_name.py
```

[make]: https://www.gnu.org/software/make/
[pip]: https://pypi.org/project/pip/
[poetry]: https://python-poetry.org/
[pypi]: https://pypi.org/
