Skip to content

Commit

Permalink
Update docstring for fixed_seed to ref None option
Browse files Browse the repository at this point in the history
  • Loading branch information
emdupre committed Aug 1, 2018
1 parent 74e23e2 commit 8f1186a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
4 changes: 3 additions & 1 deletion tedana/decomposition/eigendecomp.py
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,9 @@ def tedica(n_components, dd, conv, fixed_seed, cost, final_cost,
conv : :obj:`float`
Convergence limit for ICA
fixed_seed : :obj:`int`
Seed for ensuring reproducibility of ICA results
Value passed to ``mdp.numx_rand.seed()``.
Set to an integer value for reproducibile ICA results;
otherwise, set to `None` for varying results across calls.
cost : {'tanh', 'pow3', 'gaus', 'skew'}
Initial cost function for ICA.
final_cost : {'tanh', 'pow3', 'gaus', 'skew'}
Expand Down
8 changes: 6 additions & 2 deletions tedana/workflows/tedana.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,9 @@ def _get_parser():
parser.add_argument('--seed',
dest='fixed_seed',
type=int,
help='Seeded value for ICA, for reproducibility.',
help=('Value passed to repr(mdp.numx_rand.seed()) '
'Set to an integer value for reproducibile ICA results; '
'otherwise, set to `None` for varying results across calls.'),
default=42)
parser.add_argument('--debug',
dest='debug',
Expand Down Expand Up @@ -228,7 +230,9 @@ def tedana_workflow(data, tes, mixm=None, ctab=None, manacc=None, strict=False,
Other Parameters
----------------
fixed_seed : :obj:`int`, optional
Seeded value for ICA, for reproducibility.
Value passed to ``mdp.numx_rand.seed()``.
Set to an integer value for reproducibile ICA results;
otherwise, set to `None` for varying results across calls.
debug : :obj:`bool`, optional
Whether to run in debugging mode or not. Default is False.
quiet : :obj:`bool`, optional
Expand Down

0 comments on commit 8f1186a

Please sign in to comment.