Address VDR issues regarding Client API and 3rd party integration doc…

…s and docstrings
YuanTingHsieh · Jan 22, 2024 · 7482146 · 7482146
1 parent 356b9cc
commit 7482146
Show file tree

Hide file tree

Showing 24 changed files with 995 additions and 659 deletions.
diff --git a/docs/concepts.rst b/docs/concepts.rst
@@ -0,0 +1,12 @@
+########
+Concepts
+########
+
+The Concepts section helps you learn about the parts of the NVFlare system and
+the abstractions NVFlare uses, and helps you obtain a deeper understanding of how NVFlare works.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   concepts/fl_model
diff --git a/docs/concepts/fl_model.rst b/docs/concepts/fl_model.rst
@@ -0,0 +1,17 @@
+.. _fl_model:
+
+FLModel
+=======
+
+We define a standard data structure :mod:`FLModel<nvflare.app_common.abstract.FLModel>`
+that captures the common attributes needed for exchanging learning results.
+
+This is particularly useful when NVFlare system needs to exchange learning
+information with external training scripts/systems.
+
+The external training script/system only need to extract the required
+information from received FLModel, run local training, and put the results
+in a new FLModel to be sent back.
+
+For a detailed explanation of each attributes, please refer to the API doc:
+:mod:`FLModel<nvflare.app_common.abstract.FLModel>`
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -22,14 +22,14 @@ Clone NVFLARE repo to get examples, switch main branch (latest stable branch)
 
   $ git clone https://github.com/NVIDIA/NVFlare.git
   $ cd NVFlare
-  $ git switch main
+  $ git switch 2.4
 
 
 Note on branches:
 
 * The `main <https://github.com/NVIDIA/NVFlare/tree/main>`_ branch is the default (unstable) development branch
 
-* The 2.0, 2.1, 2.2, and 2.3 etc. branches are the branches for each major release and minor patches
+* The 2.1, 2.2, 2.3, and 2.4 etc. branches are the branches for each major release and minor patches
 
 
 Quick Start with Simulator

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,6 +12,7 @@ NVIDIA FLARE
    example_applications_algorithms
    real_world_fl
    user_guide
+   concepts
    programming_guide
    best_practices
    faq
@@ -21,7 +22,7 @@ NVIDIA FLARE
    glossary
 
 NVIDIA FLARE (NVIDIA Federated Learning Application Runtime Environment) is a domain-agnostic, open-source, extensible SDK that allows
-researchers and data scientists to adaptexisting ML/DL workflows (PyTorch, RAPIDS, Nemo, TensorFlow) to a federated paradigm; and enables
+researchers and data scientists to adapt existing ML/DL workflows (PyTorch, RAPIDS, Nemo, TensorFlow) to a federated paradigm; and enables
 platform developers to build a secure, privacy preserving offering for a distributed multi-party collaboration.
 
 NVIDIA FLARE is built on a componentized architecture that gives you the flexibility to take federated learning workloads from research
@@ -34,7 +35,7 @@ and simulation to real-world production deployment.  Some of the key components
  - **Management tools** for secure provisioning and deployment, orchestration, and management
  - **Specification-based API** for extensibility
 
-Learn more in the :ref:`FLARE Overview <flare_overview>`, :ref:`Key Features <key_features>`, :ref:`What's New <whats_new>`, and the
+Learn more in the :ref:`FLARE Overview <flare_overview>`, :ref:`What's New <whats_new>`, and the
 :ref:`User Guide <user_guide>` and :ref:`Programming Guide <programming_guide>`.
 
 Getting Started

diff --git a/docs/programming_guide.rst b/docs/programming_guide.rst
@@ -36,7 +36,7 @@ Please refer to :ref:`application` for more details.
    :maxdepth: 1
 
    programming_guide/workflows_and_controllers
-   programming_guide/fl_clients
+   programming_guide/task_execution
    programming_guide/shareable
    programming_guide/data_exchange_object
    programming_guide/fl_context

diff --git a/docs/programming_guide/fl_clients.rst b/docs/programming_guide/fl_clients.rst