diff options
Diffstat (limited to 'numpy/random/bit_generator.pyx')
| -rw-r--r-- | numpy/random/bit_generator.pyx | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/numpy/random/bit_generator.pyx b/numpy/random/bit_generator.pyx index acee0edf7..32d24c20d 100644 --- a/numpy/random/bit_generator.pyx +++ b/numpy/random/bit_generator.pyx @@ -458,6 +458,12 @@ cdef class SeedSequence(): Returns ------- seqs : list of `SeedSequence` s + + See Also + -------- + random.Generator.spawn, random.BitGenerator.spawn : + Equivalent method on the generator and bit generator. + """ cdef uint32_t i @@ -571,12 +577,9 @@ cdef class BitGenerator(): """ Create new independent child bit generators. - This is a convenience method to safely spawn new random number - generators via the `numpy.random.SeedSequence.spawn` mechanism. - The original seed sequence is accessible as ``bit_generator.seed_seq``. - - Please see `numpy.random.SeedSequence` for additional notes on - spawning children. + See :ref:`seeding_and_entropy` for additional notes on seeding and + spawning children. Some bit generators also implement ``jumped`` + as a different approach for creating independent streams. .. versionadded:: 1.25.0 @@ -584,12 +587,20 @@ cdef class BitGenerator(): ------- child_bit_generators : list of BitGenerators + Raises + ------ + TypeError + When the underlying SeedSequence does not implement spawning. + + See Also + -------- + random.Generator.spawn, random.SeedSequence.spawn : + Equivalent method on the generator and seed sequence. + """ if not isinstance(self._seed_seq, ISpawnableSeedSequence): raise TypeError( - "The underlying SeedSequence does not implement spawning. " - "You must ensure a custom SeedSequence used for initializing " - "the random state implements spawning (and registers it).") + "The underlying SeedSequence does not implement spawning.") return [type(self)(seed=s) for s in self._seed_seq.spawn(n_children)] |