diff --git a/docs/fl_introduction.rst b/docs/fl_introduction.rst index 2cb3364e57..04cb9a9cd5 100644 --- a/docs/fl_introduction.rst +++ b/docs/fl_introduction.rst @@ -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 ============= diff --git a/docs/resources/3rd_party_integration_diagram.png b/docs/resources/3rd_party_integration_diagram.png index 7e02787425..5f99832968 100644 Binary files a/docs/resources/3rd_party_integration_diagram.png and b/docs/resources/3rd_party_integration_diagram.png differ diff --git a/docs/user_guide/nvflare_cli/job_cli.rst b/docs/user_guide/nvflare_cli/job_cli.rst index d8a29f2804..3fde8bb39e 100644 --- a/docs/user_guide/nvflare_cli/job_cli.rst +++ b/docs/user_guide/nvflare_cli/job_cli.rst @@ -216,8 +216,8 @@ FLARE Job Template Registry Below is a table of all available :github_nvflare_link:`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 diff --git a/job_templates/readme.md b/job_templates/readme.md index 0e240dd6b1..6963c6165f 100644 --- a/job_templates/readme.md +++ b/job_templates/readme.md @@ -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 |