Skip to content

Commit

Permalink
MAINT: Update link to RandomState (mne-tools#6743)
Browse files Browse the repository at this point in the history
  • Loading branch information
larsoner authored and Alex Rockhill committed Oct 1, 2019
1 parent 803e470 commit bf6671f
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 12 deletions.
2 changes: 1 addition & 1 deletion doc/changes/0.15.inc
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Changelog

- Add option ``pick_ori='vector'`` to :func:`mne.minimum_norm.apply_inverse` to produce :class:`mne.VectorSourceEstimate` by `Marijn van Vliet`_

- Add support for :class:`numpy.random.mtrand.RandomState` argument to ``seed`` in :mod:`statistical clustering functions <mne.stats>` and better documentation of exact 1-sample tests by `Eric Larson`_
- Add support for :class:`numpy.random.RandomState` argument to ``seed`` in :mod:`statistical clustering functions <mne.stats>` and better documentation of exact 1-sample tests by `Eric Larson`_

- Extend :func:`mne.viz.plot_epochs_image`/:meth:`mne.Epochs.plot_image` with regards to grouping by or aggregating over channels. See the new example at `examples/visualization/plot_roi_erpimage_by_rt.py` by `Jona Sassenhagen`_

Expand Down
8 changes: 3 additions & 5 deletions mne/simulation/evoked.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ def simulate_evoked(fwd, stc, info, cov, nave=30, iir_filter=None,
.. versionadded:: 0.15.0
iir_filter : None | array
IIR filter coefficients (denominator) e.g. [1, -1, 0.2].
random_state : None | int | ~numpy.random.mtrand.RandomState
To specify the random generator state.
%(random_state)s
use_cps : bool (default True)
Whether to use cortical patch statistics to define normal
orientations when converting to fixed orientation (if necessary).
Expand Down Expand Up @@ -97,7 +96,7 @@ def simulate_noise_evoked(evoked, cov, iir_filter=None, random_state=None):
The noise covariance
iir_filter : None | array
IIR filter coefficients (denominator)
random_state : None | int | ~numpy.random.mtrand.RandomState
random_state : None | int | ~numpy.random.RandomState
To specify the random generator state.
Returns
Expand Down Expand Up @@ -134,8 +133,7 @@ def add_noise(inst, cov, iir_filter=None, random_state=None,
The noise covariance.
iir_filter : None | array-like
IIR filter coefficients (denominator).
random_state : None | int | ~numpy.random.mtrand.RandomState
To specify the random generator state.
%(random_state)s
%(verbose)s
Returns
Expand Down
12 changes: 6 additions & 6 deletions mne/utils/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -257,20 +257,20 @@

# Random state
docdict['random_state'] = """
random_state : None | int | instance of ~numpy.random.mtrand.RandomState
random_state : None | int | instance of ~numpy.random.RandomState
If ``random_state`` is an :class:`int`, it will be used as a seed for
:class:`~numpy.random.mtrand.RandomState`. If ``None``, the seed will be
:class:`~numpy.random.RandomState`. If ``None``, the seed will be
obtained from the operating system (see
:class:`~numpy.random.mtrand.RandomState` for details). Default is
:class:`~numpy.random.RandomState` for details). Default is
``None``.
"""

docdict['seed'] = """
seed : None | int | instance of ~numpy.random.mtrand.RandomState
seed : None | int | instance of ~numpy.random.RandomState
If ``seed`` is an :class:`int`, it will be used as a seed for
:class:`~numpy.random.mtrand.RandomState`. If ``None``, the seed will be
:class:`~numpy.random.RandomState`. If ``None``, the seed will be
obtained from the operating system (see
:class:`~numpy.random.mtrand.RandomState` for details). Default is
:class:`~numpy.random.RandomState` for details). Default is
``None``.
"""

Expand Down

0 comments on commit bf6671f

Please sign in to comment.