Skip to content

Commit fe7b7a2

Browse files
committed
add sections to index.rst about interfaces and patching
1 parent b56e5f5 commit fe7b7a2

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

docs/source/reference/index.rst

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
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
55
different 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

99
The 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

0 commit comments

Comments
 (0)