diff options
author | Sebastian Berg <sebastianb@nvidia.com> | 2023-02-13 09:10:42 +0100 |
---|---|---|
committer | Sebastian Berg <sebastianb@nvidia.com> | 2023-02-14 20:19:28 +0100 |
commit | e390f6772766c3b27711ef3ab5df498dd7494d45 (patch) | |
tree | 62938f299104111daab7705e707514b4af26fbb3 /doc/source/reference/random | |
parent | 6f1d159cb711fcbd8240abd7fd68415d8319c4d9 (diff) | |
download | numpy-e390f6772766c3b27711ef3ab5df498dd7494d45.tar.gz |
DOC: Improve docs around generator spawning
Trying to address Robert Kerns review comments.
Diffstat (limited to 'doc/source/reference/random')
-rw-r--r-- | doc/source/reference/random/bit_generators/index.rst | 12 | ||||
-rw-r--r-- | doc/source/reference/random/generator.rst | 5 |
2 files changed, 15 insertions, 2 deletions
diff --git a/doc/source/reference/random/bit_generators/index.rst b/doc/source/reference/random/bit_generators/index.rst index d93f38d0b..f67458567 100644 --- a/doc/source/reference/random/bit_generators/index.rst +++ b/doc/source/reference/random/bit_generators/index.rst @@ -50,6 +50,8 @@ The included BitGenerators are: Philox <philox> SFC64 <sfc64> +.. _seeding_and_entropy: + Seeding and Entropy =================== @@ -127,6 +129,16 @@ of 12 instances: .. end_block +If you already have an initial random generator instance, you can shorten +the above by using the `~Generator.spawn` method: + +.. code-block:: python + + from numpy.random import PCG64, SeedSequence + # High quality initial entropy + entropy = 0x87351080e25cb0fad77a44a3be03b491 + base_rng = PCG(entropy) + generators = base_rng.spawn(12) An alternative way is to use the fact that a `~SeedSequence` can be initialized by a tuple of elements. Here we use a base entropy value and an integer diff --git a/doc/source/reference/random/generator.rst b/doc/source/reference/random/generator.rst index dc71cb1f9..e08395b17 100644 --- a/doc/source/reference/random/generator.rst +++ b/doc/source/reference/random/generator.rst @@ -18,12 +18,13 @@ can be changed by passing an instantized BitGenerator to ``Generator``. :members: __init__ :exclude-members: __init__ -Accessing the BitGenerator --------------------------- +Accessing the BitGenerator and Spawning +--------------------------------------- .. autosummary:: :toctree: generated/ ~numpy.random.Generator.bit_generator + ~numpy.random.Generator.spawn Simple random data ------------------ |