Skip to content

Commit 8f7ff4b

Browse files
committed
Update README.md
1 parent ea53bb4 commit 8f7ff4b

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,24 @@ A .csv file of max. 1GB, with columns: features, performance metric. Note: Only
5353

5454
Features values can be numeric or categorical values. The numeric performance metric is context-dependent. The variable can, for instance, represents being 'selected for examination' (yes or no), 'assigned to a high-risk catagory (yes or no)' or false positive (yes or no). Low scores are considered to be a negative bias, i.e., if being selected for examination is considered to be harmful, 'selected for examination=Yes' should be codified as 0 and 'selected for examination=No' should be codified as 1.
5555

56+
## Example – Hierarchical Bias-Aware Clustering
57+
58+
Note: The feature labels used in this example can easily be changed for numeric targets. This flexibility enables adaptation to detect (higher-dimensional) bias in various AI classifiers.
59+
60+
```python
61+
import unsupervised-bias-detection as usb
62+
63+
X = [[35, 55000, 1], # age, income, number of cars
64+
[40, 45000, 0],
65+
[20, 30000, 0]]
66+
y = [1, 0, 0] # flagged for fraud examination (yes:0, no:1)
67+
hbac = BiasAwareHierarchicalKMeans(n_iter=1, min_cluster_size=1).fit(X, y)
68+
hbac.n_clusters_
69+
>>> 2
70+
hbac.scores_
71+
>>> array([ 0.5, -0.5])
72+
```
73+
5674
## Schematic overview
5775
![image](./images/Quantitative-qualitative.png)
5876

@@ -91,4 +109,12 @@ Features values can be numeric or categorical values. The numeric performance me
91109
- Marlies van Eck, Assistant Professor in Administrative Law & AI at Radboud University
92110
- Aileen Nielsen, Fellow Law&Tech at ETH Zürich
93111
- Vahid Niamadpour, PhD-candidate in Linguistics at Leiden University
94-
- Ola Al Khatib, PhD-candidate in the legal regulation of algorithmic decision-making at Utrecht University
112+
- Ola Al Khatib, PhD-candidate in the legal regulation of algorithmic decision-making at Utrecht University
113+
114+
## Help and Support
115+
116+
This project is still in its early stages, and the documentation is a work in progress. In the meantime, feel free to open an [issue](https://github.com/NGO-Algorithm-Audit/unsupervised-bias-detection/issues), and we'll do our best to assist you.
117+
118+
## Contributing
119+
120+
Your contributions are highly encouraged! There are many opportunities for potential projects, so please reach out if you'd like to get involved. Whether it's code, notebooks, examples, or documentation, every contribution is valuable—so don’t hesitate to jump in. To contribute, simply fork the project, make your changes, and submit a pull request. We’ll work with you to address any issues and get your code merged into the main branch.

0 commit comments

Comments
 (0)