Skip to content

Commit 971b9b6

Browse files
committed
update compatibility notice in MKLRandomState
1 parent e7963c5 commit 971b9b6

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

mkl_random/mklrand.pyx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6635,13 +6635,16 @@ cdef class MKLRandomState(_MKLRandomState):
66356635
array filled with generated values is returned. If `size` is a tuple,
66366636
then an array with that shape is filled and returned.
66376637
6638-
*Compatibility Notice*
6639-
While this class shares some similarities with the original `RandomState`,
6640-
it has been rewritten to use MKL's vector statistics functionality, that
6641-
provides efficient implementation of the MT19937 and many other basic
6642-
psuedo-random number generation algorithms as well as efficient sampling
6643-
from other common statistical distributions. As a consequence this version
6644-
is NOT seed-compatible with the original `RandomState`.
6638+
.. note::
6639+
*Compatibility Notice*
6640+
6641+
While this class shares some similarities with the original
6642+
`RandomState`, it has been rewritten to use MKL's vector statistics
6643+
functionality, that provides efficient implementation of the MT19937
6644+
and many other basic psuedo-random number generation algorithms as well
6645+
as efficient sampling from other common statistical distributions. As a
6646+
consequence this version is NOT seed-compatible with the original
6647+
`RandomState`.
66456648
66466649
Parameters
66476650
----------

0 commit comments

Comments
 (0)