Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update descriptions of cores, memory, slurm job_cpu and slurm job_mem parameters #676

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update descriptions of cores, memory, slurm job_cpu and slurm job_mem parameters #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions dask_jobqueue/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@

job_parameters = """
cores : int
Total number of cores per job
Total number of CPU cores on which all worker threads inside a job will run.
The number of threads per worker process are determined using the formula ``cores / processes``.
Used by job queuing system by default as amount of CPUs per job.
memory: str
Total amount of memory per job
Total amount of memory to be used by all workers inside a job.
Used by job queuing system by default as amount of memory per job.
processes : int
Cut the job up into this many processes. Good for GIL workloads or for
nodes with many cores.
Expand Down
7 changes: 4 additions & 3 deletions dask_jobqueue/slurm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,11 @@ class SLURMCluster(JobQueueCluster):
walltime : str
Walltime for each worker job.
job_cpu : int
Number of cpu to book in SLURM, if None, defaults to worker `threads * processes`
Number of CPUs to request in SLURM for each job.
This option might be useful to request more CPUs than total number of worker threads
for some complex non-python code. If None, defaults to ``cores``.
job_mem : str
Amount of memory to request in SLURM. If None, defaults to worker
processes * memory
Amount of memory to request in SLURM for each job, If None, defaults to ``memory``.
job_extra : list
Deprecated: use ``job_extra_directives`` instead. This parameter will be removed in a future version.
job_extra_directives : list
Expand Down
Loading