Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cisco-open/flame
flame is a federated learning system for edge with flexibility and scalability at the core of its design.
https://github.com/cisco-open/flame
Last synced: about 1 month ago
JSON representation
flame is a federated learning system for edge with flexibility and scalability at the core of its design.
- Host: GitHub
- URL: https://github.com/cisco-open/flame
- Owner: cisco-open
- License: apache-2.0
- Created: 2021-10-06T01:21:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T10:22:22.000Z (5 months ago)
- Last Synced: 2024-08-03T16:14:35.250Z (4 months ago)
- Language: Python
- Homepage:
- Size: 13.8 MB
- Stars: 51
- Watchers: 4
- Forks: 25
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- FLsystem-paper - `Github`
README
[](https://join.slack.com/t/flame-slack/shared_invite/zt-1mprreo9z-FmpGb1UPi43JOFJKyhIqAQ)
[:fire: **Quickstart! (Ubuntu)** :fire:](docs/quickstart-ubuntu.md)
[:fire: **Quickstart! (macOS)** :fire:](docs/quickstart-mac.md)
Flame is a platform that enables developers to compose and deploy federated learning (FL) training workloads easily.
The system is comprised of a service (control plane) and a python library (data plane).
The service manages machine learning workloads, while the python library facilitates composition of ML workloads.
And the library is also responsible for executing FL workloads.
With extensibility of its library, Flame can support various experimentations and use cases.
We have improved Flame with a redesigned control plane and data plane
(called LIFL) for efficient FL aggregation at scale. LIFL leverages shared memory processing to achieve high-performance communication for hierarchical aggregation. We also introduce locality-aware placement in LIFL to maximize the benefits of shared memory processing. LIFL precisely scales and carefully reuses the resources for hierarchical aggregation to achieve the highest degree of parallelism while minimizing the aggregation time and resource consumption.
[:fire: **Quickstart with LIFL** :fire:](docs/lifl/lifl.md)
## Prerequisites
The target runtime environment is Linux. Development has been mainly conducted under macOS environment.
One should first set up a development environment.
For more details, refer to [here](docs/prerequisites.md).
This repo has the following directory structure:
```
flame
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile -> build/Makefile
├── README.md
├── api (specification of REST API for flame apiserver)
├── build (configuration files for building flame binaries and container image)
├── cmd (source files for flame control plane)
├── docs (document folder)
├── examples (example folder)
├── fiab (dev/test env in a single box)
├── go.mod
├── go.sum
├── lib (python library for core flame data plane)
├── lint.sh
├── pkg (go packages for cmd)
└── scripts (utility scripts)
```
## Supported Algorithms/Mechanisms
| Method | Note |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------|
| FedAvg | https://arxiv.org/pdf/1602.05629.pdf |
| FedYogi | https://arxiv.org/pdf/2003.00295.pdf |
| FedAdam | https://arxiv.org/pdf/2003.00295.pdf |
| FedAdaGrad | https://arxiv.org/pdf/2003.00295.pdf |
| FedProx | https://arxiv.org/pdf/1812.06127.pdf |
| FedBuff | Asynchronous FL (https://arxiv.org/pdf/2106.06639.pdf and https://arxiv.org/pdf/2111.04877.pdf); secure aggregation is excluded |
| FedDyn | https://arxiv.org/pdf/2111.04263.pdf |
| OORT | https://arxiv.org/pdf/2010.06081.pdf; client selection algorithm / mechanism; experimental release |
| Hierarchical FL | https://arxiv.org/pdf/1905.06641.pdf; a simplified version where k2 = 1; support both synchronous and asynchronous FL |
| Hybrid FL | A hybrid approach to combine federated learning with ring-reduce; topology motivated from https://openreview.net/pdf?id=H0oaWl6THa |
## Documentation
A full document can be found [here](docs/README.md). The document will be updated on a regular basis.
## Support
We welcome feedback, questions, and issue reports.
* Maintainers' email address:
* [GitHub Issues](https://github.com/cisco-open/flame/issues/new/choose)
## Contributors
## Citation
```
@inproceedings{flame2023,
author = {Harshit Daga and Jaemin Shin and Dhruv Garg and Ada Gavrilovska and Myungjin Lee and Ramana Rao Kompella},
title = {Flame: Simplifying Topology Extension in Federated Learning},
year = {2023},
booktitle = {Proceedings of the 2023 ACM Symposium on Cloud Computing},
keywords = {Federated Learning, Distributed Machine Learning},
series = {SoCC '23}
}
```
```
@inproceedings{lifl-mlsys24,
author = {Qi, Shixiong and Ramakrishnan, K. K. and Lee, Myungjin},
title = {LIFL: A Lightweight, Event-Driven Serverless Platform for Federated Learning},
year = {2024},
booktitle = {Proceedings of Machine Learning and Systems},
}
```