MAMMOth-commons 0.0.43

Component interfaces of the MAMMOth fairness toolkit.

MAI-BIAS modules

Quickly develop and locally run MAI-BIAS toolkit modules.

This repository holds the mammoth-commons library with supporting datatypes and decorators shared by various toolkit modules. It also hosts a catalogue of dataset loaders, model loaders, and fairness analysis and mitigation modules. Finally, find ad desktop application that runs the modules in your local machine.

🔬 Run locally

Depending on your operating system, replace python with python3 below.

1. Install Python 3.11 or later. Make sure the version is appropriate with python --version.
2. Download or clone this repository. Prefer working in a virtual environment.
3. Install dependencies with pip install -r requirements[test].txt. This can take a bit of time.
4. Launch the local app with python -m demonstrator.app.

Ubuntu: Example of full pipeline

sudo add-apt-repository ppa:deadsnakes/ppa -y
sudo apt update
sudo apt install python3.11
sudo apt install python3.11-pip
sudo apt install python3.11-venv
git clone [e-mail]:mammoth-eu/mammoth-commons.git
cd mammoth-commons
python3.11 -m venv venv
source venv/bin/activate

Windows: WSL missing .so files

If you are in WSL, you are likely to get errors like this ImportError: libGL.so.1: cannot open shared object file: No such file or directory. This is due to the lack of a graphical environment. Install one like like below, including missing font symbols needed to properly display certain UI element.

sudo apt update
sudo apt install fonts-noto-color-emoji fonts-symbola
sudo apt install libgl1 libxkbcommon-x11-0 libegl1 libnss3 libxcomposite1 \
                 libxdamage1 libxrender1 libxrandr2 libxtst6 libxi6 libasound2 \
                 libxkbfile-dev qt6-wayland libxcb-cursor0 libx11-xcb1 libxcb-xinerama0

VSCode launch profile

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger: Current File",
            "type": "debugpy",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": false,
            "cwd": "${workspaceFolder}",
        },
        {
            "name": "Python: Test",
            "type": "debugpy",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": false,
            "cwd": "${workspaceFolder}",
            "env": {
                "PYTHONPATH": "${workspaceFolder}"
            }
        },
        {
            "name": "Demonstrator",
            "type": "debugpy",
            "request": "launch",
            "module": "demonstrator.app",
            "justMyCode": false
        }
    ]
}

🖥 Deploy in a server

:clipboard: Module catalogue

:thumbsup: Contribute