Skip to content

Commit 51dd00f

Browse files
committed
📝 Document resource usage reports
1 parent f6f74f3 commit 51dd00f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/_sources/developer/nodes.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,18 @@ Nodes
2525
When a developer creates or modifies a Node in C-PAC, a ``mem_gb`` and ``n_procs`` argument should be provided unless the respective defaults of 0.2 and None (number of available system cores) are expected to be sufficient. When testing, the ``mem_gb`` and ``n_procs`` arguments should be adjusted if the observed memory and/or thread usage of a Node exceeds the estimate.
2626

2727

28-
.. autoclass:: CPAC.pipeline.engine.Node
28+
.. autoclass:: CPAC.pipeline.nipype_pipeline_engine.Node
2929
:special-members: __init__
3030
:members:
3131
:inherited-members:
3232

33-
.. autoclass:: CPAC.pipeline.engine.MapNode
33+
.. autoclass:: CPAC.pipeline.nipype_pipeline_engine.MapNode
3434
:special-members: __init__
3535
:members:
3636
:inherited-members:
3737

3838
.. autofunction:: CPAC.utils.monitoring.log_nodes_cb
3939

40-
.. autofunction:: nipype.utils.draw_gantt_chart.log_to_dict
40+
.. automodule:: CPAC.utils.monitoring.draw_gantt_chart
41+
:members: resource_report, log_to_dict, generate_gantt_chart, resource_overusage_report
42+
:inherited-members:

0 commit comments

Comments
 (0)