Discretized Interpretable Multi Layer Perceptron (DIMLP) and related algorithms
Project description
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
andpython3-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
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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for dimlpfidex-0.0.1-cp311-cp311-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 533df59de9c8f198679c21b09d49a15c376c9b639974d1764a20e9089fda1ab9 |
|
MD5 | 179d52d19ace3f13057d2b9016e8dbb5 |
|
BLAKE2b-256 | ec9de79b5362d4f42beb4a5c2b146b80143a52a3074ab09c7032abcdefc2e345 |
Hashes for dimlpfidex-0.0.1-cp311-cp311-macosx_12_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3926869f4f30de83f6f16f19f952eba8365d22f29b27d1555f5509442652d95 |
|
MD5 | aee863b9711092c4b9813382574f8cb5 |
|
BLAKE2b-256 | ae070037d75c5b64745171d3fc9739de2d1216e8731900d4b1c802146252339d |
Hashes for dimlpfidex-0.0.1-cp310-cp310-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f028c3e566ab65e7bd1ef37762926f020c9540009d2d2a7337a52d9c0bb2df0 |
|
MD5 | 7cc88def0d73970553f2bf85dc23e454 |
|
BLAKE2b-256 | 86c1ec2f7ac6bc9038b19ff31574a4c38d7d30a23c371b1a833411cb75279f0f |
Hashes for dimlpfidex-0.0.1-cp310-cp310-macosx_12_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b66baa16eb5561554a2607949a48fe18cbfc99254b3461f919362e7f482d0eb |
|
MD5 | 078c21cbafb6063d1da88a78eda33451 |
|
BLAKE2b-256 | 9c47d959ac33e2d0ee7e369cfb3c1f90f1dc2aa3d12716c19ab673782d42bb9b |
Hashes for dimlpfidex-0.0.1-cp39-cp39-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7903a8530eb97d7649e6510c6a99201c57946b5d808a2ac0c99b0ce5891b0120 |
|
MD5 | 4be6777d8e0567cc1434a05e7647bdc3 |
|
BLAKE2b-256 | 55c2e365036bad4a54739126f35a40e7482c525b9a20dd51308934189e028677 |
Hashes for dimlpfidex-0.0.1-cp39-cp39-macosx_12_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11d3b8cfaa528e3afc61a0cbc4473a04a859d238ee12e14a83532d3cea275e6e |
|
MD5 | 651698260d1cddc6697fd6a7b52672ff |
|
BLAKE2b-256 | 28f8f76ca0039b489b3f697d7229664be7d1ddc58804cf465046c9863cfc3ce9 |
Hashes for dimlpfidex-0.0.1-cp38-cp38-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90dbd6f2cbb9d4202dede5e422e44bb516d89c16f6af29fd01d18378633d0722 |
|
MD5 | 9ddbdb1636042a6ea31a2d089e2047b4 |
|
BLAKE2b-256 | a97b531b37106980c6fc5321caa429d2143d951692795ddb103343adc72da706 |
Hashes for dimlpfidex-0.0.1-cp38-cp38-macosx_12_0_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb3a077eec34332554e472d2dc74fce1765486dc161e9bfb73b3ba280e218254 |
|
MD5 | 7e56f542dac59817ff630af082798060 |
|
BLAKE2b-256 | 5c05a2383808d085010c326367b545d8b4c9f3e03e8f178d43b60a57a330071d |