From b829c49702ce2c02eebdc1305020c87f9233151d Mon Sep 17 00:00:00 2001 From: KarhouTam Date: Thu, 26 Sep 2024 22:55:46 +0800 Subject: [PATCH] docs(readme): Update staled parts --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8d05f0d..f759db6 100644 --- a/README.md +++ b/README.md @@ -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/.py` ⚠ For the same FL method argument, the priority of argument setting is **CLI > Config file > Default value**.