Skip to content

Commit

Permalink
docstring fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ankona committed Jun 20, 2023
1 parent 11066ba commit 529cc9d
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions smartsim/settings/alpsSettings.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@ def __init__(
)
self.mpmd: t.List[RunSettings] = []

def make_mpmd(self, aprun_settings: RunSettings) -> None:
def make_mpmd(self, settings: RunSettings) -> None:
"""Make job an MPMD job
This method combines two ``AprunSettings``
into a single MPMD command joined with ':'
:param aprun_settings: ``AprunSettings`` instance
:type aprun_settings: AprunSettings
:param settings: ``AprunSettings`` instance
:type settings: AprunSettings
"""
if self.colocated_db_settings:
raise SSUnsupportedError(
Expand All @@ -81,7 +81,7 @@ def make_mpmd(self, aprun_settings: RunSettings) -> None:
raise SSUnsupportedError(
"Containerized MPMD workloads are not yet supported."
)
self.mpmd.append(aprun_settings)
self.mpmd.append(settings)

def set_cpus_per_task(self, cpus_per_task: int) -> None:
"""Set the number of cpus to use per task
Expand Down
2 changes: 1 addition & 1 deletion smartsim/settings/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ def make_mpmd(self, settings: RunSettings) -> None:
"""Make job an MPMD job
:param settings: ``RunSettings`` instance
:type aprun_settings: RunSettings
:type settings: RunSettings
"""
logger.warning(
(
Expand Down
4 changes: 2 additions & 2 deletions smartsim/settings/lsfSettings.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ def make_mpmd(self, settings: RunSettings) -> None:
Optionally, this method adds an instance of ``JsrunSettings`` to
the list of settings to be launched in the same ERF file.
:param aprun_settings: ``JsrunSettings`` instance, defaults to None
:type aprun_settings: JsrunSettings, optional
:param settings: ``JsrunSettings`` instance
:type settings: JsrunSettings, optional
"""
if self.colocated_db_settings:
raise SSUnsupportedError(
Expand Down
8 changes: 4 additions & 4 deletions smartsim/settings/slurmSettings.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,14 @@ def set_nodes(self, nodes: int) -> None:
"""
self.run_args["nodes"] = int(nodes)

def make_mpmd(self, srun_settings: RunSettings) -> None:
def make_mpmd(self, settings: RunSettings) -> None:
"""Make a mpmd workload by combining two ``srun`` commands
This connects the two settings to be executed with a single
Model instance
:param srun_settings: RunSettings instance
:type srun_settings: RunSettings
:param settings: SrunSettings instance
:type settings: SrunSettings
"""
if self.colocated_db_settings:
raise SSUnsupportedError(
Expand All @@ -105,7 +105,7 @@ def make_mpmd(self, srun_settings: RunSettings) -> None:
raise SSUnsupportedError(
"Containerized MPMD workloads are not yet supported."
)
self.mpmd.append(srun_settings)
self.mpmd.append(settings)

def set_hostlist(self, host_list: t.Union[str, t.List[str]]) -> None:
"""Specify the hostlist for this job
Expand Down

0 comments on commit 529cc9d

Please sign in to comment.