Skip to content

Commit 82fa176

Browse files
committed
docstrings
1 parent 10c0514 commit 82fa176

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/torchrunx/utils/logging.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,8 @@ def shutdown(self) -> None:
185185

186186
@dataclass
187187
class LoggingServerArgs:
188+
"""Arguments for starting a :class:`_LogRecordSocketReceiver`."""
189+
188190
log_handlers: list[Handler] | Literal["auto"] | None
189191
logging_hostname: str
190192
logging_port: int
@@ -194,6 +196,7 @@ class LoggingServerArgs:
194196
log_level: int
195197

196198
def serialize(self) -> SerializedLoggingServerArgs:
199+
"""Serialize :class:`LoggingServerArgs` for passing to a new process."""
197200
return SerializedLoggingServerArgs(args=self)
198201

199202

@@ -209,6 +212,7 @@ def start_logging_server(
209212
serialized_args: SerializedLoggingServerArgs,
210213
stop_event: EventClass,
211214
) -> None:
215+
"""Serve :class:`_LogRecordSocketReceiver` until stop event triggered."""
212216
args: LoggingServerArgs = serialized_args.deserialize()
213217

214218
log_handlers = args.log_handlers

0 commit comments

Comments
 (0)