dimlpfidex

Discretized Interpretable Multi Layer Perceptron (DIMLP) and related algorithms

Contribution

Get the project code

To get the latest source code, install git and clone the repository:

$ git clone https://github.com/HES-XPLAIN/dimlpfidex.git

To download the required dependencies on your system, run:

$ git submodule init
$ git submodule update

Install C++ toolchain

Linux, macOS, Windows/WSL

Install with your package manager:

• a C++ compiler (gcc/g++)
• cmake

Windows

• Install MinGW-W64 with the online installer (64 bit, win32, ucrt)
• Install CMake:

winget install Kitware.CMake

Ensure cmake.exe is accessible in the $PATH environment variable.

cmake.exe --version

Install Python

Install Python:

Manually

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

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

Using Rye

• Install Rye and add shims to your PATH.

Ensure rye is accessible in the $PATH environment variable. Rye will automatically download the suitable Python toolchain as needed.

To check the installation, check the following commands return an output:

rye --version

Install Python dependencies

Using pip

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

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

Using Rye

Install python dependencies and create a virtualenv in .venv:

rye sync

Add dependencies

To add new dependencies to the project, either add them to the pyproject.toml file or use rye add <dependency>. To add them to the virtualenv, use pip install . or rye sync.

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.

Compile and Package

Compile and create archives for distribution:

python -m build

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 orrye sync.

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.

Credits

Our test suite is using Obesity or CVD risk dataset from AravindPCoder (under CC BY-SA 4.0 license)