From b32e277de883cca8eb34dffbcaf269fff5af5f99 Mon Sep 17 00:00:00 2001 From: Wonsuk Lee Date: Thu, 28 Dec 2023 11:31:13 +0900 Subject: [PATCH] Revised proposal for requirements part --- reports/index.html | 52 +++++++++++++++++++++++++++++----------------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/reports/index.html b/reports/index.html index 1f23e85..261235a 100644 --- a/reports/index.html +++ b/reports/index.html @@ -328,14 +328,15 @@

Table of Contents

  • 5. Requirements
      -
    1. 5.1 Device Registration
      2. -
    2. 5.2 Data Upload
      3. -
    3. 5.3 Model Synchronization
      4. -
    4. 5.4 Model Evaluation
      5. -
    5. 5.5 Result Retrieval
      6. -
    6. 5.6 Training Control
      7. -
    7. 5.7 Security and Privacy
      8. -
    8. 5.8 Extensibility and Compatibility
      9. +
    9. 5.1 General Requirements
      10. +
    10. 5.2 Device Registration
      11. +
    11. 5.3 Data Upload
      12. +
    12. 5.4 Model Synchronization
      13. +
    13. 5.5 Model Evaluation
      14. +
    14. 5.6 Result Retrieval
      15. +
    15. 5.7 Training Control
      16. +
    16. 5.8 Security and Privacy
      17. +
    17. 5.9 Extensibility and Compatibility
    • @@ -440,11 +441,24 @@

    Table of Contents

    5. Requirements

    -

    The functional requirements for Federated Learning API outline the essential capabilities and specifications necessary to enable seamless communication, - secure data transmission, and effective coordination of federated learning systems. These requirements encompass device registration, data upload, model synchronization, - evaluation, result retrieval, training control, and ensuring security and privacy measures.

    +

    The functional requirements for Federated Learning API are produced in a high-level, functionally outline the essential + capabilities and specifications necessary to enable seamless communication, secure data transmission, and effective + coordination of federated learning systems. These requirements encompass device registration, data upload, + model synchronization, evaluation, result retrieval, training control, and ensuring security and privacy measures.

    -

    5.1 Device Registration

    +

    5.1 General Requirements

    + +

    The following requirements have been expressed.

    +
      +
    • APIs should be accessible through a unified and structured namespace to ensure ease of understanding.
      • +
    • APIs should provide operation for cancellation and error handling to improve resilience and controllability.
      • +
    • APIs should be designed for supporting compatibility across various platforms and devices.
      • +
    • The API architecture should be extensible, allowing for upgrade and management without breaking existing functionality.
      • +
    + +
    + +

    5.2 Device Registration

    The API should allow devices or clients to securely register themselves with the federated learning system. The API should allow devices or clients to securely register themselves with the federated learning system. @@ -452,7 +466,7 @@

    Table of Contents

    -

    5.2 Data Upload

    +

    5.3 Data Upload

    The API should enable clients to securely upload their locally held data to the central server or coordinator for model training. It should support various data formats and provide guidelines for data serialization and transmission. @@ -460,7 +474,7 @@

    Table of Contents

    -

    5.3 Model Synchronization

    +

    5.4 Model Synchronization

    The API should handle the communication and synchronization of model parameters between the central server and client devices. It should provide endpoints for retrieving the current model state, sending model updates from clients to the server, and distributing updated models back to the clients. @@ -468,7 +482,7 @@

    Table of Contents

    -

    5.4 Model Evaluation

    +

    5.5 Model Evaluation

    The API should include endpoints for clients to request model evaluation on their local data. It should support the transmission of evaluation requests and relevant data securely to the server. @@ -476,7 +490,7 @@

    Table of Contents

    -

    5.5 Result Retrieval

    +

    5.6 Result Retrieval

    The API should enable clients to retrieve the final trained model or other relevant results from the central server. It should provide endpoints for requesting and downloading the trained model or aggregated results. @@ -484,7 +498,7 @@

    Table of Contents

    -

    5.6 Training Control

    +

    5.7 Training Control

    The API should allow for controlling the federated learning process, such as starting, pausing, or terminating model training. It should provide endpoints for managing training sessions, setting training parameters, and monitoring the progress of training. @@ -492,7 +506,7 @@

    Table of Contents

    -

    5.7 Security and Privacy

    +

    5.8 Security and Privacy

    The API should incorporate security measures, such as authentication, encryption, and access control, to protect the federated learning system. It should ensure the privacy and confidentiality of data during transmission and storage. @@ -500,7 +514,7 @@

    Table of Contents

    -

    5.8 Extensibility and Compatibility

    +

    5.9 Extensibility and Compatibility

    The API should be designed with extensibility in mind, allowing for the addition of new functionalities or endpoints in the future. It should be compatible with existing web standards and frameworks, facilitating integration with different software platforms and tools.