Metadata-Version: 2.3
Name: mlxplain
Version: 1.0.2
Summary: An open platform for accelerating the development of eXplainable AI systems
Author-email: Arthur Babey <arthur.babey@heig-vd.ch>, Jean-Marc Boutay <jean-marc.boutay@heige.ch>, Rémy Marquis <remy.marquis@heig-vd.ch>
License: 3-Clause BSD License
License-File: LICENSE
Keywords: machine learning,xai
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.9.0
Requires-Dist: black>=24.4.2
Requires-Dist: build>=1.0.3
Requires-Dist: coverage>=7.5.4
Requires-Dist: dash-bootstrap-components>=1.6.0
Requires-Dist: dash>=2.17.1
Requires-Dist: flake8>=7.1.0
Requires-Dist: jupyter-dash>=0.4.2
Requires-Dist: omnixai-community>=1.3.2.2
Requires-Dist: pre-commit>=3.7.1
Requires-Dist: rules-extraction>=0.1.1
Requires-Dist: sphinx-autodoc-typehints>=1.25.3
Requires-Dist: sphinx-rtd-theme>=1.3.0
Requires-Dist: sphinx>=6.2.1
Requires-Dist: torch>=2.4.0
Requires-Dist: torchvision>=0.19.0
Description-Content-Type: text/markdown

# MLxplain ![build](https://github.com/HES-XPLAIN/mlxplain/actions/workflows/build.yml/badge.svg)
An open platform for accelerating the development of eXplainable AI systems

* [Documentation](https://hes-xplain.github.io/mlxplain/)

## Installation

```
pip install mlxplain
```

## Contribution

### Install Python

Install [Python](https://www.python.org/), version 3.9 or newer (3.11 recommended):

* **Linux, macOS, Windows/WSL**: Use your package manager to install `python3` and `python3-dev`
* **Windows**: `winget install Python.Python.3.11`

> [!WARNING]
> On Windows, avoid installing Python through the Microsoft Store as the package has additional permission restrictions.

### Install dependencies

Using pip

```shell
python -m venv .venv
source .venv/bin/activate
pip install .
```

> [!NOTE]
> On Windows, use `.venv\Scripts\activate` instead.

### Work with virtualenv

To activate the virtualenv, use the standard methods:

* Unix: `source .venv/bin/activate`
* Windows: `.venv\Scripts\activate`

To leave the virtualenv, use `deactivate`.

### Install Pre-commit hooks

Git hooks are used to ensure quality checks are run by all developers every time
before a commit.

Install with `pip install pre-commit`.

To enable pre-commit:

```shell
pre-commit install
```

Pre-commit hooks can be run manually with:

```shell
pre-commit run --all-files
```

## Release

To publish the package on [PyPI](https://pypi.org/project/mlxplain/), refer to [RELEASE](RELEASE.md).
