diff options
| author | Robert Kern <robert.kern@gmail.com> | 2022-08-12 21:56:17 -0400 |
|---|---|---|
| committer | Robert Kern <robert.kern@gmail.com> | 2022-08-12 21:56:17 -0400 |
| commit | bd97d7aefef7cb06ebda1014b1ab1c60c58ad224 (patch) | |
| tree | a97455c5659a20fc632872ad33db2a03d8f381fe | |
| parent | 29b99f544a551d3590910bf8f398686336515ce4 (diff) | |
| download | numpy-bd97d7aefef7cb06ebda1014b1ab1c60c58ad224.tar.gz | |
DOC: Explain spawn_key a little more.
| -rw-r--r-- | numpy/random/bit_generator.pyx | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/numpy/random/bit_generator.pyx b/numpy/random/bit_generator.pyx index 62eaab6c0..c698f6b61 100644 --- a/numpy/random/bit_generator.pyx +++ b/numpy/random/bit_generator.pyx @@ -261,8 +261,10 @@ cdef class SeedSequence(): entropy : {None, int, sequence[int]}, optional The entropy for creating a `SeedSequence`. spawn_key : {(), sequence[int]}, optional - A third source of entropy, used internally when calling - `SeedSequence.spawn` + An additional source of entropy based on the position of this + `SeedSequence` in the tree of such objects created with the + `SeedSequence.spawn` method. Typically, only `SeedSequence.spawn` will + set this, and users will not. pool_size : {int}, optional Size of the pooled entropy to store. Default is 4 to give a 128-bit entropy pool. 8 (for 256 bits) is another reasonable choice if working |