Merge branch 'master' into enh/default-gen

numpy · mattip · Jun 28, 2019 · Jun 26, 2019 · Jun 26, 2019 · Jun 26, 2019
commit 1f2d8b908967b451eeee887e7490b508839f19b9
diff --git a/numpy/random/philox.pyx b/numpy/random/philox.pyx
@@ -102,16 +102,17 @@ cdef class Philox(BitGenerator):
 
     **State and Seeding**
 
-    The ``Philox`` state vector consists of a 256-bit counter encoded as
-    a 4-element uint64 array and a 128-bit key encoded as a 2-element uint64
-    array. The counter is incremented by 1 for every 4 64-bit randoms produced.
-    The key which determines the sequence produced. Using different keys
-    produces independent sequences.
-
-    By default, providing a ``seed`` value will derive the 128-bit key using
-    `SeedSequence`; the counter will be initialized to 0. On the other hand,
-    one may omit the ``seed`` and provide the ``key`` and/or ``counter``
-    directly if one wishes to manually control the key.
+    The ``Philox`` state vector consists of a 256-bit value encoded as
+    a 4-element uint64 array and a 128-bit value encoded as a 2-element uint64
+    array. The former is a counter which is incremented by 1 for every 4 64-bit
+    randoms produced. The second is a key which determined the sequence
+    produced. Using different keys produces independent sequences.
+
+    The input seed is processed by `SeedSequence` to generate the key. The
+    counter is set to 0.
+
+    Alternately, one can omit the seed parameter and set the ``key`` and
+    ``counter`` directly.
 
     **Parallel Features**