seismometer._api.fairness_audit

seismometer._api.fairness_audit(metric_list=None, fairness_threshold=1.25)

Displays the Aequitas fairness audit for a set of sensitive groups and metrics.

Parameters:

• metric_list (Optional[list[str]) –

  The list of metrics to use in Aequitas. Chosen from:

  ”tpr”, “tnr”, “for”, “fdr”, “fpr”, “fnr”, “npv”, “ppr”, “precision”, “pprev”.

• fairness_threshold (float) – The maximum ratio between sensitive groups before differential performance is considered a ‘failure’.

Return type:

HTML