Skip to content

Commit 4adfb3d

Browse files
jan-janssenjan-janssen
authored
Update docstrings to improve consistency (#764)
1 parent 3b8627c commit 4adfb3d

File tree

5 files changed

+41
-41
lines changed

5 files changed

+41
-41
lines changed

‎executorlib/executor/base.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,16 @@ def submit( # type: ignore
6868
fn (callable): function to submit for execution
6969
args: arguments for the submitted function
7070
kwargs: keyword arguments for the submitted function
71-
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the
72-
function. Example resource dictionary: {
73-
cores: 1,
74-
threads_per_core: 1,
75-
gpus_per_worker: 0,
76-
oversubscribe: False,
77-
cwd: None,
78-
executor: None,
79-
hostname_localhost: False,
80-
}
71+
resource_dict (dict): A dictionary of resources required by the task. With the following keys:
72+
- cores (int): number of MPI cores to be used for each function call
73+
- threads_per_core (int): number of OpenMP threads to be used for each function call
74+
- gpus_per_core (int): number of GPUs per worker - defaults to 0
75+
- cwd (str/None): current working directory where the parallel python task is executed
76+
- openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI and
77+
SLURM only) - default False
78+
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
79+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
80+
by the Python functions submitted to the Executor.
8181
8282
Returns:
8383
Future: A Future representing the given call.

‎executorlib/standalone/interactive/spawner.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def __init__(
7373
cwd (str, optional): The current working directory. Defaults to None.
7474
cores (int, optional): The number of cores to use. Defaults to 1.
7575
threads_per_core (int, optional): The number of threads per core. Defaults to 1.
76-
oversubscribe (bool, optional): Whether to oversubscribe the cores. Defaults to False.
76+
openmpi_oversubscribe (bool, optional): Whether to oversubscribe the cores. Defaults to False.
7777
"""
7878
super().__init__(
7979
cwd=cwd,

‎executorlib/standalone/serialize.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@ def serialize_funct_h5(
4242
fn (Callable): The function to be serialized.
4343
fn_args (list): The arguments of the function.
4444
fn_kwargs (dict): The keyword arguments of the function.
45-
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the function.
46-
Example resource dictionary: {
47-
cores: 1,
48-
threads_per_core: 1,
49-
gpus_per_worker: 0,
50-
oversubscribe: False,
51-
cwd: None,
52-
executor: None,
53-
hostname_localhost: False,
54-
}
45+
resource_dict (dict): A dictionary of resources required by the task. With the following keys:
46+
- cores (int): number of MPI cores to be used for each function call
47+
- threads_per_core (int): number of OpenMP threads to be used for each function call
48+
- gpus_per_core (int): number of GPUs per worker - defaults to 0
49+
- cwd (str/None): current working directory where the parallel python task is executed
50+
- openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI and
51+
SLURM only) - default False
52+
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
53+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
54+
by the Python functions submitted to the Executor.
5555
cache_key (str, optional): By default the cache_key is generated based on the function hash, this can be
5656
overwritten by setting the cache_key.
5757

‎executorlib/task_scheduler/base.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,16 +87,16 @@ def submit( # type: ignore
8787
fn (callable): function to submit for execution
8888
args: arguments for the submitted function
8989
kwargs: keyword arguments for the submitted function
90-
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the
91-
function. Example resource dictionary: {
92-
cores: 1,
93-
threads_per_core: 1,
94-
gpus_per_worker: 0,
95-
oversubscribe: False,
96-
cwd: None,
97-
executor: None,
98-
hostname_localhost: False,
99-
}
90+
resource_dict (dict): A dictionary of resources required by the task. With the following keys:
91+
- cores (int): number of MPI cores to be used for each function call
92+
- threads_per_core (int): number of OpenMP threads to be used for each function call
93+
- gpus_per_core (int): number of GPUs per worker - defaults to 0
94+
- cwd (str/None): current working directory where the parallel python task is executed
95+
- openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI and
96+
SLURM only) - default False
97+
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
98+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
99+
by the Python functions submitted to the Executor.
100100
101101
Returns:
102102
Future: A Future representing the given call.

‎executorlib/task_scheduler/interactive/blockallocation.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -113,16 +113,16 @@ def submit( # type: ignore
113113
fn (Callable): function to submit for execution
114114
args: arguments for the submitted function
115115
kwargs: keyword arguments for the submitted function
116-
resource_dict (dict): resource dictionary, which defines the resources used for the execution of the
117-
function. Example resource dictionary: {
118-
cores: 1,
119-
threads_per_core: 1,
120-
gpus_per_worker: 0,
121-
oversubscribe: False,
122-
cwd: None,
123-
executor: None,
124-
hostname_localhost: False,
125-
}
116+
resource_dict (dict): A dictionary of resources required by the task. With the following keys:
117+
- cores (int): number of MPI cores to be used for each function call
118+
- threads_per_core (int): number of OpenMP threads to be used for each function call
119+
- gpus_per_core (int): number of GPUs per worker - defaults to 0
120+
- cwd (str/None): current working directory where the parallel python task is executed
121+
- openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI and
122+
SLURM only) - default False
123+
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
124+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
125+
by the Python functions submitted to the Executor.
126126
127127
Returns:
128128
Future: A Future representing the given call.

0 commit comments

Comments
 (0)