Skip to contents

Binary Label Dataset Metric

Source: R/binary_label_dataset_metric.R
binary_label_dataset_metric.Rd

Class for computing metrics on an aif360 compatible dataset with binary labels.

Usage

binary_label_dataset_metric(dataset, privileged_groups, unprivileged_groups)

Arguments

dataset

A aif360 compatible dataset.

privileged_groups

Privileged groups. List containing privileged protected attribute name and value of the privileged protected attribute.

unprivileged_groups

Unprivileged groups. List containing unprivileged protected attribute name and value of the unprivileged protected attribute.

See also

Explore available binary label dataset metrics here

Available metrics are: base_rate, consistency, disparate_impact, mean_difference, num_negatives, num_positives and statistical_parity_difference.

Examples

if (FALSE) {
load_aif360_lib()
# Load the adult dataset
adult_dataset <- adult_dataset()

# Define the groups
privileged_groups <- list("race", 1)
unprivileged_groups <- list("race", 0)

# Metric for Binary Label Dataset
bm <- binary_label_dataset_metric(dataset = adult_dataset,
                                  privileged_groups = privileged_groups,
                                  unprivileged_groups = unprivileged_groups)

# Difference in mean outcomes between unprivileged and privileged groups
bm$mean_difference()
}