eigengravy / tinyfl

a tiny federated learning framework

Hi there 👋

GitHub Metrics

tinyfl's Issues

CI/CD for documentation site

Setup Sphinx or similar tool to automatically generate documentation.

MultiKRUM scoring

Implement helper function for MultiKRUM scoring algorithm.
Refer: scorer.py

CI/CD for Docker Images

Setup CI/CD to build and publish tinyfl docker image.
ref: github docs

More aggregator config options

Move hard coded aggregator parameters to its config file

• timeout : wait time for consensus
• consensus : number of participants to reach consensus
• epochs: number of training epochs in each round
• aggregation algorithm : currently only fedavg is implemented. more coming soontm

Model parameter in config file

Add ability to run different models easily by defining them in the config file. Consider multiple approaches from having hard coded models, to dynamically loading model from python file or some other format.

Split Dataset

Perform a stratified split of the dataset for parties.
Extend Alvtron/pytorch_stratified_split.md to multiple splits

Implement more federated aggregation algorithms

• #18
• SCAFFOLD

Deregister

De-register party from aggregator and graceful shutdown.

• Implement De-register message dataclass.
• Send de-register request to aggregator when a party is shutting down.
• Handle de-register message on the aggregator to remove party from client set.

Containerize

Docker files for aggregator and clients.

FedProx

Paper: Federated Optimization in Heterogeneous Networks
Repo: litian96/FedProx

Unable to shutdown aggregator running on poetry

Steps to replicate:

poetry run agg configs/agg.config.json
poetry run party configs/party0.config.json

curl localhost:5000/start_round

Attempt to kill agg with ctrl c

Forcing to stop

Dashboard

Dashboard for aggregator

• View current state (parties, iteration / round)
• Grafana plots for sys info (mem, cpu, network, io)

Documentation

Add documentation in python docstrings format and type annotation.