-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(baselines): Add FedSaSync strategy #7503
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
VictorHidalgoUCLM
wants to merge
39
commits into
flwrlabs:main
Choose a base branch
from
VictorHidalgoUCLM:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+10,094
−0
Open
Changes from 27 commits
Commits
Show all changes
39 commits
Select commit
Hold shift + click to select a range
5e6a713
Add fedsasync baseline
c23577f
Unmodified FedSaSync strategy injection to server_app
a429f82
Add utils functions for FedSaSync
2ad78da
Overwrite configure_train() and start()
45d9205
Add default config; support name usage on --run-config
1d3f28c
Add semiasync support
7cdd829
Added fraction-slow support
a38172f
Utils refactor
2fe2cbf
Added dataset support (cifar10, mnist)
869ab5a
Add experiment automation
508f6de
Add results to a csv for later graphing
9cc9df0
Add graph system (v0.1)
b62c527
Add random seed on the system for reproducibility
c8e0240
First execution and graphing
fabe3f9
Changed config system: on execution instead of .toml
5e86192
Added multiple log saving support
80f239a
Changed slow number client decision; add new metrics
eae5e06
Execution results
bbba8cd
Executions performed
b78fca8
Version back
bb23a19
Results obtained for MNIST and CIFAR10
33b88a6
Formatting and tests passed
527acae
Updated medatadata
2902980
Updated medatadata
934e4e8
Added fab-exclude
25ab221
Merge branch 'flwrlabs:main' into main
VictorHidalgoUCLM 3f72231
Potential fix for pull request finding
VictorHidalgoUCLM 4bc0648
Apply suggestions from code review
VictorHidalgoUCLM dfaafcd
Modify README commands to include federation config
VictorHidalgoUCLM 3952ca9
Add federation config to CIFAR-10 experiment script
VictorHidalgoUCLM 4eae645
Add federation config to MNIST experiment script
VictorHidalgoUCLM cdeadfb
Modify round end condition to include empty message IDs
VictorHidalgoUCLM 387c5a4
Merge branch 'main' into main
VictorHidalgoUCLM 0e7bd41
Apply suggestions from code review
VictorHidalgoUCLM ee947e1
Update fab-exclude in pyproject.toml
VictorHidalgoUCLM a745782
Apply suggestions from code review
VictorHidalgoUCLM f9513ac
Apply suggestions from code review
VictorHidalgoUCLM 2d176e1
Apply suggestions from code review
VictorHidalgoUCLM 0ae265a
Merge branch 'main' into main
VictorHidalgoUCLM File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
|
|
||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| APPENDIX: How to apply the Apache License to your work. | ||
|
|
||
| To apply the Apache License to your work, attach the following | ||
| boilerplate notice, with the fields enclosed by brackets "[]" | ||
| replaced with your own identifying information. (Don't include | ||
| the brackets!) The text should be enclosed in the appropriate | ||
| comment syntax for the file format. We also recommend that a | ||
| file or class name and description of purpose be included on the | ||
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright [yyyy] [name of copyright owner] | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| title: "Semi-asynchronous Federated Learning in Flower: Framework Extension and Performance Assessment" | ||
| url: https://arxiv.org/abs/2606.24230 | ||
| labels: [Federated Learning, Semi-Asynchronous, System Heterogeneity, Flower] | ||
| dataset: [CIFAR10, MNIST] | ||
| --- | ||
| # FedSaSync: Semi-asynchronous Federated Learning in Flower | ||
|
|
||
| > Note: If you use this baseline in your work, please remember to cite the original authors of the paper as well as the Flower paper. | ||
|
|
||
| **Paper:** [arxiv.org/abs/2606.24230](https://arxiv.org/abs/2606.24230) | ||
|
|
||
| **Authors:** Víctor Hidalgo-Izquierdo, Carmen Carrión, Blanca Caminero | ||
|
|
||
| **Abstract:** This paper presents an extension of the Flower federated learning framework to support Semi-Asynchronous Federated Learning. The proposed approach adapts the traditional synchronous paradigm to better handle client heterogeneity and straggler effects. By introducing a semi-asynchronous training strategy, the system allows partial synchronization among clients while maintaining training efficiency and scalability. We implement and evaluate the proposed modification within Flower, instantiated as the FedSaSync strategy, demonstrating improved robustness and reduced idle time compared to fully synchronous baselines in heterogeneous environments. The results show that SAFL can balance convergence stability and system efficiency in heterogeneous environments typical of edge and distributed learning scenarios. | ||
|
|
||
|
|
||
| ## About this baseline | ||
|
|
||
| **What’s implemented:** The code in this directory is used to execute the experiments proposed in *Semi-asynchronous Federated Learning in Flower: Framework Extension and Performance Assessment* (Hidalgo et al., 2026) for CIFAR10 and MNIST, which proposed the FedSaSync algorithm. Concretely, the results are exposed for both datasets in Figures 4 and 5, and in Tables 3 and 4 | ||
|
|
||
| **Datasets:** CIFAR10, MNIST | ||
|
|
||
| **Hardware Setup:** These experiments were run on a desktop machine with an 12th Gen Intel(R) Core(TM) i7-12700 (20 CPU threads). Any machine with with 4 CPU cores or more would be able to run it in a reasonable amount of time. Note: the entire experiment runs on a CPU-only mode, but GPU support is included on code. | ||
|
VictorHidalgoUCLM marked this conversation as resolved.
Outdated
|
||
|
|
||
| **Contributors:** Víctor Hidalgo-Izquierdo, Carmen Carrión, Blanca Caminero | ||
|
|
||
|
|
||
| ## Experimental Setup | ||
|
|
||
| **Task:** Image classification | ||
|
|
||
| **Model:** A PyTorch simple CNN adapted from 'PyTorch: A 60 Minute Blitz'. This is the model used by default in Flower. Note: The model has been modified to adapt to each dataset input, as well as the lr (see `model.py`). | ||
|
|
||
| **Dataset:** This baseline includes both CIFAR10 and MNIST datasets. They are partitioned into 10 clients following an IID partitioning where all clients receive data drawn from the same underlying distribution, ensuring balanced and homogeneous data across clients. | ||
|
|
||
| | Dataset | # classes | # rounds | # partitions | partitioning method | partition settings | | ||
| | :------ | :------: | :-------: | :----------: | :-------------------------: | :------------------: | | ||
| | CIFAR10 | 10 | 50 | 10 | IID Partitioning | Homogeneous data | | ||
| | MNIST | 10 | 25 | 10 | IID Partitioning | Homogeneous data | | ||
|
|
||
| **Training Hyperparameters:** The following table shows the main hyperparameters for this baseline with their default value (i.e. the value used if you run `flwr run .` directly) | ||
|
|
||
| | Description | Default Value | | ||
| | ------------------- | -------------------------------------------------- | | ||
| | total clients | 10 | | ||
| | clients per round | 10 | | ||
| | client resources | {'num_cpus': 2.0, 'num_gpus': 0.0} | | ||
| | strategy name | FedSaSync | | ||
| | number of rounds | 50 | | ||
| | slow clients | 0 | | ||
| | semiasynchronous degree | 10 | | ||
| | dataset name | "uoft-cs/cifar10" | | ||
| | learning rate | 0.01 | | ||
|
|
||
|
VictorHidalgoUCLM marked this conversation as resolved.
Outdated
|
||
| **Experiment configurations:** The following table shows the configurations to be used on the experiments, defined in `run_cifar10_experiments.sh` and `run_mnist_experiments.sh` (these configurations will later overwrite the default values with the `--run-config` option during `flwr run .`) | ||
| | dataset name | slow clients | semiasynchronous degree | number of rounds | learning rate | | ||
| | ---------------- | ------------- | ----------------------- | --------------------------------- | --------------------------------- | | ||
| | {CIFAR10, MNIST} | {0, 1, 2} | {7, 8, 9, 10, FedAvg} | *fixed according to the experiment* | *fixed according to the experiment* | | ||
|
|
||
| Note: `number of rounds` is 50 for CIFAR10, and 25 for MNIST; `learning rate` is 0.01 for CIFAR10, and 0.05 for MNIST | ||
|
|
||
| ## Environment Setup | ||
|
|
||
| To construct the Python environment, simply run: | ||
|
|
||
| ```bash | ||
| # Create the virtual environment | ||
| pyenv virtualenv 3.12.12 FedSaSync | ||
|
|
||
| # Activate it | ||
| pyenv activate FedSaSync | ||
|
|
||
| # Install the baseline | ||
| pip install -e . | ||
| ``` | ||
|
|
||
| ## Running the Experiments | ||
|
|
||
| To run this FedSaSync, first ensure that your environment is properly activated as described above. For unique executions, do the following: | ||
|
|
||
| ```bash | ||
| flwr run . # this will run using the default settings in the `pyproject.toml` | ||
|
|
||
| # you can override settings directly from the command line | ||
| flwr run . --run-config "name='FedAvg' number-slow=1" # for FedAvg with 1 slow client | ||
| # for FedSaSync with 2 slow clients, semiasync degree 8, mnist dataset | ||
| flwr run . --run-config "num-server-rounds=25 semiasync-deg=8 number-slow=2 dataset-name='ylecun/mnist'" | ||
| ``` | ||
|
|
||
| The baseline includes the scripts `run_cifar10_experiments.sh` and `run_mnist_experiments.sh`, which are designed to execute the experiments reported in the paper using the predefined configurations. The configurations are described on the table below, at Experimental Setup: | ||
|
|
||
| ```bash | ||
| bash run_cifar10_experiments.sh # CIFAR10 | ||
| bash run_mnist_experiments.sh # MNIST | ||
| ``` | ||
|
|
||
| We include a python script to automatically print several graphs to summarise the executions (see `_static/graphing.py`). Depending on the experiments performed, change the global configuration to define what will be printed on the plots. All results are saved in `_static`. Each experiment generates two visualizations: a comparative plot grouped by the number of slow clients to analyze the impact of different semi-asynchronous degrees, and a summary table showing the mean training efficiency under each configuration, measured on loss per second. To generate these visualizations, proceed as follows: | ||
|
|
||
| ```bash | ||
| python _static/graphing.py # Plot the results after executing | ||
| ``` | ||
|
|
||
| Results for CIFAR10: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Results for MNIST: | ||
|
|
||
|  | ||
|  | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.