Skip to content

Commit d2b6ee3

Browse files
shnizzedygkiar
andcommitted
📝 Add developer docs for random state
Ref FCP-INDI/C-PAC#1496 Co-authored-by: Greg Kiar <[email protected]>
1 parent ed67ffa commit d2b6ee3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Random State
2+
============
3+
4+
When performing reproducibility/variability experiments, it is important to isolate sources of variability. One such source is random state.
5+
6+
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
7+
8+
* the :py:class:`nipype.interfaces.base.core.Interface` and the corresponding flags to add/remove to set the random seed, or
9+
* 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
10+
11+
to :py:function:`CPAC.pipeline.random_state.seed.random_seed_flags`.
12+
13+
.. py:function:: CPAC.pipeline.random_state.seed.random_seed_flags

0 commit comments

Comments
 (0)