Mentions légales du service

Skip to content
Snippets Groups Projects
Verified Commit b6e5e759 authored by ANDREY Paul's avatar ANDREY Paul
Browse files

Update user-guide on fairness features.

parent b39b2326
No related branches found
No related tags found
1 merge request!69Enable Fairness-Aware Federated Learning
Pipeline #1011093 passed
...@@ -335,7 +335,7 @@ as follows: ...@@ -335,7 +335,7 @@ as follows:
from declearn.fairness.monitor import FairnessMonitorServer from declearn.fairness.monitor import FairnessMonitorServer
fairness = FairnessMonitorServer( fairness = FairnessMonitorServer(
f_type="demographic_parity", # choose any fairness definition f_type="demographic_parity", # choose any fairness definition
) )
optim = FLOptimConfig.from_params( optim = FLOptimConfig.from_params(
...@@ -353,12 +353,26 @@ controller. For instance, to use Fed-FairGrad: ...@@ -353,12 +353,26 @@ controller. For instance, to use Fed-FairGrad:
from declearn.fairness.fairgrad import FairgradControllerServer from declearn.fairness.fairgrad import FairgradControllerServer
fairness = FairgradControllerServer( fairness = FairgradControllerServer(
f_type="demographic_parity", # choose any fairness definition f_type="demographic_parity", # choose any fairness definition
eta=0.1, # adjust this based on the SGD learning rate and empirical tuning eta=0.1, # adjust this based on the SGD learning rate and empirical tuning
eps=0.0, # change this to configure epsilon-fairness eps=0.0, # change this to configure epsilon-fairness
) )
``` ```
Equivalently, the choice of fairness controller class and parameters may be
specified using a configuration dict (that may be parsed from a TOML file):
```python
fairness = {
# mandatory parmaeters:
"algorithm": "fairgrad", # name of the algorithm
"f_type": "demographic_parity", # name of the group-fairness definition
# optional, algorithm-dependent hyper-parameters:
"eta": 0.1,
"eps": 0.0,
}
```
Notes: Notes:
- `declearn.fairness.core.list_fairness_functions` may be used to review all - `declearn.fairness.core.list_fairness_functions` may be used to review all
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment