Skip to content

Commit

Permalink
Tweak for RandomState constructor docstring
Browse files Browse the repository at this point in the history
The change is to make it clearn that brng="nondeterm"
provides true randomness HW-based stream, and is not
a pseudo-random generation algorithm.
  • Loading branch information
oleksandr-pavlyk committed Feb 27, 2024
1 parent e6b8596 commit ab6b24e
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions mkl_random/mklrand.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -984,8 +984,9 @@ cdef class RandomState:
the clock otherwise.
brng : {'MT19937', 'SFMT19937', 'MT2203', 'R250', 'WH', 'MCG31', 'MCG59',
'MRG32K3A', 'PHILOX4X32X10', 'NONDETERM', 'ARS5'}, optional
Basic pseudo-random number generation algorithms, provided by
Intel MKL. The default choice is 'MT19937' - the Mersenne Twister.
basic pseudo-random number generation algorithms, or non-deterministic
hardware-based generator, provided by Intel MKL. The default choice is
'MT19937' - the Mersenne Twister generator.
Notes
-----
Expand Down Expand Up @@ -1034,9 +1035,9 @@ cdef class RandomState:
brng : {'MT19937', 'SFMT19937', 'MT2203', 'R250', 'WH', 'MCG31',
'MCG59', 'MRG32K3A', 'PHILOX4X32X10', 'NONDETERM',
'ARS5', None}, optional
Basic pseudo-random number generation algorithms, provided by
Intel MKL. Use `brng==None` to keep the `brng` specified to construct
the class instance.
basic pseudo-random number generation algorithms, or non-deterministic
hardware-based generator, provided by Intel MKL. Use `brng==None` to keep
the `brng` specified during construction of this class instance.
See Also
--------
Expand Down

0 comments on commit ab6b24e

Please sign in to comment.