Merge pull request #27 from bashtage/remove-.generator-doc

mattip · web-flow · commit ef20a4ec2eb7 · 2019-05-18T21:15:49.000+03:00
DOC: Remove references to .generator
diff --git a/doc/source/reference/random/index.rst b/doc/source/reference/random/index.rst
@@ -52,13 +52,13 @@ the random values are generated by `~xoroshiro128.Xoroshiro128`. The
 
 
 Seeds can be passed to any of the BitGenerators. Here `mt19937.MT19937` is used
-and the ``Generator`` is accessed via the attribute `mt19937.MT19937.
-generator`.
+and is the wrapped with a `~.Generator`.
+
 
 .. code-block:: python
 
-  from numpy.random import MT19937
-  rg = MT19937(12345).generator
+  from numpy.random import Generator, MT19937
+  rg = Generator(MT19937(12345))
   rg.standard_normal()
 
 
@@ -78,7 +78,7 @@ bit generator-provided stream and transforms them into more useful
 distributions, e.g., simulated normal random values. This structure allows
 alternative bit generators to be used with little code duplication.
 
-The ``Generator`` is the user-facing object
+The `~.Generator` is the user-facing object
 that is nearly identical to :class:`~.RandomState`. The canonical
 method to initialize a generator passes a `~mt19937.MT19937` bit generator, the
 underlying bit generator in Python -- as the sole argument. Note that the bit
diff --git a/doc/source/reference/random/multithreading.rst b/doc/source/reference/random/multithreading.rst
@@ -16,7 +16,7 @@ are reproducible in the sense that the same seed will produce the same outputs.
 
 .. code-block:: ipython
 
-    from numpy.random import Xorshift1024
+    from numpy.random import Generator, Xorshift1024
     import multiprocessing
     import concurrent.futures
     import numpy as np
@@ -88,7 +88,7 @@ The single threaded call directly uses the PRNG.
 .. code-block:: ipython
 
     In [5]: values = np.empty(10000000)
-        ...: rg = Xorshift1024().generator
+        ...: rg = Generator(Xorshift1024())
         ...: %timeit rg.standard_normal(out=values)
 
     99.6 ms ± 222 µs per loop (mean ± std. dev. of 7 runs, 10 loops each)
@@ -99,7 +99,7 @@ that does not use an existing array due to array creation overhead.
 
 .. code-block:: ipython
 
-    In [6]: rg = Xorshift1024().generator
+    In [6]: rg = Generator(Xorshift1024())
         ...: %timeit rg.standard_normal(10000000)
 
     125 ms ± 309 µs per loop (mean ± std. dev. of 7 runs, 10 loops each)
