Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MAINT: Update link to RandomState #6743

Merged
merged 1 commit into from
Sep 9, 2019
Merged

MAINT: Update link to RandomState #6743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/changes/0.15.inc
View file
Open in desktop
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
View file
Open in desktop
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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't fill_doc this one since it's in a deprecated function anyway.

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
View file
Open in desktop
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