Metadata-Version: 2.1
Name: plsexplain
Version: 0.2.0
Summary: Create an explainable AI dashboard for your machine learning model.
Home-page: https://wmeints.github.io/plsexplain
License: MIT
Author: Willem Meints
Author-email: willem.meints@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: aiofiles (>=0.7.0,<0.8.0)
Requires-Dist: click (>=8.0.1,<9.0.0)
Requires-Dist: dalex (>=1.2.0,<2.0.0)
Requires-Dist: fastapi (>=0.65.2,<0.66.0)
Requires-Dist: joblib (>=1.0.1,<2.0.0)
Requires-Dist: pandas (>=1.2.5,<2.0.0)
Requires-Dist: progressbar2 (>=3.53.1,<4.0.0)
Requires-Dist: scikit-learn (>=0.24.2,<0.25.0)
Requires-Dist: tqdm (>=4.61.1,<5.0.0)
Requires-Dist: uvicorn[standard] (>=0.14.0,<0.15.0)
Project-URL: Repository, https://github.com/wmeints/plsexplain
Description-Content-Type: text/markdown

![plsexplain logo](assets/logo_transparent_background.png)

---

Create an explainable AI dashboard for your machine learning model. plsexplain,
or please, explain is a question that you may want to ask your computer after
you've trained a machine learning model.

---

[![package](https://badge.fury.io/py/plsexplain.svg)](https://pypi.org/project/plsexplain/)
[![downloads](https://img.shields.io/pypi/dm/plsexplain.svg)](https://pypi.org/project/plsexplain/)
[![continuous-integration](https://github.com/wmeints/plsexplain/actions/workflows/ci.yml/badge.svg)](https://github.com/wmeints/plsexplain/actions/workflows/ci.yml)

## Getting started

You can install this tool as a python package on your machine by using the
following command in your favorite shell:

```shell
pip install plsexplain
```

After you've installed the package, use the following command to get an
explainable AI dashboard for your trained model:

```shell
plsexplain <path-to-model> <path-to-sample-set>
```

Currently, we support models trained with scikit-learn, but we're planning on
supporting tensorflow and pytorch as well.

The sample set, is a small dataset containing samples you want to use in the
dashboard for explanations based on sample data. We only support using
CSV files at the moment.

## Documentation

Please refer to the documentation for more information on how to use the tool
for various types of models and sample datasets.

[📖 Read the documentation][DOCUMENTATION]

## Contributing

We welcome contributions to this project. Please refer to the
developer guide for more information on how to submit
issues and pull requests for this project.

[🛠 Read the developer guide][CONTRIBUTOR_GUIDE]

## Code of conduct

Please make sure to follow our [code of conduct][CODE_OF_CONDUCT] when
interacting with other contributors on this project.

[CODE_OF_CONDUCT]: CODE_OF_CONDUCT.md
[CONTRIBUTOR_GUIDE]: https://wmeints.github.io/plsexplain/contributing/index.html
[DOCUMENTATION]: https://wmeints.github.io/plsexplain
