Skip to main content

_PACKAGE IN CONSTRUCTION_

Project description

equal-odds

This repository is under construction :construction:

PyPI publishing status PyPI version OSI license Python compatibility

A fast adjust

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)

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.4.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

equal_odds-0.0.4-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: equal-odds-0.0.4.tar.gz
  • Upload date:
  • Size: 16.7 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.4.tar.gz
Algorithm Hash digest
SHA256 458d1d53f79aef1f8ae280416010fbb29836184107e2114e19e2eb9707fc2b6c
MD5 cbc374b78dee60d08f1a48febd27fa23
BLAKE2b-256 62c6c262ee00554f27516453f374af36321d02ad99fc7c74744a001f611294d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: equal_odds-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 17.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3091a136eef9c93dee9f4ead44c9c724161c2d633fe1a3a99e8d6baf1b96e085
MD5 53bfd07307d7418136ab5f456559321c
BLAKE2b-256 46b1a41a19f1a594f21a8e64cb336df7beda86ffeb9c36524b5f09317fdd5ccd

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