summaryrefslogtreecommitdiff
path: root/doc/source/reference/random
diff options
context:
space:
mode:
authorRobert Kern <robert.kern@gmail.com>2019-06-29 21:54:59 -0700
committerRobert Kern <robert.kern@gmail.com>2019-06-29 21:54:59 -0700
commit6658517495076c25f581c7093c39ad444f458b6f (patch)
tree6d7cebf9ffc7eab40233d498f0be8e8633050e07 /doc/source/reference/random
parentf0e64a12ee41ca9456ce7032d7ecdfe6f1be5ec1 (diff)
downloadnumpy-6658517495076c25f581c7093c39ad444f458b6f.tar.gz
ENH: Rename default_gen to default_rng
Diffstat (limited to 'doc/source/reference/random')
-rw-r--r--doc/source/reference/random/generator.rst2
-rw-r--r--doc/source/reference/random/index.rst10
-rw-r--r--doc/source/reference/random/parallel.rst6
3 files changed, 9 insertions, 9 deletions
diff --git a/doc/source/reference/random/generator.rst b/doc/source/reference/random/generator.rst
index c284b245c..c3803bcab 100644
--- a/doc/source/reference/random/generator.rst
+++ b/doc/source/reference/random/generator.rst
@@ -12,7 +12,7 @@ random values from useful distributions. The default BitGenerator used by
can be changed by passing an instantized BitGenerator to ``Generator``.
-.. autofunction:: default_gen
+.. autofunction:: default_rng
.. autoclass:: Generator
:exclude-members:
diff --git a/doc/source/reference/random/index.rst b/doc/source/reference/random/index.rst
index 7a171aa73..51e72513d 100644
--- a/doc/source/reference/random/index.rst
+++ b/doc/source/reference/random/index.rst
@@ -48,10 +48,10 @@ the random values are generated by `~.PCG64`. The
.. code-block:: python
- # As replacement for RandomState(); default_gen() instantiates Generator with
+ # As replacement for RandomState(); default_rng() instantiates Generator with
# the default PCG64 BitGenerator.
- from numpy.random import default_gen
- rg = default_gen()
+ from numpy.random import default_rng
+ rg = default_rng()
rg.standard_normal()
rg.bit_generator
@@ -87,8 +87,8 @@ The `Generator` is the user-facing object that is nearly identical to
.. code-block:: python
- from numpy.random import default_gen
- rg = default_gen(12345)
+ from numpy.random import default_rng
+ rg = default_rng(12345)
rg.random()
One can also instantiate `Generator` directly with a `BitGenerator` instance.
diff --git a/doc/source/reference/random/parallel.rst b/doc/source/reference/random/parallel.rst
index 18060defe..2f79f22d8 100644
--- a/doc/source/reference/random/parallel.rst
+++ b/doc/source/reference/random/parallel.rst
@@ -43,13 +43,13 @@ wrap this together into an API that is easy to use and difficult to misuse.
.. code-block:: python
- from numpy.random import SeedSequence, default_gen
+ from numpy.random import SeedSequence, default_rng
ss = SeedSequence(12345)
# Spawn off 10 child SeedSequences to pass to child processes.
child_seeds = ss.spawn(10)
- streams = [default_gen(s) for s in child_seeds]
+ streams = [default_rng(s) for s in child_seeds]
.. end_block
@@ -61,7 +61,7 @@ high probability) streams.
.. code-block:: python
grandchildren = child_seeds[0].spawn(4)
- grand_streams = [default_gen(s) for s in grandchildren]
+ grand_streams = [default_rng(s) for s in grandchildren]
.. end_block