File tree Expand file tree Collapse file tree 1 file changed +20
-3
lines changed
Expand file tree Collapse file tree 1 file changed +20
-3
lines changed Original file line number Diff line number Diff line change 1- :mod: `mkl_random ` APIs
1+ :mod: `mkl_random ` Overview
22======================
33
4- The class :doc: `mkl_random.RandomState <./api >` exposes sampling from probability distributions while supporting
4+ The class :doc: `mkl_random.MKLRandomState <./api >` exposes sampling from probability distributions while supporting
55different streams of randomness, also known as basic random number generators.
66
7- The basic random number generator is chosen by specifying :code: `brng ` keyword argument to the constructor of :code: `mkl.RandomState ` class.
7+ The basic random number generator is chosen by specifying :code: `brng ` keyword argument to the constructor of :code: `mkl.MKLRandomState ` class.
88
99The list of supported basic random number generators is as follows (also see `oneMKL Engines <oneMKLBRNG _>`_):
1010
@@ -22,10 +22,27 @@ The list of supported basic random number generators is as follows (also see `on
2222
2323.. _oneMKLBRNG : https://spec.oneapi.io/versions/1.0-rev-2/elements/oneMKL/source/domains/rng/engines-basic-random-number-generators.html
2424
25+
26+ Drop-in interfaces
27+ ------------------
28+
29+ The :mod: `mkl_random.interfaces ` submodule provides drop-in replacements for standard random modules:
30+
31+ * :ref: `mkl_random.interfaces.numpy_random <numpy_random_interface >` - a drop-in replacement for the legacy :mod: `numpy.random ` module
32+
33+
34+ Patching
35+ --------
36+
37+ :mod: `mkl_random ` can :ref: `patch numpy.random <patching >` so that existing code calling :mod: `numpy.random `
38+ functions can use :mod: `mkl_random ` implementations.
39+
2540.. toctree ::
2641 :hidden:
2742
2843 api
44+ interfaces
45+ patching
2946 mt19937
3047 sfmt19937
3148 r250
You can’t perform that action at this time.
0 commit comments