update README.md

NVIDIA · Jan 2, 2024 · e390f88 · e390f88
1 parent 3a5e4f4
commit e390f88
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/examples/hello-world/hello-cyclic-pt/README.md b/examples/hello-world/hello-cyclic-pt/README.md
@@ -29,7 +29,11 @@ class WFCommAPISpec(ABC):
         pass
 
     @abstractmethod
-    def wait(self, min_responses):
+    def wait_all(self, min_responses: int, resp_max_wait_time: Optional[float]) -> Dict[str, Dict[str, FLModel]]:
+        pass
+
+    @abstractmethod
+    def wait_one(self, resp_max_wait_time: Optional[float] = None) -> Tuple[str, str, FLModel]:
         pass
 ```
 

diff --git a/examples/hello-world/hello-fedavg/README.md b/examples/hello-world/hello-fedavg/README.md
@@ -7,30 +7,44 @@ This example illustrates  How to use the new Workflow Communication API to contr
 The Flare workflow Communicator API only has small set methods
 
 ```
+
 class WFCommAPISpec(ABC):
     @abstractmethod
     def broadcast_and_wait(self, msg_payload: Dict):
         pass
 
     @abstractmethod
-    def broadcast(self, msg_payload):
+    def send_and_wait(self, msg_payload: Dict):
+        pass
+
+    @abstractmethod
+    def relay_and_wait(self, msg_payload: Dict):
+        pass
+
+    @abstractmethod
+    def broadcast(self, msg_payload: Dict):
         pass
 
     @abstractmethod
     def send(self, msg_payload: Dict):
         pass
 
     @abstractmethod
-    def send_and_wait(self, msg_payload: Dict):
+    def relay(self, msg_payload: Dict):
+        pass
+
+    @abstractmethod
+    def get_site_names(self) -> List[str]:
         pass
 
     @abstractmethod
-    def get_site_names(self):
+    def wait_all(self, min_responses: int, resp_max_wait_time: Optional[float]) -> Dict[str, Dict[str, FLModel]]:
         pass
 
     @abstractmethod
-    def wait(self, min_responses):
+    def wait_one(self, resp_max_wait_time: Optional[float] = None) -> Tuple[str, str, FLModel]:
         pass
+
 ```
 
 

diff --git a/examples/hello-world/hello-km/README.md b/examples/hello-world/hello-km/README.md
@@ -31,7 +31,11 @@ class WFCommAPISpec(ABC):
         pass
 
     @abstractmethod
-    def wait(self, min_responses):
+    def wait_all(self, min_responses: int, resp_max_wait_time: Optional[float]) -> Dict[str, Dict[str, FLModel]]:
+        pass
+
+    @abstractmethod
+    def wait_one(self, resp_max_wait_time: Optional[float] = None) -> Tuple[str, str, FLModel]:
         pass
 ```