Skip to content

Commit 9b9caab

Browse files
committed
📝 Add observed usage flowchart to user docs
1 parent c5f97f0 commit 9b9caab

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

docs/_sources/_static/flowcharts/observed-usage.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/_sources/user/compute_config.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,14 @@ Computer Settings
99
#. **Maximum Cores Per Participant - [integer]:** Number of cores (on a single machine) or slots on a node (cluster/grid) per subject. Slots are cores on a cluster/grid node. 'Number of Cores Per Participant' multiplied by 'Number of Participants to Run Simultaneously' must not be greater than the total number of cores. Dedicating more than one core/CPU per participant will direct C-PAC to parallelize the motion correction and time series registration transform application steps, for a speed increase.
1010

1111
#. **Raise Insufficient - [True, False]:** If True (default), C-PAC will raise an error before trying to run a pipeline if it estimates the given data and pipeline configuration will exceed the memory or core limits. If False, C-PAC will raise a warning and continue to run the pipeline even if it estimates the given data and pipeline configuration will exceed the memory or core limits.
12+
.. _observed-usage:
1213

1314
#. **Observed Usage:** The resource usage of each node depends on many factors, including the data, the pipeline configuration, and the system. To run many subjects with optimimzed resource estimation, first run a single subject with the desired number of cores and with a generous memory limit. Then, provide the ``callback.log`` generated from that initial run when you run the rest of the subjects.
15+
16+
.. raw:: html
17+
18+
<object data="../_static/flowcharts/observed-usage.svg" type="image/svg+xml"></object>
19+
1420
#. **Callback log - [text]:** The path to a callback log file from a previous run, including any resource-management parameters that will be applied in this run, like ``n_cpus`` and ``num_ants_threads``. This file is used override memory estimates with previously observed memory usage. Can be overridden with the commandline flag ``--runtime_usage``.
1521
#. **Buffer - [percent]:** A percent of the previously observed memory usage that is to be added to the memory estimate. Default: 10. Can be overridden with the commandline flag ``--runtime_buffer``.
1622

0 commit comments

Comments
 (0)