Skip to content

Commit

Permalink
rewording, update diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
SYangster committed Jan 23, 2024
1 parent 7f31a26 commit 997c11c
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 4 deletions.
8 changes: 7 additions & 1 deletion docs/fl_introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,17 @@ FL Terms and Definitions
- FL server: manages job lifecycle, orchestrates workflow, assigns tasks to clients, performs aggregation
- FL client: executes tasks, performs local computation/learning with local dataset, submits result back to FL server
- FL algorithms: FedAvg, FedOpt, FedProx etc. implemented as workflows

.. note::

Here we describe the centralized version of FL, where the FL server has the role of the aggregrator node. However in a decentralized version such as
swarm learning, FL clients can serve as the aggregator node instead.

- Types of FL

- horizontal FL: clients hold different data samples over the same features
- vertical FL: clients hold different features over an overlapping set of data samples
- swarm learning: a decentralized subset of FL where orchestration and aggregation is performed by the clients in cases where the server is not trusted
- swarm learning: a decentralized subset of FL where orchestration and aggregation is performed by the clients

Main Benefits
=============
Expand Down
Binary file modified docs/resources/3rd_party_integration_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/user_guide/nvflare_cli/job_cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ FLARE Job Template Registry
Below is a table of all available :github_nvflare_link:`Job Templates <job_templates>`.

.. csv-table::
:header: Example,Client Category,Controller-Type,Description
:widths: 18, 10, 10, 30
:header: Example,Execution API Type,Controller Type,Description
:widths: 18, 18, 10, 30

cyclic_cc_pt,client,client_api,client-controlled cyclic workflow with PyTorch ClientAPI trainer
cyclic_pt,server,client_api,server-controlled cyclic workflow with PyTorch ClientAPI trainer
Expand Down
2 changes: 1 addition & 1 deletion job_templates/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ View all the available job templates with the following command:

```nvflare job list_templates```

| Example | Controller-Type | Client Category | Description |
| Example | Controller-Type | Execution API Type | Description |
|---------|-----------------|-----------------|-------------|
| [cyclic_cc_pt](./cyclic_cc_pt) | client | client_api | client-controlled cyclic workflow with PyTorch ClientAPI trainer |
| [cyclic_pt](./cyclic_pt) | server | client_api | server-controlled cyclic workflow with PyTorch ClientAPI trainer |
Expand Down

0 comments on commit 997c11c

Please sign in to comment.