Welcome to fl-sim’s documentation!

A Simple Simulation Framework for Federated Learning Based on PyTorch.

Project Links: GitHub | gitee

Getting started

• Installation instructions
• Usage examples

API Reference

• fl_sim.nodes
• fl_sim.messages
• fl_sim.data_processing
• fl_sim.models
• fl_sim.optimizers
• fl_sim.regularizers
• fl_sim.utils
• Algorithm Configuration Reference

Advanced Topics

• Federated learning algorithms
• Command line interface
• Visualization subsystem

Indices and tables

• Index

• Module Index

• Search Page