Skip to content

Commit 2ef5863

Browse files
committed
updated readme
1 parent 56191c1 commit 2ef5863

2 files changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,38 @@
11
# FairBench
22

3+
[![MAI_BIAS toolkit](https://img.shields.io/badge/MAI_BIAS-fairness_tools-blue?logo=github)](https://mammoth-eu.github.io/mammoth-commons/index.html)
34
![build](https://github.com/mever-team/FairBench/actions/workflows/tests.yml/badge.svg)
45
![coverage](coverage.svg)
56
[![Documentation Status](https://readthedocs.org/projects/fairbench/badge/?version=latest)](https://fairbench.readthedocs.io/)
67
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
78
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
89

10+
FairBench can be imported in Python AI projects to
11+
offer standardized exploration of more than 300
12+
fairness concerns. It produces reports that can be viewed in various formats
13+
(e.g., in the terminal, in the browser) as part of continuous
14+
reporting by developers, auditors, and eventually policymakers
15+
with a certain degree of technical background.
16+
17+
Fairness exploration is not limited to one or a few measure at a time,
18+
though single evaluations are still possible in line with other
19+
industrial frameworks. Instead, FairBench includes traceable computations
20+
that keep track of intermediate quantities. Furthermore, reporting on
21+
single metrics retrieves caveats and recommendations extracted through the
22+
help of social scientists.
23+
24+
FairBench is independent of data modality, for example by
25+
supporting -among others- regression and multiclass outputs
26+
from most popular computational frameworks. It can also be used to
27+
uncover LLM biases.
28+
29+
The library can be installed in your environment and called directly
30+
from your code. BUt it also
31+
supports many fairness analysis functionalities
32+
in the low-code environment of the
33+
[MAI-BIAS toolkit](https://mammoth-eu.github.io/mammoth-commons/index.html).
34+
35+
936
A comprehensive AI fairness exploration framework. <br>
1037
🧱 Build measures from simpler blocks<br>
1138
📈 Fairness reports and stamps <br>

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def read_requirements(filename):
3232
# Setup configuration
3333
setuptools.setup(
3434
name="fairbench",
35-
version="0.9.2",
35+
version="0.9.3",
3636
author="Emmanouil (Manios) Krasanakis",
3737
author_email="maniospas@hotmail.com",
3838
description="A fairness assessment framework",

0 commit comments

Comments
 (0)