From 4f0d2614fa33c820bee04c95c71e338a416425dd Mon Sep 17 00:00:00 2001 From: manuelhsantana Date: Wed, 29 Nov 2023 19:08:30 -0800 Subject: [PATCH] Updated envoy api documentation --- openfl/component/envoy/__init__.py | 6 ++++++ openfl/component/envoy/envoy.py | 17 ++++++++++++++++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/openfl/component/envoy/__init__.py b/openfl/component/envoy/__init__.py index a028d52d39..14919bf92c 100644 --- 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', +] \ No newline at end of file diff --git a/openfl/component/envoy/envoy.py b/openfl/component/envoy/envoy.py index fc74d9113b..c5d4f5b104 100644 --- 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, *,