aequitas-fairlib

FairLib - Python Library for Fairness Metrics and Processing

This library provides a set of tools for measuring and improving fairness in machine learning models, covering a variety of fairness metrics, pre-processing, in-processing, and post-processing techniques.

Complete Workflow Example Notebook

Library functionality

The library will provide some fairness metrics to perform various analyses. Plus a number of pre-processing, in-processing and post-processing algorithms.

Fairness Metrics

• Statistical Parity Difference - Example Notebook
• Disparate Impact - Example Notebook
• Equal Opportunity Difference - Example Notebook

Pre-Processing Techniques

• Disparate Impact Remover - Example Notebook
• LFR (Learning Fair Representations) - Example Notebook
• Reweighing - Example Notebook

In-Processing Techniques

• FaUCI - Example Notebook
• Adversarial Debiasing - Example Notebook
• Prejudice Remover - Example Notebook

Project Structure

Overview of the project structure:

<root directory>
├── fairlib/               # Main package for the project
│   ├── __init__.py        # Package marker
│   ├── metrics/           # Fairness metrics implementations
│   ├── preprocessing/     # Pre-processing techniques for fairness
│   └── inprocessing/      # In-processing debiasing algorithms
├── tests/                 # Unit tests for the library
│   ├── metrics/           # Unit tests for fairness metrics
│   ├── preprocessing/     # Unit tests for pre-processing methods
│   └── inprocessing/      # Unit tests for in-processing techniques
├── examples/             # Jupyter notebooks with examples
├── .github/               # GitHub workflows for CI/CD
│   └── workflows/
│       ├── test.yml       # Run tests on multiple Python versions
│       └── deploy.yml     # Deploy to PyPI if tests succeed
├── pyproject.toml         # Project configuration file managed by Poetry
├── LICENSE                # License file (Apache 2.0 by default)
├── README.md              # Project documentation (this file)
├── renovate.json          # Configuration of Renovate bot, for automatic dependency updates
├── requirements.txt       # Only declares a dependency on Poetry. DO NOT EDIT THIS FILE
└── release.config.js      # Script to release on PyPi, and GitHub via semantic-release

Restore dev dependencies

1. Install Poetry if you don't have it yet

pip install -r requirements.txt

2. Install the project's dependencies

poetry install

Run unit tests

poetry run poe test

Tests are automatically run in CI, on all pushes on all branches. There, tests are executed on multiple OS (Win, Mac, Ubuntu) and on multiple Python versions.