diff options
| author | Sebastian Berg <sebastianb@nvidia.com> | 2023-03-13 12:34:29 +0100 |
|---|---|---|
| committer | Sebastian Berg <sebastianb@nvidia.com> | 2023-03-14 09:11:06 +0100 |
| commit | 94a9b8641bf4d1d5e5c4387df79341d4f0817f1b (patch) | |
| tree | 4f0c24bdf28157bd297bf8ae60b82bc4fd186232 /numpy/random | |
| parent | 99eaf340ca9b6d06d65c4ef9a5e96a1a83c42909 (diff) | |
| download | numpy-94a9b8641bf4d1d5e5c4387df79341d4f0817f1b.tar.gz | |
DOC: Add `n_children` param to rng.spawn() and bitgen.spawn() docs
The original PR forgot to include the Parameters section (and thus
the paraeter itself).
Diffstat (limited to 'numpy/random')
| -rw-r--r-- | numpy/random/_generator.pyx | 6 | ||||
| -rw-r--r-- | numpy/random/bit_generator.pyx | 6 |
2 files changed, 12 insertions, 0 deletions
diff --git a/numpy/random/_generator.pyx b/numpy/random/_generator.pyx index 4cc8d42f5..1b19d00d9 100644 --- a/numpy/random/_generator.pyx +++ b/numpy/random/_generator.pyx @@ -240,6 +240,8 @@ cdef class Generator: def spawn(self, int n_children): """ + spawn(n_children) + Create new independent child generators. See :ref:`seedsequence-spawn` for additional notes on spawning @@ -247,6 +249,10 @@ cdef class Generator: .. versionadded:: 1.25.0 + Parameters + ---------- + n_children : int + Returns ------- child_generators : list of Generators diff --git a/numpy/random/bit_generator.pyx b/numpy/random/bit_generator.pyx index 06f8c9753..83441747a 100644 --- a/numpy/random/bit_generator.pyx +++ b/numpy/random/bit_generator.pyx @@ -581,6 +581,8 @@ cdef class BitGenerator(): def spawn(self, int n_children): """ + spawn(n_children) + Create new independent child bit generators. See :ref:`seedsequence-spawn` for additional notes on spawning @@ -589,6 +591,10 @@ cdef class BitGenerator(): .. versionadded:: 1.25.0 + Parameters + ---------- + n_children : int + Returns ------- child_bit_generators : list of BitGenerators |