Skip to content

Commit

Permalink
docs(readme): Update staled parts
Browse files Browse the repository at this point in the history
  • Loading branch information
KarhouTam committed Sep 26, 2024
1 parent 55c73ed commit b829c49
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ python main.py method=fedavg
Defaults are set in both [`config/defaults.yaml`](config/defaults.yaml) and [`src/utils/constants.py`](src/utils/constants.py).

### How To Customize FL method Arguments 🤖
- By modifying config file
- By modifying config file.
- By explicitly setting in CLI, e.g., `python main.py --config-name my_cfg.yaml method=fedprox fedprox.mu=0.01`.
- By modifying the default value in `src/utils/constants.py/DEFAULT_COMMON_ARGS` or `get_hyperparams()` of the method
- By modifying the default value in `config/defaults.yaml` or `get_hyperparams()` in `src/server/<method>.py`

⚠ For the same FL method argument, the priority of argument setting is **CLI > Config file > Default value**.

Expand Down

0 comments on commit b829c49

Please sign in to comment.