Skip to main content

_PACKAGE UNDER CONSTRUCTION_

Project description

equal-odds

PyPI publishing status PyPI version OSI license Python compatibility

Fast postprocessing of any score-based predictor to meet fairness criteria.

The equal-odds package can achieve strict or relaxed fairness constraint fulfillment, which can be useful to compare ML models at equal fairness levels.

Installing

Install package from PyPI:

pip install equal-odds

Or, for development, you can clone the repo and install from local sources:

git clone https://github.com/AndreFCruz/equal-odds.git
pip install ./equal-odds

Getting started

# Given any trained model that outputs real-valued scores
fair_clf = RelaxedEqualOdds(
    predictor=lambda X: model.predict_proba(X)[:, -1],   # for sklearn API
    # predictor=model,  # use this for a callable model
    tolerance=0.05,     # fairness constraint tolerance
)

# Fit the fairness adjustment on some data
# This will find the optimal _fair classifier_
fair_clf.fit(X=X, y=y, group=group)

# Now you can use `fair_clf` as any other classifier
# You have to provide group information to compute fair predictions
y_pred_test = fair_clf(X=X_test, group=group_test)

How it works

Given a callable score-based predictor (i.e., y_pred = predictor(X)), and some (X, Y, S) data to fit, RelaxedEqualOdds will:

  1. Compute group-specific ROC curves and their convex hulls;
  2. Compute the r-relaxed optimal solution for the chosen fairness criterion (using cvxpy);
  3. Find the set of group-specific binary classifiers that match the optimal solution found.
    • each group-specific classifier is made up of (possibly randomized) group-specific thresholds over the given predictor;
    • if a group's ROC point is in the interior of its ROC curve, partial randomization of its predictions may be necessary.

Implementation road-map

We welcome community contributions for cvxpy implementations of other fairness constraints.

Currently implemented fairness constraints:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

equal-odds-0.0.7.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

equal_odds-0.0.7-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file equal-odds-0.0.7.tar.gz.

File metadata

  • Download URL: equal-odds-0.0.7.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for equal-odds-0.0.7.tar.gz
Algorithm Hash digest
SHA256 f66a1b2f583271f05a8ef5ca35f1fd27960fa94f47daaa5c0457c549f421d949
MD5 d5634abfbc272b455d28944674fe400a
BLAKE2b-256 a5d929f4d16ec6861429264298c9f308062c6896a6c72dce81c64328013b04af

See more details on using hashes here.

File details

Details for the file equal_odds-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: equal_odds-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for equal_odds-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c5ac6913e9a1eb360c6bd54c1ae6c657e2c8281485ba60094fc2ad5376ef0461
MD5 d9a54d84b3bc397b43458774047b517b
BLAKE2b-256 c9cefa7565e3200796145567762cb631539aef14d4000dcec319b5ea5e212685

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page