Skip to content

Commit 4be18a7

Browse files
committed
refactor
1 parent 51b78bc commit 4be18a7

3 files changed

Lines changed: 90 additions & 16 deletions

File tree

docs/index.rst

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,35 @@ Scaleout Edge is a framework for scalable federated learning. This documentation
55

66
.. toctree::
77
:maxdepth: 1
8-
:caption: Getting Started
8+
:caption: Core Concepts
99

10+
overview
1011
introduction
11-
My First Scaleout Edge Project <quickstart>
12+
Architecture Overview <architecture>
1213

1314
.. toctree::
1415
:maxdepth: 1
15-
:caption: Tutorials and Examples
16-
16+
:caption: Getting Started
1717

18+
My First Scaleout Edge Project <quickstart>
1819

1920
.. toctree::
2021
:maxdepth: 1
21-
:caption: Usage Guides
22+
:caption: Developers Guides
2223

2324
A Guide to the Scaleout Edge Project Structure <projects>
24-
Architecture Overview <architecture>
25-
aggregators
26-
serverfunctions
2725
cli
28-
helpers
2926
apiclient
3027
localcompute
3128

29+
.. toctree::
30+
:maxdepth: 1
31+
:caption: Advanced Configuration
32+
33+
aggregators
34+
serverfunctions
35+
helpers
36+
3237
.. toctree::
3338
:maxdepth: 1
3439
:caption: Support & Troubleshooting
@@ -53,4 +58,4 @@ Indices and tables
5358
:og:type: website
5459
:twitter:card: summary_large_image
5560
:twitter:title: Scaleout Edge Documentation - Scalable Federated Learning
56-
:twitter:description: Framework for scalable federated learning with comprehensive docs and examples.
61+
:twitter:description: Framework for scalable federated learning with comprehensive docs and examples.

docs/overview.rst

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.. _scaleout_edge_overview:
2+
3+
Scaleout Edge Overview
4+
======================
5+
6+
Scaleout Edge is a platform for **distributed MLOps and DataOps**. It enables organizations to train, deploy, and govern machine learning models across decentralized infrastructure—from on-premise data centers to edge devices—without ever moving the raw training data.
7+
8+
Traditional machine learning pipelines are centralized: data is collected, moved to a central lake, and processed on a cluster. Scaleout Edge **inverts this workflow**. It allows you to **bring the model to the data**.
9+
10+
By managing a "Global Model" that travels to your devices, learns from local data, and sends back only mathematical updates, Scaleout Edge solves the fundamental challenges of data gravity, privacy, and network constraints.
11+
12+
13+
The Scaleout Platform
14+
---------------------
15+
16+
Scaleout Edge provides the orchestration, security, and aggregation layers needed to run distributed AI at scale. It is designed to manage the full lifecycle of a decentralized project through three core functions:
17+
18+
* **Orchestrate:** Coordinate thousands of devices to participate in training rounds automatically.
19+
* **Aggregate:** Securely combine model updates into a global model using hierarchical aggregation.
20+
* **Govern:** Track lineage, versioning, and security across the entire network.
21+
22+
23+
What Can I Use Scaleout Edge For?
24+
---------------------------------
25+
26+
Scaleout Edge addresses critical modern ML deployment challenges:
27+
28+
* **Data Sovereignty and Privacy**
29+
Train models on sensitive data (healthcare records, financial transactions, proprietary IP) that strictly cannot leave the device or premise due to **GDPR**, **HIPAA**, or internal compliance. The raw data never crosses the network; only the model weights do.
30+
31+
* **Bandwidth-Efficient Operations**
32+
In edge environments (factories, satellites, mobile fleets), uploading terabytes of raw video or sensor data is cost-prohibitive or technically impossible. Scaleout Edge processes data locally and transmits only small model updates, **reducing network load by orders of magnitude**.
33+
34+
* **Resilient, Continuous Learning**
35+
Models degrade over time. Instead of manually collecting new datasets to retrain, Scaleout Edge enables a **continuous loop** where devices constantly refine the model based on fresh, real-world data they encounter.
36+
37+
38+
Scaleout Architecture
39+
---------------------
40+
41+
Scaleout Edge uses a unique **three-tier architecture** designed for scalability and resilience in unstable network conditions. Unlike simple client-server setups, Scaleout introduces an aggregation layer to handle the complexity of the edge.
42+
43+
The architecture consists of:
44+
45+
* **The Controller (The Brain)**
46+
The Controller is the central management service. It manages the **Global Model**, coordinates training rounds, and handles authentication. It acts as the **control plane** for the entire network. You interact with the Controller via the Web UI, CLI, or API.
47+
48+
* **The Combiner (The Aggregator)**
49+
The Combiner is the **scalability engine** of the platform. It sits between the Controller and the Clients. Combiners can be deployed in the cloud or on edge gateways (near-edge). Their job is to receive model updates from devices, **aggregate them**, and send a single update up the stack. This hierarchical approach allows the system to scale to thousands of clients without bottling-necking the central server.
50+
51+
* **The Client (The Worker)**
52+
The Client acts as the interface between the Scaleout platform and your local data. It runs on the edge device (IoT device, server, laptop). The Client executes the training code locally, manages on-device data access, and communicates with the Combiner.
53+
54+
55+
Key Concepts
56+
------------
57+
58+
* **The Project:** A Project is the workspace for a specific machine learning objective. It defines the network of clients, the machine learning framework being used, and the configuration for how training should proceed.
59+
60+
* **The Compute Package:** To train a model, you upload a Compute Package. This is a code bundle (typically Python) that contains your model definition and training logic. Scaleout Edge distributes this package to selected clients automatically at the start of a session.
61+
62+
* **The Round:** Training happens in rounds. In a single round:
63+
1. The Controller instructs clients to train.
64+
2. Clients download the latest Global Model and the Compute Package.
65+
3. Clients train on their local data and upload a model update.
66+
4. Combiners aggregate these updates.
67+
5. A new Global Model is committed.
68+
69+
* **The Global Model:** The Global Model is the shared intelligence of the network. It is the result of aggregating updates from all participating clients. It serves as the "**master**" version that is versioned, tracked, and eventually deployed for inference.

