syft-flwr
Easy, file-based, offline capable federated learning
syft-flwr is an open-source framework that combines Flower's federated learning capabilities with file-based communication. Train machine learning models collaboratively across distributed datasets without centralizing data—with easy setup, offline capability, and no servers required.
Key Features
- File-Based Communication: Train models without direct network connections—communication happens via file sync (Google Drive or SyftBox)
- Zero Infrastructure: No servers to maintain, no complex networking setup—just notebooks and file sync
- Offline Capable: Asynchronous message passing enables training even with intermittent connectivity
- Privacy by Design: Data never leaves its source—only model updates are shared
- Flower Integration: Built on Flower's robust FL framework—supports FedAvg, custom strategies, and all standard Flower features
Quick Start
The easiest way to get started is with our Google Colab tutorial—no local setup required:
📓 Zero-Setup FL with Google Colab
Example Notebooks
| Example | Description | Communication |
|---|---|---|
| FL Diabetes (Google Drive) | Train a diabetes prediction model across distributed Colab notebooks | Google Drive |
| FL Diabetes (SyftBox) | Train a diabetes prediction model across distributed machines | SyftBox |
| FL Diabetes (Local) | Local simulation for development and testing | Local |
| Federated Analytics | Query statistics from private datasets and aggregate them | SyftBox |
| FedRAG | Privacy-preserving question answering with RAG | SyftBox |
Installation
Install from PyPI:
pip install syft-flwr
Or install from source:
pip install "git+https://github.com/OpenMined/syft-flwr.git@main"
Development
See DEVELOPMENT.md for development setup and guidelines.
Releasing
See the Releasing section in DEVELOPMENT.md for the complete release process.
Community
- 💬 Slack - Join #support-syftbox for questions
- 🐛 Issues - Report bugs or request features
- 🌟 Star this repo to support the project!
License
1 maintainer
Metadata
1 maintainer
Release files for syft-flwr 0.5.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| syft_flwr-0.5.3.tar.gz | 38.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| syft_flwr-0.5.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 88.4 kB
Release files / syft_flwr-0.5.3.tar.gz
| Download URL | syft_flwr-0.5.3.tar.gz |
|---|---|
| Size | 38.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a8a375e49bc3cba57630d21ce7eeadd02f72addb4054da30ddfa60499fe80f65
|
|
BLAKE2b-256 checksum How to use checksums |
ae9e0871cbc6d655b36d1866571a3e33a92ac54a9c2b918cf0f3bd97f3ea4951
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / syft_flwr-0.5.3-py3-none-any.whl
| Download URL | syft_flwr-0.5.3-py3-none-any.whl |
|---|---|
| Size | 50.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3d918306b17b4a27cedc8e8b12f4e9c25f27193ecaf24f210a79cfd3d4e073f7
|
|
BLAKE2b-256 checksum How to use checksums |
d7061bfb3ea50634bdaa472332cfd43213c33fbbdd3c832e83255304efd5b769
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
