Update local_scheduler.py (#839)

D53788269 was landed without updating its linked PR. This commit is adding the missing piece.
pytorch · Mar 1, 2024 · 6f5f70a · 6f5f70a
1 parent e5cb668
commit 6f5f70a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/torchx/schedulers/local_scheduler.py b/torchx/schedulers/local_scheduler.py
@@ -264,6 +264,12 @@ def get_entrypoint(self, img_root: str, role: Role) -> str:
 
 
 class PopenProtocol(Protocol):
+    """
+    Protocol wrapper around python's ``subprocess.Popen``. Keeps track of
+    the a list of interface methods that the process scheduled by the `LocalScheduler`
+    must implement.
+    """
+
     @property
     def pid(self) -> int:
         ...