The fairness
R package offers tools to calculate fair ML metrics across different sensitive groups. The metrics are computed based on model predictions in a binary classification task. The package also provides opportunities to visualize and compare prediction metrics between the groups.
The package implements the following fairness metrics: - Demographic parity (also known as independence) - Proportional parity - Equalized odds (also known as separation) - Predictive rate parity - False positive rate parity - False negative rate parity - Accuracy parity - Negative predictive value parity - Specificity parity - ROC AUC parity - MCC parity
The comprehensive tutorial is provided in this blog post. We recommend that you go through the tutorial, as it contains a more in-depth description of the package compared to this README. You will also find a brief tutorial in the fairness vignette:
vignette('fairness')
You can install the latest stable package version from CRAN by running:
install.packages('fairness')
library(fairness)
You may also install the development version from Github:
library(devtools)
devtools::install_github('kozodoi/fairness')
library(fairness)
data('compas')
The data already contains all variables necessary to run all parity metrics. In case you set up your own predictive model, you will need to concatenate predicted probabilities or predictions (0/1) to your original dataset or supply them as a vector to the corresponding metric function.
All fairness metrics are implemented as separate functions with the same structure of inputs including the outcome variable, model predictions and a sensitive group feature.
compas$Two_yr_Recidivism_01 <- ifelse(compas$Two_yr_Recidivism == 'yes', 1, 0)
equal_odds(data = compas,
outcome = 'Two_yr_Recidivism_01',
probs = 'probability',
group = 'ethnicity',
cutoff = 0.5,
base = 'Caucasian')
#> Caucasian African_American Asian Hispanic
#> Sensitivity 0.4720 0.7526 0.2500 0.4656
#> Equalized odds 1.0000 1.5943 0.5296 0.9864
#> Group size 2103.0000 3175.0000 31.0000 509.0000
#> Native_American Other
#> Sensitivity 0.6000 0.4194
#> Equalized odds 1.2711 0.8884
#> Group size 11.0000 343.0000
Bar chart for the equalized odds metric:
Predicted probability plot for all subgroups:
To cite this package in scientific publications, please use the following query to generate a reference as a text or a BibTeX entry:
citation('fairness')
Nikita Kozodoi and Tibor V. Varga (2020). fairness: Algorithmic Fairness Metrics. R package version 1.2.1.
@Manual{,
title = {fairness: Algorithmic Fairness Metrics},
author = {Nikita Kozodoi and Tibor {V. Varga}},
year = {2021},
note = {R package version 1.2.1},
url = {https://CRAN.R-project.org/package=fairness},
}
Installation requires R 3.6+ and the following packages: - caret - ggplot2 - pROC - e1071
In case you need help or advice on fairness metrics or you want to report an issue, please do so in a reproducible example at the corresponding GitHub page.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.