Skip to content

Commit cf08147

Browse files
committed
Updated docs to reflect png
1 parent ffe30da commit cf08147

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

doc/users/resource_sched_profiler.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ The ``MultiProc`` workflow plugin schedules node execution based on the
3232
resources used by the current running nodes and the total resources available to
3333
the workflow. The plugin utilizes the plugin arguments ``n_procs`` and
3434
``memory_gb`` to set the maximum resources a workflow can utilize. To limit a
35-
workflow to using 4 cores and 6 GB of RAM:
35+
workflow to using 8 cores and 10 GB of RAM:
3636

3737
::
3838

39-
args_dict = {'n_procs' : 4, 'memory_gb' : 6}
39+
args_dict = {'n_procs' : 8, 'memory_gb' : 10}
4040
workflow.run(plugin='MultiProc', plugin_args=args_dict)
4141

4242
If these values are not specifically set then the plugin will assume it can
@@ -46,9 +46,9 @@ for ``n_procs`` and ``memory_gb``, respectively.
4646

4747
The plugin will then queue eligible nodes for execution based on their expected
4848
usage via the ``num_threads`` and ``estimated_memory_gb`` interface parameters.
49-
If the plugin sees that only 3 of its 4 processors and 4 GB of its 6 GB of RAM
49+
If the plugin sees that only 3 of its 8 processors and 4 GB of its 10 GB of RAM
5050
are being used by running nodes, it will attempt to execute the next available
51-
node as long as its ``num_threads = 1`` and ``estimated_memory_gb <= 2``. If
51+
node as long as its ``num_threads <= 5`` and ``estimated_memory_gb <= 6``. If
5252
this is not the case, it will continue to check every available node in the
5353
queue until it sees a node that meets these conditions, or it waits for an
5454
executing node to finish to earn back the necessary resources. The priority of
@@ -83,7 +83,7 @@ by setting the ``status_callback`` parameter to point to this function in the
8383
::
8484

8585
from nipype.pipeline.plugins.callback_log import log_nodes_cb
86-
args_dict = {'n_procs' : 4, 'memory_gb' : 6, 'status_callback' : log_nodes_cb}
86+
args_dict = {'n_procs' : 8, 'memory_gb' : 10, 'status_callback' : log_nodes_cb}
8787

8888
To set the filepath for the callback log the ``'callback'`` logger must be
8989
configured.
@@ -142,13 +142,13 @@ The pandas_ Python package is required to use this feature.
142142
::
143143

144144
from nipype.pipeline.plugins.callback_log import log_nodes_cb
145-
args_dict = {'n_procs' : 4, 'memory_gb' : 6, 'status_callback' : log_nodes_cb}
145+
args_dict = {'n_procs' : 8, 'memory_gb' : 10, 'status_callback' : log_nodes_cb}
146146
workflow.run(plugin='MultiProc', plugin_args=args_dict)
147147
148148
# ...workflow finishes and writes callback log to '/home/user/run_stats.log'
149149
150150
from nipype.utils.draw_gantt_chart import generate_gantt_chart
151-
generate_gantt_chart('/home/user/run_stats.log', cores=4)
151+
generate_gantt_chart('/home/user/run_stats.log', cores=8)
152152
# ...creates gantt chart in '/home/user/run_stats.log.html'
153153

154154
The `generate_gantt_chart`` function will create an html file that can be viewed

nipype/interfaces/tests/test_runtime_profiler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def setUp(self):
130130

131131
# Init parameters
132132
# Input RAM GB to occupy
133-
self.num_gb = 0.5
133+
self.num_gb = 1.0
134134
# Input number of sub-threads (not including parent threads)
135135
self.num_threads = 2
136136
# Acceptable percent error for memory profiled against input

0 commit comments

Comments
 (0)