Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC, API: add random.__init__.pxd and document random.* functions #14948

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

Merged
charris merged 4 commits into from
Nov 27, 2019
Merged

DOC, API: add random.__init__.pxd and document random.* functions #14948

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c63f811
DOC, API: add numpy.random.__index__.pxd and document numpy.random.* …
mattip Nov 21, 2019
5a52be5
MAINT: "See also" -> "See Also"
mattip Nov 21, 2019
a413620
DOC: fixes from review
mattip Nov 21, 2019
0a5e428
DOC: update note from review
mattip Nov 21, 2019
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
Prev Previous commit
Next Next commit
DOC: fixes from review
  • Loading branch information
@mattip
mattip committed Nov 22, 2019
commit a413620ed8c13efc1f513859e3140ad6922d67d0
9 changes: 6 additions & 3 deletions doc/source/reference/random/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,16 @@ properties than the legacy `MT19937` used in `RandomState`.

.. code-block:: python

#Do this
# Do this
from numpy.random import default_rng
val = default_rng().standard_normal()
rng = default_rng()
vals = rng.standard_normal(10)
more_vals = rng.standard_normal(10)

# instead of this
from numpy import random
val = random.standard_normal()
vals = random.standard_normal(10)
more_vals = random.standard_normal(10)

`Generator` can be used as a replacement for `RandomState`. Both class
instances hold a internal `BitGenerator` instance to provide the bit
Expand Down
16 changes: 12 additions & 4 deletions doc/source/reference/random/legacy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,18 @@ Distributions
~RandomState.weibull
~RandomState.zipf

Copy link
Member Author

@mattip mattip Nov 21, 2019

Choose a reason for hiding this comment

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

Add the legacy functions below so they are linked into the intersphinx index

Toplevel `numpy.random` functions
=================================
Many of the RandomState methods above are exported as top-level `numpy.random`
functions. These are:
Functions in `numpy.random`
===========================
Many of the RandomState methods above are exported as functions in
`numpy.random` This usage is discouraged, as it is implemented via a gloabl
`RandomState` instance which is not advised on two counts:

- It uses global state, which means results will change as the code changes

- It uses a `RandomState` rather than the more modern `Generator`.

For backward compatible legacy reasons, we cannot change this. See
`random-quick-start`.

.. autosummary::
:toctree: generated/
Expand Down