From ab6b24e77f6501617990f1d50403c8144107ae24 Mon Sep 17 00:00:00 2001 From: Oleksandr Pavlyk Date: Tue, 27 Feb 2024 07:28:24 -0600 Subject: [PATCH] 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. --- mkl_random/mklrand.pyx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/mkl_random/mklrand.pyx b/mkl_random/mklrand.pyx index 93c7e26..bf343ae 100644 --- a/mkl_random/mklrand.pyx +++ b/mkl_random/mklrand.pyx @@ -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 ----- @@ -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 --------