Skip to content

Commit

Permalink
FACTS: short description for viewpoint parameter
Browse files Browse the repository at this point in the history
Signed-off-by: phantom-duck <[email protected]>
  • Loading branch information
phantom-duck committed Mar 8, 2024
1 parent 77701a6 commit 6eba81e
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion aif360/sklearn/detectors/facts/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,22 @@ def bias_scan(
For explanation of each of those metrics, refer either to the
paper [#FACTS23]_ or the demo_FACTS notebook.
viewpoint (str, optional): "macro" or "micro". Defaults to "macro".
viewpoint (str, optional): "macro" or "micro". It refers to the
notions of "macro viewpoint" and "micro viewpoint" defined
in section 2.2 of the paper [#FACTS23]_.
As a short explanation, consider a set of actions A and a
subgroup (cohort / set of individuals) G. Metrics with the
macro viewpoint interpretation are constrained to always apply
one action from A to the entire G, while metrics with the micro
interpretation are allowed to give each individual in G the
min-cost action from A which changes the individual's class.
Note that not all combinations of `metric` and `viewpoint` are
valid, e.g. "Equal Choice for Recourse" only has a macro
interpretation.
Defaults to "macro".
sort_strategy (str, optional): one of the following choices
Expand Down

0 comments on commit 6eba81e

Please sign in to comment.