Skip to content

Commit b7b860b

Browse files
committed
add more documentation to MultiProc
1 parent 43f32d5 commit b7b860b

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

nipype/pipeline/plugins/multiproc.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,11 @@ class MultiProcPlugin(DistributedPluginBase):
104104
- n_procs: maximum number of threads to be executed in parallel
105105
- memory_gb: maximum memory (in GB) that can be used at once.
106106
- raise_insufficient: raise error if the requested resources for
107-
a node over the maximum `n_procs` and/or `memory_gb`.
107+
a node over the maximum `n_procs` and/or `memory_gb`
108+
(default is ``True``).
109+
- scheduler: sort jobs topologically (``'tsort'``, default value)
110+
or prioritize jobs by, first, memory consumption and, second,
111+
number of threads (``'mem_thread'`` option).
108112
109113
"""
110114

0 commit comments

Comments
 (0)