Quick Start

Run your first federated learning experiment with OmniFed.

Installation

git clone https://github.com/AAIMS/OmniFed.git
cd OmniFed

pip install -r requirements.txt

Basic Execution

Run a FedAvg experiment with 2 clients using TorchDist communication:

./main.sh --config-name test_fedavg_centralized_torchdist

Configuration Examples

Communication backends:

# gRPC for cross-network deployment  
./main.sh --config-name test_fedavg_centralized_grpc

Scale parameters:

# More clients
./main.sh --config-name test_fedavg_centralized_torchdist topology.num_clients=10

# More rounds
./main.sh --config-name test_fedavg_centralized_torchdist global_rounds=20

Datasets:

# CIFAR-10
./main.sh --config-name test_fedavg_centralized_torchdist datamodule=cifar10

# Fashion-MNIST
./main.sh --config-name test_fedavg_centralized_torchdist datamodule=fashion_mnist