Change timeout default value and update docstring

YuanTingHsieh · Jul 20, 2023 · 9c289bf · 9c289bf
1 parent 187784a
commit 9c289bf
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/nvflare/app_common/executors/file_pipe_launcher_executor.py b/nvflare/app_common/executors/file_pipe_launcher_executor.py
@@ -35,7 +35,7 @@ def __init__(
         launcher_id: Optional[str] = None,
         launch_timeout: Optional[float] = None,
         task_wait_time: Optional[float] = None,
-        task_read_wait_time: Optional[float] = 30.0,
+        task_read_wait_time: Optional[float] = None,
         result_poll_interval: float = 0.1,
         read_interval: float = 0.1,
         heartbeat_interval: float = 5.0,
@@ -52,9 +52,9 @@ def __init__(
             pipe_id (Optional[str]): Identifier used to get the Pipe from NVFlare components.
             pipe_name (str): Name of the pipe. Defaults to "pipe".
             launcher_id (Optional[str]): Identifier used to get the Launcher from NVFlare components.
-            launch_timeout (Optional[float]): Timeout for the "launch" method to end. None means forever.
-            task_wait_time (Optional[float]): Time to wait for tasks to complete before exiting the executor.
-            task_read_wait_time (Optional[float]): Time to wait for task results from the pipe. Defaults to 30.0.
+            launch_timeout (Optional[float]): Timeout for the "launch" method to end. None means never timeout.
+            task_wait_time (Optional[float]): Time to wait for tasks to complete before exiting the executor. None means never timeout.
+            task_read_wait_time (Optional[float]): Time to wait for task results from the pipe. None means no wait.
             result_poll_interval (float): Interval for polling task results from the pipe. Defaults to 0.1.
             read_interval (float): Interval for reading from the pipe. Defaults to 0.1.
             heartbeat_interval (float): Interval for sending heartbeat to the peer. Defaults to 5.0.

diff --git a/nvflare/app_common/executors/launcher_executor.py b/nvflare/app_common/executors/launcher_executor.py
@@ -38,7 +38,7 @@ def __init__(
         launcher_id: Optional[str] = None,
         launch_timeout: Optional[float] = None,
         task_wait_time: Optional[float] = None,
-        task_read_wait_time: Optional[float] = 30.0,
+        task_read_wait_time: Optional[float] = None,
         result_poll_interval: float = 0.1,
         read_interval: float = 0.1,
         heartbeat_interval: float = 5.0,
@@ -53,9 +53,9 @@ def __init__(
             pipe_id (str): Identifier used to get the Pipe from NVFlare components.
             pipe_name (str): Name of the pipe. Defaults to "pipe".
             launcher_id (Optional[str]): Identifier used to get the Launcher from NVFlare components.
-            launch_timeout (Optional[float]): Timeout for the "launch" method to end. None means forever.
-            task_wait_time (Optional[float]): Time to wait for tasks to complete before exiting the executor.
-            task_read_wait_time (Optional[float]): Time to wait for task results from the pipe. Defaults to 30.0.
+            launch_timeout (Optional[float]): Timeout for the "launch" method to end. None means never timeout.
+            task_wait_time (Optional[float]): Time to wait for tasks to complete before exiting the executor. None means never timeout.
+            task_read_wait_time (Optional[float]): Time to wait for task results from the pipe. None means no wait.
             result_poll_interval (float): Interval for polling task results from the pipe. Defaults to 0.1.
             read_interval (float): Interval for reading from the pipe. Defaults to 0.1.
             heartbeat_interval (float): Interval for sending heartbeat to the peer. Defaults to 5.0.

diff --git a/nvflare/app_opt/pt/file_pipe_launcher_executor.py b/nvflare/app_opt/pt/file_pipe_launcher_executor.py
@@ -30,7 +30,7 @@ def __init__(
         launcher_id: Optional[str] = None,
         launch_timeout: Optional[float] = None,
         task_wait_time: Optional[float] = None,
-        task_read_wait_time: Optional[float] = 30.0,
+        task_read_wait_time: Optional[float] = None,
         result_poll_interval: float = 0.1,
         read_interval: float = 0.1,
         heartbeat_interval: float = 5.0,
@@ -45,9 +45,9 @@ def __init__(
             pipe_id (Optional[str]): Identifier used to get the Pipe from NVFlare components.
             pipe_name (str): Name of the pipe. Defaults to "pipe".
             launcher_id (Optional[str]): Identifier used to get the Launcher from NVFlare components.
-            launch_timeout (Optional[float]): Timeout for the "launch" method to end. None means forever.
-            task_wait_time (Optional[float]): Time to wait for tasks to complete before exiting the executor.
-            task_read_wait_time (Optional[float]): Time to wait for task results from the pipe. Defaults to 30.0.
+            launch_timeout (Optional[float]): Timeout for the "launch" method to end. None means never timeout.
+            task_wait_time (Optional[float]): Time to wait for tasks to complete before exiting the executor. None means never timeout.
+            task_read_wait_time (Optional[float]): Time to wait for task results from the pipe. None means no wait.
             result_poll_interval (float): Interval for polling task results from the pipe. Defaults to 0.1.
             read_interval (float): Interval for reading from the pipe. Defaults to 0.1.
             heartbeat_interval (float): Interval for sending heartbeat to the peer. Defaults to 5.0.