MLxplain

An open platform for accelerating the development of eXplainable AI systems

• Documentation

Installation

pip install mlxplain

Contribution

Install Python

Install Python, 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

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:

pre-commit install

Pre-commit hooks can be run manually with:

pre-commit run --all-files

Release

To publish the package on PyPI, refer to RELEASE.