Skip to content

cjiajiazhuiqiu/aequitas

 
 

Repository files navigation

The Bias and Fairness Audit Toolkit

Aequitas

Aequitas is an open-source bias audit toolkit for data scientists, machine learning researchers, and policymakers to audit machine learning models for discrimination and bias, and to make informed and equitable decisions around developing and deploying predictive risk-assessment tools.

Learn more about the project.

Demo

See what Aequitas can do.

Sample Jupyter Notebook

Explore bias analysis of the COMPAS data using the Aequitas library.

Documentation

Find documentation here.

Installation

Aequitas requires Python 3.

Install this Python library from source:

python setup.py install

...or named as an installation requirement, e.g. via pip:

python -m pip install git+https://github.com/dssg/aequitas.git

You may then import the aequitas module from Python:

import aequitas

...or execute the auditor from the command line:

aequitas-report

...or, also from the command line, launch the Web front-end:

python -m serve

(Note: The above command launches a Web server only intended for development.)

Development

Provision your development environment via the shell script develop:

./develop

Common development tasks, such as deploying the webapp, may then be handled via manage:

manage --help

Containerization

To build a Docker container of Aequitas:

docker build -t aequitas .

...or simply via manage:

manage container build

The Docker image's container defaults to launching the development Web server, though this can be overridden via the Docker "command" and/or "entrypoint".

To run such a container, supporting the Web server, on-the-fly:

docker run -p 5000:5000 -e "HOST=0.0.0.0" aequitas

...or, manage a development container via manage:

manage container [create|start|stop]

Find out more at the documentation.

To contact the team, please email us at [aequitas at uchicago dot edu]

Citing Aequitas ====

If you use Aequitas in a scientific publication, we would appreciate citations to the following paper:

Pedro Saleiro, Benedict Kuester, Abby Stevens, Ari Anisfeld, Loren Hinkson, Jesse London, Rayid Ghani, Aequitas: A Bias and Fairness Audit Toolkit, arXiv preprint arXiv:1811.05577 (2018). ( PDF)

|

|

© 2018 Center for Data Science and Public Policy - University of Chicago

Packages

No packages published

Languages

  • Python 52.5%
  • HTML 19.6%
  • CSS 15.2%
  • JavaScript 10.9%
  • Shell 1.7%
  • Dockerfile 0.1%