Add documentation for patching utilities and interfaces#107
Add documentation for patching utilities and interfaces#107ndgrigorian wants to merge 11 commits intomasterfrom
interfaces#107Conversation
ndgrigorian
force-pushed
the
document-numpy-interface
branch
from
8b56414 to
d26d763
Compare
ndgrigorian
force-pushed
the
document-numpy-interface
branch
from
d26d763 to
fe7b7a2
Compare
ndgrigorian
requested review from
antonwolfy,
jharlow-intel and
xaleryb
as code owners
|
@antonwolfy @jharlow-intel PR is ready for review |
Alternatively, it can be downloaded through GH action |
ndgrigorian
force-pushed
the
document-numpy-interface
branch
from
47b4649 to
3c3fd15
Compare
ndgrigorian
force-pushed
the
document-numpy-interface
branch
from
6978343 to
e7963c5
Compare
ndgrigorian
force-pushed
the
document-numpy-interface
branch
from
09ac28a to
297cb4b
Compare
ndgrigorian
force-pushed
the
document-numpy-interface
branch
from
297cb4b to
9422ee0
Compare
|
@antonwolfy |
| The state of pseudo-random number generator is stored in :class:`mkl_random.RandomState` class, | ||
| .. tip:: | ||
| If you want a drop-in replacement for the `numpy.random <https://numpy.org/doc/stable/reference/random/legacy.html>`_ legacy interface, | ||
| see :ref:`interfaces`. While it is recommended users rewrite code to use :mod:`mkl_random` or :mod:`<|mkl_random.interfaces.numpy_random|>` |
There was a problem hiding this comment.
In the rendered documentation it's shown as
<|mkl_random.interfaces.numpy_random|>
Is that intended to wrap with <|?
| Functions | ||
| --------- | ||
|
|
||
| .. autofunction:: mkl_random.patch_numpy_random |
There was a problem hiding this comment.
Seems the Notes section is not properly rendered there.
| `RandomState`, it has been rewritten to use MKL's vector statistics | ||
| functionality, that provides efficient implementation of the MT19937. | ||
| As consequences: | ||
| this version is NOT seed-compatible with the original |
There was a problem hiding this comment.
If the idea was to have that rendered as a list item, then it does not seem working.
| 2. `state`: a dictionary guaranteed to contain the key | ||
| `mkl_stream`, whose value is a bytes object holding content of | ||
| Intel MKL's stream for the generator. | ||
| If `legacy` is False, a dictionary containing the state information |
There was a problem hiding this comment.
That one also badly formatted in the rendered page: probably the issue with proposed indention.
2 participants
This PR adds documentation for patching and for the
interfacessubmodule