Rename task_execution to execution_api_type

YuanTingHsieh · Jan 23, 2024 · ef4a5c9 · ef4a5c9
1 parent c340e6d
commit ef4a5c9
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 10 deletions.
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/task_execution
+   programming_guide/execution_api_type
    programming_guide/shareable
    programming_guide/data_exchange_object
    programming_guide/fl_context

diff --git a/docs/programming_guide/task_execution.rst → .../programming_guide/execution_api_type.rst b/docs/programming_guide/task_execution.rst → .../programming_guide/execution_api_type.rst
@@ -1,8 +1,8 @@
-.. _task_execution:
+.. _execution_api_type:
 
-##############
-Task Execution
-##############
+##################
+Execution API Type
+##################
 
 In the FLARE system, a federated learning algorithm is defined in a Job format
 (for details, please refer to :ref:`job`).
@@ -83,7 +83,7 @@ For more details about each type, refer to each page below.
 .. toctree::
    :maxdepth: 1
 
-   task_execution/3rd_party_integration
-   task_execution/client_api
-   task_execution/model_learner
-   task_execution/executor
+   execution_api_type/3rd_party_integration
+   execution_api_type/client_api
+   execution_api_type/model_learner
+   execution_api_type/executor
diff --git a/.../task_execution/3rd_party_integration.rst → ...cution_api_type/3rd_party_integration.rst b/.../task_execution/3rd_party_integration.rst → ...cution_api_type/3rd_party_integration.rst
@@ -29,13 +29,18 @@ Requirements
   "agent_id" for each job, and start its trainer process with this information.
 - Each FL client must be able to open an address (host:port) to allow the trainer to connect to.
   Depending on where the trainer is running, the connection may or may not need to be in secure mode (TLS).
+- We will need to modify the "project.yml" for NVFlare provision system
+  and generate new package folders for each participating sites
 - The trainer must be a Python program that can integrate with the NVFLARE library.
 - The trainer must be able to connect to the server, as well as the address that
   is dynamically opened by the FL client.
 
 Prepare the Trainer
 ===================
 
+Let's prepare the trainer code first, we will modify the "project.yml" in the
+next section for project setup.
+
 You need to modify your trainer code to integrate with the :class:`FlareAgent<nvflare.client.flare_agent>` API.
 This API provides simple ``get_task()`` and ``submit_result()`` methods to interact with the FL client.
 
@@ -218,7 +223,8 @@ Notes:
 Project Setup
 =============
 
-The following steps show you how to properly set up your project and jobs.
+After we prepare the trainer code we can follow the steps below to properly
+set up the project and jobs.
 
 Step One - Provision
 --------------------

diff --git a/...mming_guide/task_execution/client_api.rst → ...g_guide/execution_api_type/client_api.rst b/...mming_guide/task_execution/client_api.rst → ...g_guide/execution_api_type/client_api.rst
diff --git a/...ramming_guide/task_execution/executor.rst → ...ing_guide/execution_api_type/executor.rst b/...ramming_guide/task_execution/executor.rst → ...ing_guide/execution_api_type/executor.rst
diff --git a/...ng_guide/task_execution/model_learner.rst → ...uide/execution_api_type/model_learner.rst b/...ng_guide/task_execution/model_learner.rst → ...uide/execution_api_type/model_learner.rst