8000 DOC: add note to default_rng about requiring non-negative seed · lesteve/numpy@86b3e63 · GitHub
[go: up one dir, main page]

Skip to content

Commit 86b3e63

Browse files
committed
DOC: add note to default_rng about requiring non-negative seed
This propagates the doc change from numpy#22779 to the default_rng docs. Closes numpy#22745
1 parent d03d4ed commit 86b3e63

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

numpy/random/_generator.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4875,8 +4875,8 @@ def default_rng(seed=None):
48754875
seed : {None, int, array_like[ints], SeedSequence, BitGenerator, Generator}, optional
48764876
A seed to initialize the `BitGenerator`. If None, then fresh,
48774877
unpredictable entropy will be pulled from the OS. If an ``int`` or
4878-
``array_like[ints]`` is passed, then it will be passed to
4879-
`SeedSequence` to derive the initial `BitGenerator` state. One may also
4878+
``array_like[ints]`` is passed, then all values must be non-negative and will be
4879+
passed to `SeedSequence` to derive the initial `BitGenerator` state. One may also
48804880
pass in a `SeedSequence` instance.
48814881
Additionally, when passed a `BitGenerator`, it will be wrapped by
48824882
`Generator`. If passed a `Generator`, it will be returned unaltered.

0 commit comments

Comments
 (0)
0