# anurag2796/fedlearn-platform architecture

> Architecture diagram of the GitHub repository anurag2796/fedlearn-platform, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/anurag2796/fedlearn-platform
- Repository: https://github.com/anurag2796/fedlearn-platform
- Video tour (about a minute): https://gitdiagram.com/anurag2796/fedlearn-platform/video

## Overview

FedLearn is a federated-learning product spanning a web dashboard, Spring API, Python FL framework/runtime, deployable clients, desktop tooling, and a native mobile client. The primary workflow is project/model setup, backend-managed server launch, client training over gRPC, progress streaming to the dashboard, and persisted results. The README documents additional recipes, strategies, simulation, benchmarking, marketplace and inference capabilities. Some runtime paths are documented but not sampled, so those links are dashed and unverified.

Main entry points: [`frontend/src/App.tsx`](https://github.com/anurag2796/fedlearn-platform/blob/main/frontend/src/App.tsx) (Web Dashboard), [`backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/InferenceController.java`](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/InferenceController.java) (REST API), [`framework/src/fedlearn/server/server.py`](https://github.com/anurag2796/fedlearn-platform/blob/main/framework/src/fedlearn/server/server.py) (FL Coordinator), [`fl-runtime/client.py`](https://github.com/anurag2796/fedlearn-platform/blob/main/fl-runtime/client.py) (FL Runtime)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_product["Web Product"]
  node_dashboard["Web Dashboard<br/>[App.tsx]"]
  node_project["Project Setup"]
  node_benchmark["Benchmarking"]
  node_registry["Model Marketplace"]
end

subgraph group_backend["Platform Backend"]
  node_api["REST API"]
  node_authorization["Access Control"]
  node_orchestrator["Server Lifecycle"]
  node_state[("Platform State<br/>[Project.java]")]
  node_telemetry["Live Updates"]
  node_inference["Model Inference"]
end

subgraph group_learning["Federated Learning"]
  node_runtime["FL Runtime<br/>[client.py]"]
  node_recipes["Recipe Catalog<br/>[recipes.py]"]
  node_framework_server["FL Coordinator<br/>[server.py]"]
  node_grpc["gRPC Service<br/>[grpc_servicer.py]"]
end

subgraph group_clients["Client Apps"]
  node_client["Training Client<br/>[grpc_client.py]"]
  node_desktop["Desktop App<br/>[App.tsx]"]
  node_mobile["Mobile Client<br/>[App.tsx]"]
end

node_browser(("Dashboard User"))
node_database[("PostgreSQL")]

node_browser -->|"uses"| node_dashboard
node_dashboard -.->|"calls"| node_api
node_dashboard -.->|"configures"| node_project
node_project -.->|"starts server"| node_orchestrator
node_orchestrator -.->|"spawns scripts"| node_runtime
node_runtime -.->|"runs framework"| node_framework_server
node_framework_server -->|"registers service"| node_grpc
node_client -.->|"connects"| node_grpc
node_mobile -.->|"uses REST"| node_api
node_desktop -->|"calls inference"| node_api
node_api -->|"dispatches"| node_inference
node_inference -->|"runs scripts"| node_runtime
node_inference -->|"streams tokens"| node_telemetry
node_api -.->|"enforces access"| node_authorization
node_project -.->|"persists projects"| node_state
node_state -.->|"stored in"| node_database
node_framework_server -.->|"streams logs"| node_telemetry
node_recipes -->|"provides data"| node_runtime
node_dashboard -.->|"views metrics"| node_benchmark
node_dashboard -.->|"browses models"| node_registry
node_framework_server -.->|"stores results"| node_state

click node_dashboard "https://github.com/anurag2796/fedlearn-platform/blob/main/frontend/src/App.tsx"
click node_project "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/ProjectService.java"
click node_api "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/InferenceController.java"
click node_authorization "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/AuthorizationService.java"
click node_orchestrator "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/orchestration/FlServerManager.java"
click node_state "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/model/Project.java"
click node_telemetry "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/WebSocketService.java"
click node_inference "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/InferenceService.java"
click node_runtime "https://github.com/anurag2796/fedlearn-platform/blob/main/fl-runtime/client.py"
click node_recipes "https://github.com/anurag2796/fedlearn-platform/blob/main/fl-runtime/recipes.py"
click node_framework_server "https://github.com/anurag2796/fedlearn-platform/blob/main/framework/src/fedlearn/server/server.py"
click node_grpc "https://github.com/anurag2796/fedlearn-platform/blob/main/framework/src/fedlearn/server/grpc_servicer.py"
click node_client "https://github.com/anurag2796/fedlearn-platform/blob/main/framework/src/fedlearn/client/grpc_client.py"
click node_desktop "https://github.com/anurag2796/fedlearn-platform/blob/main/fedlearn-desktop/src/renderer/App.tsx"
click node_mobile "https://github.com/anurag2796/fedlearn-platform/blob/main/mobile_client/src/App.tsx"
click node_benchmark "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/BenchmarkIngestController.java"
click node_registry "https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/MarketplaceController.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dashboard,node_project,node_benchmark,node_registry,node_browser toneBlue
class node_api,node_authorization,node_orchestrator,node_state,node_telemetry,node_inference,node_database toneAmber
class node_runtime,node_recipes,node_framework_server,node_grpc toneMint
class node_client,node_desktop,node_mobile toneRose
```

## Components

### Web Product

- [Web Dashboard](https://github.com/anurag2796/fedlearn-platform/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Project Setup](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/ProjectService.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/ProjectService.java`
- [Benchmarking](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/BenchmarkIngestController.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/BenchmarkIngestController.java`
- [Model Marketplace](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/MarketplaceController.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/MarketplaceController.java`

### Platform Backend

- [REST API](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/InferenceController.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/InferenceController.java`
- [Access Control](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/AuthorizationService.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/AuthorizationService.java`
- [Server Lifecycle](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/orchestration/FlServerManager.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/orchestration/FlServerManager.java`
- [Platform State](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/model/Project.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/model/Project.java`
- [Live Updates](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/WebSocketService.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/WebSocketService.java`
- [Model Inference](https://github.com/anurag2796/fedlearn-platform/blob/main/backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/InferenceService.java): `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/InferenceService.java`

### Federated Learning

- [FL Runtime](https://github.com/anurag2796/fedlearn-platform/blob/main/fl-runtime/client.py): `fl-runtime/client.py`
- [Recipe Catalog](https://github.com/anurag2796/fedlearn-platform/blob/main/fl-runtime/recipes.py): `fl-runtime/recipes.py`
- [FL Coordinator](https://github.com/anurag2796/fedlearn-platform/blob/main/framework/src/fedlearn/server/server.py): `framework/src/fedlearn/server/server.py`
- [gRPC Service](https://github.com/anurag2796/fedlearn-platform/blob/main/framework/src/fedlearn/server/grpc_servicer.py): `framework/src/fedlearn/server/grpc_servicer.py`

### Client Apps

- [Training Client](https://github.com/anurag2796/fedlearn-platform/blob/main/framework/src/fedlearn/client/grpc_client.py): `framework/src/fedlearn/client/grpc_client.py`
- [Desktop App](https://github.com/anurag2796/fedlearn-platform/blob/main/fedlearn-desktop/src/renderer/App.tsx): `fedlearn-desktop/src/renderer/App.tsx`
- [Mobile Client](https://github.com/anurag2796/fedlearn-platform/blob/main/mobile_client/src/App.tsx): `mobile_client/src/App.tsx`

### Other components

- **Dashboard User**
- **PostgreSQL**

## Connections

- Dashboard User → Web Dashboard: uses
- Web Dashboard → REST API: calls
- Web Dashboard → Project Setup: configures
- Project Setup → Server Lifecycle: starts server (evidence: `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/ProjectService.java`)
- Server Lifecycle → FL Runtime: spawns scripts
- FL Runtime → FL Coordinator: runs framework
- FL Coordinator → gRPC Service: registers service (evidence: `framework/src/fedlearn/server/server.py`)
- Training Client → gRPC Service: connects
- Mobile Client → REST API: uses REST
- Desktop App → REST API: calls inference
- REST API → Model Inference: dispatches (evidence: `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/controller/InferenceController.java`)
- Model Inference → FL Runtime: runs scripts (evidence: `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/InferenceService.java`)
- Model Inference → Live Updates: streams tokens (evidence: `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/InferenceService.java`)
- REST API → Access Control: enforces access
- Project Setup → Platform State: persists projects (evidence: `backend/fl-platform-api/src/main/java/com/federated/fl_platform_api/service/ProjectService.java`)
- Platform State → PostgreSQL: stored in
- FL Coordinator → Live Updates: streams logs
- Recipe Catalog → FL Runtime: provides data (evidence: `fl-runtime/client.py`)
- Web Dashboard → Benchmarking: views metrics
- Web Dashboard → Model Marketplace: browses models
- FL Coordinator → Platform State: stores results
