Skip to content

Commit ab6b24e

Browse files
Tweak for RandomState constructor docstring
The change is to make it clearn that brng="nondeterm" provides true randomness HW-based stream, and is not a pseudo-random generation algorithm.
1 parent e6b8596 commit ab6b24e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

mkl_random/mklrand.pyx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -984,8 +984,9 @@ cdef class RandomState:
984984
the clock otherwise.
985985
brng : {'MT19937', 'SFMT19937', 'MT2203', 'R250', 'WH', 'MCG31', 'MCG59',
986986
'MRG32K3A', 'PHILOX4X32X10', 'NONDETERM', 'ARS5'}, optional
987-
Basic pseudo-random number generation algorithms, provided by
988-
Intel MKL. The default choice is 'MT19937' - the Mersenne Twister.
987+
basic pseudo-random number generation algorithms, or non-deterministic
988+
hardware-based generator, provided by Intel MKL. The default choice is
989+
'MT19937' - the Mersenne Twister generator.
989990
990991
Notes
991992
-----
@@ -1034,9 +1035,9 @@ cdef class RandomState:
10341035
brng : {'MT19937', 'SFMT19937', 'MT2203', 'R250', 'WH', 'MCG31',
10351036
'MCG59', 'MRG32K3A', 'PHILOX4X32X10', 'NONDETERM',
10361037
'ARS5', None}, optional
1037-
Basic pseudo-random number generation algorithms, provided by
1038-
Intel MKL. Use `brng==None` to keep the `brng` specified to construct
1039-
the class instance.
1038+
basic pseudo-random number generation algorithms, or non-deterministic
1039+
hardware-based generator, provided by Intel MKL. Use `brng==None` to keep
1040+
the `brng` specified during construction of this class instance.
10401041
10411042
See Also
10421043
--------

0 commit comments

Comments
 (0)