Skip to content

Commit

Permalink
docstring touch-up
Browse files Browse the repository at this point in the history
  • Loading branch information
pmcurtin committed Jul 8, 2024
1 parent 28921fd commit 7b0f69a
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions src/torchrunx/launcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ def launch(
:type func_kwargs: dict[str, Any]
:param hostnames: A list of node hostnames to start workers on, defaults to ["localhost"]
:type hostnames: list[str], optional
:param workers_per_host: The numbder of workers per node.
Providing an `int` implies all nodes should have `workers_per_host` workers, meanwhile providing a list causes node `i` to have `worker_per_host[i]` workers, defaults to 1
:param workers_per_host: The number of workers per node. Providing an `int` implies all nodes should have `workers_per_host` workers, meanwhile providing a list causes node `i` to have `worker_per_host[i]` workers, defaults to 1
:type workers_per_host: int | list[int], optional
:param ssh_config_file: An SSH configuration file to use when connecting to nodes, defaults to None
:type ssh_config_file: str | os.PathLike | None, optional
Expand Down

0 comments on commit 7b0f69a

Please sign in to comment.