Updated envoy api documentation

securefederatedai · Nov 30, 2023 · 4f0d261 · 4f0d261
1 parent 702da9c
commit 4f0d261
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/openfl/component/envoy/__init__.py b/openfl/component/envoy/__init__.py
@@ -2,3 +2,9 @@
 # SPDX-License-Identifier: Apache-2.0
 
 """Envoy package."""
+
+from .envoy import Envoy
+
+__all__ = [
+    'Envoy',
+]
diff --git a/openfl/component/envoy/envoy.py b/openfl/component/envoy/envoy.py
@@ -28,7 +28,22 @@
 
 
 class Envoy:
-    """Envoy class."""
+    """
+    Envoy class. The Envoy is a long-lived entity that runs on collaborator nodes connected to the Director.
+    
+    Args:
+        shard_name (str) :
+        director_host (str) :
+        shard_descriptor (Type[ShardDescriptor]) :
+        root_certificate (Optional[Union[Path, str]]) :
+        private_key (Optional[Union[Path, str]]) :
+        certificate (Optional[Union[Path, str]]) :
+        tls (bool) :
+        install_requirements (bool) :
+        cuda_devices (Union[tuple, list]) :
+        cuda_device_monitor (Optional[Type[CUDADeviceMonitor]]) :
+        review_plan_callback (Union[None, Callable]) :
+    """
 
     def __init__(
             self, *,