Skip to content

Commit 03f832b

Browse files
documented available BRNG generators
1 parent 9682ac0 commit 03f832b

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
`mkl_random` has started as Intel (R) Distribution for Python optimizations for NumPy.
55

6-
Per NumPy's community suggestions, voiced in https://github.com/numpy/numpy/pull/8209, it is being released as a
6+
Per NumPy's community suggestions, voiced in https://github.com/numpy/numpy/pull/8209, it is being released as a
77
stand-alone package.
88

99
Prebuilt `mkl_random` can be installed into conda environment from Intel's channel on Anaconda cloud:
@@ -20,13 +20,27 @@ For distributions directly supported in Intel (R) Math Kernel Library (MKL), `me
2020
mkl_random.standard_normal(size=(10**5, 10**3), method='BoxMuller')
2121
```
2222

23-
Additionally, `mkl_random` exposes different basic random number generation algorithms available in MKL. For example to use `SFMT19937` use
23+
Additionally, `mkl_random` exposes different basic random number generation algorithms available in MKL. For example to use `SFMT19937` use
2424

2525
```
2626
mkl_random.RandomState(77777, brng='SFMT19937')
2727
```
2828

2929
For generator families, such that `MT2203` and Wichmann-Hill, a particular member of the family can be chosen by specifying ``brng=('WH', 3)``, etc.
3030

31-
See MKL reference guide for more details:
32-
https://software.intel.com/en-us/mkl-developer-reference-c-random-number-generators
31+
See MKL reference guide for more details:
32+
https://software.intel.com/en-us/mkl-developer-reference-c-random-number-generators
33+
34+
The list of supported by `mkl_random.RandomState` constructor `brng` keywords is as follows:
35+
36+
* 'MT19937'
37+
* 'SFMT19937'
38+
* 'WH' or ('WH', id)
39+
* 'MT2203' or ('MT2203', id)
40+
* 'MCG31'
41+
* 'R250'
42+
* 'MRG32K3A'
43+
* 'MCG59'
44+
* 'PHILOX4X32X10'
45+
* 'NONDETERM'
46+
* 'ARS5'

0 commit comments

Comments
 (0)