Skip to content

Commit 726c478

Browse files
committed
📝 Add random seed links
1 parent 363db43 commit 726c478

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

docs/_sources/developer/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Contents:
1616
installation
1717
pipeline
1818
nodes
19+
random_state
1920
workflow_documentation
2021
workflows/index
2122
testing

docs/_sources/developer/nodes.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
*****
22
Nodes
33
*****
4-
54
.. _mem_gb:
65

76
.. _n_procs:
@@ -36,6 +35,11 @@ For nodes that will use a varying amount of memory depending on the node's input
3635
:members:
3736
:inherited-members:
3837

38+
.. autoclass:: CPAC.utils.interfaces.function.Function
39+
:special-members: __init__
40+
:members:
41+
:inherited-members:
42+
3943
.. autoclass:: CPAC.pipeline.nipype_pipeline_engine.Workflow
4044
:special-members: __init__
4145
:members:

docs/_sources/developer/random_state.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ When performing reproducibility/variability experiments, it is important to isol
55

66
Users can fix the random state of C-PAC's execution by specifying a random seed. When adding a Node that should accept a user-specified random seed, add
77

8-
* the :py:class:`nipype.interfaces.base.core.Interface` and the corresponding flags to add/remove to set the random seed, or
8+
* the |nipype.interfaces.base.core.Interface|_ and the corresponding flags to add/remove to set the random seed, or
99
* in the case of a :py:class:`CPAC.utils.interfaces.function.Function` Node, the Function node's function and a function to apply to that function definition to set the random seed
1010

11-
to :py:function:`CPAC.pipeline.random_state.seed.random_seed_flags`.
11+
to :py:func:`CPAC.pipeline.random_state.seed.random_seed_flags`.
1212

13-
.. py:function:: CPAC.pipeline.random_state.seed.random_seed_flags
13+
.. autofunction:: CPAC.pipeline.random_state.seed.random_seed_flags
14+
15+
.. |nipype.interfaces.base.core.Interface| replace:: :py:class:`nipype.interfaces.base.core.Interface`
16+
.. _nipype.interfaces.base.core.Interface: https://nipype.readthedocs.io/en/1.5.1/devel/interface_specs.html

0 commit comments

Comments
 (0)