Skip to content

Commit 0e1e752

Browse files
committed
update compatibility notice in MKLRandomState
1 parent fb20b7c commit 0e1e752

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
@@ -6677,13 +6677,16 @@ cdef class MKLRandomState(_MKLRandomState):
66776677
array filled with generated values is returned. If `size` is a tuple,
66786678
then an array with that shape is filled and returned.
66796679
6680-
*Compatibility Notice*
6681-
While this class shares some similarities with the original `RandomState`,
6682-
it has been rewritten to use MKL's vector statistics functionality, that
6683-
provides efficient implementation of the MT19937 and many other basic
6684-
psuedo-random number generation algorithms as well as efficient sampling
6685-
from other common statistical distributions. As a consequence this version
6686-
is NOT seed-compatible with the original `RandomState`.
6680+
.. note::
6681+
*Compatibility Notice*
6682+
6683+
While this class shares some similarities with the original
6684+
`RandomState`, it has been rewritten to use MKL's vector statistics
6685+
functionality, that provides efficient implementation of the MT19937
6686+
and many other basic psuedo-random number generation algorithms as well
6687+
as efficient sampling from other common statistical distributions. As a
6688+
consequence this version is NOT seed-compatible with the original
6689+
`RandomState`.
66876690
66886691
Parameters
66896692
----------

0 commit comments

Comments
 (0)