Skip to content

Commit 3a899f7

Browse files
committed
♻️ Move interface definition to Nodes
1 parent a1299fd commit 3a899f7

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

docs/_sources/developer/nodes.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ For nodes that will use a varying amount of memory depending on the node's input
2525
.. note::
2626
``mem_x`` is a new parameter in C-PAC v1.8.1 and subject to change in future releases as we continue to `develop methods for setting data- and operation-dependent memory estimates <https://github.com/FCP-INDI/C-PAC/issues/1509>`_.
2727

28+
2829
.. autoclass:: CPAC.pipeline.nipype_pipeline_engine.Node
2930
:special-members: __init__
3031
:members:
@@ -35,6 +36,15 @@ For nodes that will use a varying amount of memory depending on the node's input
3536
:members:
3637
:inherited-members:
3738

39+
.. autoclass:: nipype.interfaces.base.core.Interface
40+
:special-members: __init__
41+
:members:
42+
:inherited-members:
43+
44+
.. seealso::
45+
46+
`Nipype: Interface Specifications <https://nipype.readthedocs.io/en/1.5.1/devel/interface_specs.html>`_
47+
3848
.. autoclass:: CPAC.utils.interfaces.function.Function
3949
:special-members: __init__
4050
:members:

docs/_sources/developer/random_state.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,9 @@ 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 |nipype.interfaces.base.core.Interface|_ and the corresponding flags to add/remove to set the random seed, or
8+
* the :py:class:`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

1111
to :py:func:`CPAC.pipeline.random_state.seed.random_seed_flags`.
1212

1313
.. autofunction:: CPAC.pipeline.random_state.seed.random_seed_flags
14-
15-
.. autoclass:: nipype.interfaces.base.core.Interface
16-
:special-members: __init__
17-
:members:
18-
:inherited-members:
19-
20-
.. |nipype.interfaces.base.core.Interface| replace:: :py:class:`nipype.interfaces.base.core.Interface`
21-
.. _nipype.interfaces.base.core.Interface: https://nipype.readthedocs.io/en/1.5.1/devel/interface_specs.html

0 commit comments

Comments
 (0)