docs/projects.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -431,12 +431,12 @@ Where to go from here?
431431
With an understanding of how Scaleout Edge Projects are structured and created, you can explore our library of example projects. They demonstrate different use case scenarios of Scaleout Edge
432432
and its integration with popular machine learning frameworks like PyTorch and TensorFlow.
433433

434-
- `Scaleout Edge + PyTorch <https://github.com/scaleoutsystems/scaleout-client/tree/master/python/examples/mnist-pytorch>`__
435-
- `Scaleout Edge + Tensforflow/Keras <https://github.com/scaleoutsystems/scaleout-client/tree/master/python/examples/mnist-keras>`__
436-
- `Scaleout Edge + MONAI <https://github.com/scaleoutsystems/scaleout-client/tree/master/python/examples/monai-2D-mednist>`__
437-
- `Scaleout Edge + Hugging Face <https://github.com/scaleoutsystems/scaleout-client/tree/master/python/examples/huggingface>`__
438-
- `Scaleout Edge + Flower <https://github.com/scaleoutsystems/scaleout-client/tree/master/python/examples/flower-client>`__
439-
- `Scaleout Edge + Self-supervised learning <https://github.com/scaleoutsystems/scaleout-client/tree/master/examples/FedSimSiam>`__
434+
- `Scaleout Edge + PyTorch <https://github.com/scaleoutsystems/scaleout-client//python/examples/mnist-pytorch>`__
435+
- `Scaleout Edge + Tensforflow/Keras <https://github.com/scaleoutsystems/scaleout-client/python/examples/mnist-keras>`__
436+
- `Scaleout Edge + MONAI <https://github.com/scaleoutsystems/scaleout-client/python/examples/monai-2D-mednist>`__
437+
- `Scaleout Edge + Hugging Face <https://github.com/scaleoutsystems/scaleout-client/python/examples/huggingface>`__
438+
- `Scaleout Edge + Flower <https://github.com/scaleoutsystems/scaleout-client/python/examples/flower-client>`__
439+
- `Scaleout Edge + Self-supervised learning <https://github.com/scaleoutsystems/scaleout-client/python/examples/FedSimSiam>`__
440440

441441

442442
.. meta::

0 commit comments

Comments
 (0)