Skip to content

Commit ceca9ca

Browse files
jan-janssenjan-janssen
committed
Add docstrings
1 parent 925a629 commit ceca9ca

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

‎executorlib/executor/flux.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ class FluxJobExecutor(BaseExecutor):
4141
Defaults to None.
4242
- exclusive (bool): Whether to exclusively reserve the compute nodes, or allow sharing
4343
compute notes. Defaults to False.
44+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
45+
by the Python functions submitted to the Executor.
4446
flux_executor (flux.job.FluxExecutor): Flux Python interface to submit the workers to flux
4547
flux_executor_pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None (Flux only)
4648
flux_executor_nesting (bool): Provide hierarchically nested Flux job scheduler inside the submitted function.
@@ -126,6 +128,8 @@ def __init__(
126128
Defaults to None.
127129
- exclusive (bool): Whether to exclusively reserve the compute nodes, or allow sharing
128130
compute notes. Defaults to False.
131+
- error_log_file (str): Name of the error log file to use for storing exceptions
132+
raised by the Python functions submitted to the Executor.
129133
flux_executor (flux.job.FluxExecutor): Flux Python interface to submit the workers to flux
130134
flux_executor_pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None (Flux only)
131135
flux_executor_nesting (bool): Provide hierarchically nested Flux job scheduler inside the submitted function.
@@ -229,6 +233,8 @@ class FluxClusterExecutor(BaseExecutor):
229233
- openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI and
230234
SLURM only) - default False
231235
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
236+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
237+
by the Python functions submitted to the Executor.
232238
pysqa_config_directory (str, optional): path to the pysqa config directory (only for pysqa based backend).
233239
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
234240
context of an HPC cluster this essential to be able to communicate to an
@@ -308,6 +314,8 @@ def __init__(
308314
and SLURM only) - default False
309315
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM
310316
only)
317+
- error_log_file (str): Name of the error log file to use for storing exceptions
318+
raised by the Python functions submitted to the Executor.
311319
pysqa_config_directory (str, optional): path to the pysqa config directory (only for pysqa based backend).
312320
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
313321
context of an HPC cluster this essential to be able to communicate to an
@@ -424,6 +432,8 @@ def create_flux_executor(
424432
Defaults to None.
425433
- exclusive (bool): Whether to exclusively reserve the compute nodes, or allow sharing
426434
compute notes. Defaults to False.
435+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
436+
by the Python functions submitted to the Executor.
427437
flux_executor (flux.job.FluxExecutor): Flux Python interface to submit the workers to flux
428438
flux_executor_pmi_mode (str): PMI interface to use (OpenMPI v5 requires pmix) default is None (Flux only)
429439
flux_executor_nesting (bool): Provide hierarchically nested Flux job scheduler inside the submitted function.

‎executorlib/executor/single.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ class SingleNodeExecutor(BaseExecutor):
3939
- openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI and
4040
SLURM only) - default False
4141
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
42+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
43+
by the Python functions submitted to the Executor.
4244
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
4345
context of an HPC cluster this essential to be able to communicate to an
4446
Executor running on a different compute node within the same allocation. And
@@ -116,6 +118,8 @@ def __init__(
116118
and SLURM only) - default False
117119
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM
118120
only)
121+
- error_log_file (str): Name of the error log file to use for storing exceptions
122+
raised by the Python functions submitted to the Executor.
119123
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
120124
context of an HPC cluster this essential to be able to communicate to an
121125
Executor running on a different compute node within the same allocation. And
@@ -202,6 +206,8 @@ class TestClusterExecutor(BaseExecutor):
202206
- threads_per_core (int): number of OpenMP threads to be used for each function call
203207
- gpus_per_core (int): number of GPUs per worker - defaults to 0
204208
- cwd (str/None): current working directory where the parallel python task is executed
209+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
210+
by the Python functions submitted to the Executor.
205211
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
206212
context of an HPC cluster this essential to be able to communicate to an
207213
Executor running on a different compute node within the same allocation. And
@@ -273,6 +279,8 @@ def __init__(
273279
- threads_per_core (int): number of OpenMP threads to be used for each function call
274280
- gpus_per_core (int): number of GPUs per worker - defaults to 0
275281
- cwd (str/None): current working directory where the parallel python task is executed
282+
- error_log_file (str): Name of the error log file to use for storing exceptions
283+
raised by the Python functions submitted to the Executor.
276284
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
277285
context of an HPC cluster this essential to be able to communicate to an
278286
Executor running on a different compute node within the same allocation. And
@@ -381,6 +389,8 @@ def create_single_node_executor(
381389
and SLURM only) - default False
382390
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM
383391
only)
392+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
393+
by the Python functions submitted to the Executor.
384394
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
385395
context of an HPC cluster this essential to be able to communicate to an
386396
Executor running on a different compute node within the same allocation. And

‎executorlib/executor/slurm.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ class SlurmClusterExecutor(BaseExecutor):
4141
- openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI and
4242
SLURM only) - default False
4343
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM only)
44+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
45+
by the Python functions submitted to the Executor.
4446
pysqa_config_directory (str, optional): path to the pysqa config directory (only for pysqa based backend).
4547
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
4648
context of an HPC cluster this essential to be able to communicate to an
@@ -120,6 +122,8 @@ def __init__(
120122
and SLURM only) - default False
121123
- slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM
122124
only)
125+
- error_log_file (str): Name of the error log file to use for storing exceptions
126+
raised by the Python functions submitted to the Executor.
123127
pysqa_config_directory (str, optional): path to the pysqa config directory (only for pysqa based backend).
124128
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
125129
context of an HPC cluster this essential to be able to communicate to an
@@ -226,6 +230,8 @@ class SlurmJobExecutor(BaseExecutor):
226230
Defaults to None.
227231
- exclusive (bool): Whether to exclusively reserve the compute nodes, or allow sharing
228232
compute notes. Defaults to False.
233+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
234+
by the Python functions submitted to the Executor.
229235
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
230236
context of an HPC cluster this essential to be able to communicate to an
231237
Executor running on a different compute node within the same allocation. And
@@ -307,6 +313,8 @@ def __init__(
307313
Defaults to None.
308314
- exclusive (bool): Whether to exclusively reserve the compute nodes, or allow sharing
309315
compute notes. Defaults to False.
316+
- error_log_file (str): Name of the error log file to use for storing exceptions
317+
raised by the Python functions submitted to the Executor.
310318
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
311319
context of an HPC cluster this essential to be able to communicate to an
312320
Executor running on a different compute node within the same allocation. And
@@ -408,6 +416,8 @@ def create_slurm_executor(
408416
Defaults to None.
409417
- exclusive (bool): Whether to exclusively reserve the compute nodes, or allow sharing
410418
compute notes. Defaults to False.
419+
- error_log_file (str): Name of the error log file to use for storing exceptions raised
420+
by the Python functions submitted to the Executor.
411421
hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
412422
context of an HPC cluster this essential to be able to communicate to an
413423
Executor running on a different compute node within the same allocation. And

0 commit comments

Comments
 (0)