Skip to main content

A Python package to assess and improve fairness of machine learning models.

Project description

|MIT license| |PyPI| |Discord| |StackOverflow|

Fairlearn

Fairlearn is a Python package that empowers developers of artificial intelligence (AI) systems to assess their system's fairness and mitigate any observed unfairness issues. Fairlearn contains mitigation algorithms as well as metrics for model assessment. Besides the source code, this repository also contains Jupyter notebooks with examples of Fairlearn usage.

Website: https://fairlearn.org/

  • Current release <#current-release>__
  • What we mean by *fairness* <#what-we-mean-by-fairness>__
  • Overview of Fairlearn <#overview-of-fairlearn>__
  • Fairlearn metrics <#fairlearn-metrics>__
  • Fairlearn algorithms <#fairlearn-algorithms>__
  • Install Fairlearn <#install-fairlearn>__
  • Usage <#usage>__
  • Contributing <#contributing>__
  • Maintainers <#maintainers>__
  • Issues <#issues>__

Current release

  • The current stable release is available on PyPI <https://pypi-hypernode.com/project/fairlearn/>__.

  • Our current version may differ substantially from earlier versions. Users of earlier versions should visit our version guide <https://fairlearn.org/main/user_guide/installation_and_version_guide/version_guide.html>_ to navigate significant changes and find information on how to migrate.

What we mean by fairness

An AI system can behave unfairly for a variety of reasons. In Fairlearn, we define whether an AI system is behaving unfairly in terms of its impact on people – i.e., in terms of harms. We focus on two kinds of harms:

  • Allocation harms. These harms can occur when AI systems extend or withhold opportunities, resources, or information. Some of the key applications are in hiring, school admissions, and lending.

  • Quality-of-service harms. Quality of service refers to whether a system works as well for one person as it does for another, even if no opportunities, resources, or information are extended or withheld.

We follow the approach known as group fairness, which asks: Which groups of individuals are at risk for experiencing harms? The relevant groups need to be specified by the data scientist and are application specific.

Group fairness is formalized by a set of constraints, which require that some aspect (or aspects) of the AI system's behavior be comparable across the groups. The Fairlearn package enables assessment and mitigation of unfairness under several common definitions. To learn more about our definitions of fairness, please visit our user guide on Fairness of AI Systems <https://fairlearn.org/main/user_guide/fairness_in_machine_learning.html#fairness-of-ai-systems>__.

*Note*: Fairness is fundamentally a sociotechnical challenge. Many
aspects of fairness, such as justice and due process, are not
captured by quantitative fairness metrics. Furthermore, there are
many quantitative fairness metrics which cannot all be satisfied
simultaneously. Our goal is to enable humans to assess different
mitigation strategies and then make trade-offs appropriate to their
scenario.

Overview of Fairlearn

The Fairlearn Python package has two components:

  • Metrics for assessing which groups are negatively impacted by a model, and for comparing multiple models in terms of various fairness and accuracy metrics.

  • Algorithms for mitigating unfairness in a variety of AI tasks and along a variety of fairness definitions.

Fairlearn metrics


Check out our in-depth `guide on the Fairlearn
metrics <https://fairlearn.org/main/user_guide/assessment>`__.

Fairlearn algorithms

For an overview of our algorithms please refer to our website <https://fairlearn.org/main/user_guide/mitigation/index.html>__.

Install Fairlearn

For instructions on how to install Fairlearn check out our Quickstart guide <https://fairlearn.org/main/quickstart.html>__.

Usage

For common usage refer to the Jupyter notebooks <https://fairlearn.org/main/auto_examples/index.html>__ and our user guide <https://fairlearn.org/main/user_guide/index.html>. Please note that our APIs are subject to change, so notebooks downloaded from main may not be compatible with Fairlearn installed with pip. In this case, please navigate the tags in the repository (e.g. v0.7.0 <https://github.com/fairlearn/fairlearn/tree/v0.7.0>) to locate the appropriate version of the notebook.

Contributing

To contribute please check our contributor guide <https://fairlearn.org/main/contributor_guide/index.html>__.

Maintainers

A list of current maintainers is on our website <https://fairlearn.org/main/about/index.html>__.

Issues

Usage Questions


Pose questions and help answer them on `Stack
Overflow <https://stackoverflow.com/questions/tagged/fairlearn>`__ with
the tag ``fairlearn`` or on
`Discord <https://discord.gg/R22yCfgsRn>`__.

Regular (non-security) issues

Issues are meant for bugs, feature requests, and documentation improvements. Please submit a report through GitHub issues <https://github.com/fairlearn/fairlearn/issues>__. A maintainer will respond promptly as appropriate.

Maintainers will try to link duplicate issues when possible.

Reporting security issues


To report security issues please send an email to
``fairlearn-internal@python.org``.

.. |MIT license| image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://github.com/fairlearn/fairlearn/blob/main/LICENSE
.. |PyPI| image:: https://img.shields.io/pypi/v/fairlearn?color=blue
   :target: https://pypi-hypernode.com/project/fairlearn/
.. |Discord| image:: https://img.shields.io/discord/840099830160031744
   :target: https://discord.gg/R22yCfgsRn
.. |StackOverflow| image:: https://img.shields.io/badge/StackOverflow-questions-blueviolet
   :target: https://stackoverflow.com/questions/tagged/fairlearn

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

fairlearn-0.9.0.tar.gz (165.9 kB view details)

Uploaded Source

Built Distribution

fairlearn-0.9.0-py3-none-any.whl (231.5 kB view details)

Uploaded Python 3

File details

Details for the file fairlearn-0.9.0.tar.gz.

File metadata

  • Download URL: fairlearn-0.9.0.tar.gz
  • Upload date:
  • Size: 165.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for fairlearn-0.9.0.tar.gz
Algorithm Hash digest
SHA256 34ae33bc9330f7cf47014f2f9ed99ede451ade33e6a9108e2524fef71e0c8c08
MD5 92032b5ac7a2acb97c31f2fb0c8d698f
BLAKE2b-256 9236e05471d51c17601f4cf2a2697d8f15fdecf239b1ff966b641b43481c9686

See more details on using hashes here.

File details

Details for the file fairlearn-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: fairlearn-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 231.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for fairlearn-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08e75168a57274d4c8d24168fbb1e7c3f698f89ea542df12e0bf16886e289f8b
MD5 70d71bf24e1ea9f8abf53c316e6c290b
BLAKE2b-256 b051074c3e83d1254de673819e792326d74fc4b59cbc3820a02bc120b6edb854

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