Skip to content

Commit c891c5a

Browse files
authored
Update description of cores, memory, job_cpu and job_mem parameters (#676)
1 parent e67631d commit c891c5a

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

dask_jobqueue/core.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,12 @@
2525

2626
job_parameters = """
2727
cores : int
28-
Total number of cores per job
28+
Total number of CPU cores on which all worker threads inside a job will run.
29+
The number of threads per worker process are determined using the formula ``cores / processes``.
30+
Used by job queuing system by default as amount of CPUs per job.
2931
memory: str
30-
Total amount of memory per job
32+
Total amount of memory to be used by all workers inside a job.
33+
Used by job queuing system by default as amount of memory per job.
3134
processes : int
3235
Cut the job up into this many processes. Good for GIL workloads or for
3336
nodes with many cores.

dask_jobqueue/slurm.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,11 @@ class SLURMCluster(JobQueueCluster):
166166
walltime : str
167167
Walltime for each worker job.
168168
job_cpu : int
169-
Number of cpu to book in SLURM, if None, defaults to worker `threads * processes`
169+
Number of CPUs to request in SLURM for each job.
170+
This option might be useful to request more CPUs than total number of worker threads
171+
for some complex non-python code. If None, defaults to ``cores``.
170172
job_mem : str
171-
Amount of memory to request in SLURM. If None, defaults to worker
172-
processes * memory
173+
Amount of memory to request in SLURM for each job, If None, defaults to ``memory``.
173174
job_extra : list
174175
Deprecated: use ``job_extra_directives`` instead. This parameter will be removed in a future version.
175176
job_extra_directives : list

0 commit comments

Comments
 (0)