small edits

Author: apoorvkh

docs/source/advanced.rst

@@ -100,7 +100,7 @@ Environment variables in the launcher process that match the ``default_env_vars`
 Custom logging
 --------------
 
-We forward all logs (i.e. from :mod:`logging` and :mod:`sys.stdin`/:mod:`sys.stdout`) from workers and agents to the launcher. By default, the logs from the first agent and its first worker are printed into the launcher's ``stdout`` stream. Logs from all agents and workers are written to files in ``$TORCHRUNX_LOG_DIR`` (default: ``./torchrunx_logs``) and are named by timestamp, hostname, and local_rank.
+We forward all logs (i.e. from :mod:`logging` and :mod:`sys.stdout`/:mod:`sys.stderr`) from workers and agents to the launcher. By default, the logs from the first agent and its first worker are printed into the launcher's ``stdout`` stream. Logs from all agents and workers are written to files in ``$TORCHRUNX_LOG_DIR`` (default: ``./torchrunx_logs``) and are named by timestamp, hostname, and local_rank.
 
 :mod:`logging.Handler` objects can be provided via the ``log_handlers`` argument to provide further customization (mapping specific agents/workers to custom output streams).
 

docs/source/conf.py

@@ -22,7 +22,7 @@
     "sphinx.ext.linkcode",
 ]
 
-autodoc_mock_imports = ["torch", "fabric", "cloudpickle", "typing_extensions"]
+autodoc_mock_imports = ["torch", "fabric", "cloudpickle", "sys", "logging", "typing_extensions"]
 autodoc_typehints = "both"
 autodoc_typehints_description_target = "documented_params"
 

src/torchrunx/utils/logging.py

@@ -41,12 +41,12 @@ def add_filter_to_handler(
     local_rank: int | None,  # None indicates agent
     log_level: int = logging.NOTSET,
 ) -> None:
-    """A filter for :mod:`logging.Handler` such that only specific agent/worker logs are handled.
+    """Apply a filter to :mod:`logging.Handler` so only specific worker logs are handled.
 
     Args:
         handler: Handler to be modified.
         hostname: Name of specified host.
-        local_rank: Rank of specified worker (or ``None`` for agent).
+        local_rank: Rank of specified worker on host (or ``None`` for agent itself).
         log_level: Minimum log level to capture.
     """