FedPilot Wiki
Welcome to the FedPilot comprehensive documentation. FedPilot is a Federated Learning framework designed for scalable, distributed machine learning with advanced features like clustering, differential privacy, and model pruning.
Documentation Structure
Start here if you’re new to FedPilot:
| Document | Purpose | Time | Audience |
|---|---|---|---|
| overview | Introduction to FedPilot | 10 min | Beginner |
| Framework Overview | FedPilot framework overview | 15 min | Beginner |
| Installation | Setup & environment configuration | 20 min | All |
| Getting Started | Quick start guide & first training | 15 min | All |
| CLI Reference | Command-line interface guide | 10 min | Beginners |
Recommended Path for New Users:
- Read: Framework Overview (understand what it is)
- Start: Installation (set up environment)
- Follow: Getting Started (run first model)
- Reference: CLI Reference (understand commands)
Configuration & Reference
Complete configuration guides:
| Document | Purpose | Use Case |
|---|---|---|
| Configuration Guide | YAML config reference & examples | Learning YAML format |
| CLI Reference | Command-line interface guide | Learning how to create configurations |
Supported Features
| Feature area | Supported items |
|---|---|
| Architectures | Centralized FL (Star Topology), Decentralized FL (Ring, K-connected), Custom Topologies |
| Models | CNN, LeNet, ResNet (18, 50), VGG16, MobileNet, Vision Transformer (ViT), Swin, BERT, ALBERT, Custom models |
| Datasets — Image | MNIST, Fashion-MNIST, FEMNIST, CIFAR-10/100, SVHN, STL-10, Tiny ImageNet |
| Datasets — Text | Shakespeare, BBC News, Yahoo QA |
| Optimization | FedAvg, FedProx, Model pruning & compression, Parameter quantization, Gradient clipping, Enhanced chunking |
| Security & Privacy | Differential Privacy (DP), Gradient clipping, Secure aggregation, Client sampling |
| Monitoring | OpenTelemetry tracing, Prometheus metrics, Grafana dashboards, Jaeger distributed tracing |
Features & Guides
Learn about specific features:
| Guide | Topic | Best For |
|---|---|---|
| Models & Datasets | Available models and data sources | Choosing model/dataset |
| Aggregation Strategies | FedAvg, FedProx, variants | Understanding aggregation |
Examples & Tutorials
By Use Case:
- First training -> Example 1 in Basic Training
- Non-IID data -> Example 2 in Basic Training
- Privacy-preserving -> Example 3 in Basic Training
- Compression -> Example 4 in Basic Training
Quick Reference Tables
Documentation by Topic
| Topic | Primary Doc | Secondary Docs |
|---|---|---|
| Installation | Installation | - |
| First Run | Getting Started | CLI Reference |
| Configuration | Configuration Guide | - |
| Models | Models & Datasets | Basic Examples |
| Aggregation | Aggregation Strategies | - |
| Examples | Basic Training | - |
Cross-References
Common Questions & Answers
| Question | Answer |
|---|---|
| “How do I install FedPilot?” | Installation |
| “How do I run my first training?” | Getting Started |
| “How do I use make commands?” | CLI Reference |
| “How do I configure my experiment?” | Configuration Guide |
| “Which model should I use?” | Models & Datasets |
| “How does it work internally?” | Framework Overview |
Getting Help
Troubleshooting
- Installation Issues -> Installation Troubleshooting
- Training Issues -> Getting Started Troubleshooting
- Configuration Issues -> Configuration Guide
Version Info
- FedPilot Version: v2.0.0
- Documentation Version: 1.0
- Last Updated: 2024
- Status: Active & Maintained
Ready to install FedPilot? Check out Requirements & Installation!