Skip to content

Commit f97b7bf

Browse files
committed
linking with MAI BIAS In readme
1 parent 2ef5863 commit f97b7bf

1 file changed

Lines changed: 36 additions & 13 deletions

File tree

README.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,46 @@
77
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
88
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
99

10+
11+
## Who is this for?
12+
13+
- **ML engineers and data scientists** building or evaluating models in Python.
14+
- **Bias auditors and compliance teams** needing standardized, traceable fairness reports.
15+
- **Researchers** studying AI bias across data modalities (tabular, vision, LLMs, etc).
16+
- **Policymakers and analysts** who want reproducible evidence for decision‑making. Consider using the low‑code MAI‑BIAS toolkit for a higher level perspective.
17+
18+
## About
19+
1020
FairBench can be imported in Python AI projects to
1121
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
22+
fairness concerns. In particular, it produces reports that
23+
can be viewed in various formats
24+
(e.g., in the terminal, in the browser) as part of ongoing
1425
reporting by developers, auditors, and eventually policymakers
1526
with a certain degree of technical background.
1627

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
28+
Fairness exploration is not limited to one or a few measures at a time,
29+
though single-measure computations are still available, in line with other
1930
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.
31+
that keep track of intermediate quantities. Furthermore, when reporting focuses
32+
single metrics that may miss the bigger picture, it is
33+
accompanied by caveats and recommendations extracted through the help of
34+
social scientists.
2335

24-
FairBench is independent of data modality, for example by
36+
FairBench is independent of data modality, for example by
2537
supporting -among others- regression and multiclass outputs
2638
from most popular computational frameworks. It can also be used to
2739
uncover LLM biases.
2840

29-
The library can be installed in your environment and called directly
30-
from your code. BUt it also
41+
If you have some coding experience with Python stacks like
42+
Pandas and NumPy, the library can be installed in your environment
43+
and called directly from your code. But it also
3144
supports many fairness analysis functionalities
32-
in the low-code environment of the
45+
for immediate use by non-technical people in the low-code environment of the
3346
[MAI-BIAS toolkit](https://mammoth-eu.github.io/mammoth-commons/index.html).
3447

48+
## Highlights
3549

36-
A comprehensive AI fairness exploration framework. <br>
3750
🧱 Build measures from simpler blocks<br>
3851
📈 Fairness reports and stamps <br>
3952
⚖️ Multivalue multiattribute <br>
@@ -51,6 +64,11 @@ stable (currently 3.12).*
5164

5265
## Quick measure
5366

67+
💡 Non‑technical users can run the same
68+
analysis through the MAI‑BIAS toolkit without writing code.
69+
See the higher-level toolkit summary in the first
70+
example [here](https://mammoth-eu.github.io/mammoth-commons/examples.html).
71+
5472
```python
5573
import fairbench as fb
5674

@@ -65,9 +83,14 @@ abroca.roc.show()
6583

6684
![docs/simplest.png](docs/simplest.png)
6785

68-
6986
## Full report
7087

88+
💡 Non‑technical users can run the same
89+
analysis through the MAI‑BIAS toolkit without writing code.
90+
See the higher-level toolkit summary in the second
91+
example [here](https://mammoth-eu.github.io/mammoth-commons/examples.html).
92+
93+
7194
```python
7295
import fairbench as fb
7396

0 commit comments

Comments
 (0)