Repository navigation
Add documentation for patching utilities and interfaces - #107
ndgrigorian wants to merge 18 commits into
Conversation
d26d763 to
fe7b7a2
Compare
|
@antonwolfy @jharlow-intel PR is ready for review |
Alternatively, it can be downloaded through GH action |
297cb4b to
9422ee0
Compare
|
@antonwolfy |
19ef65c to
d12cacb
Compare
d12cacb to
42f9b70
Compare
9d5ae7a to
0c4d814
Compare
|
@antonwolfy ping |
jharlow-intel
left a comment
There was a problem hiding this comment.
Thanks for writing these up! The interfaces and patching pages are a really useful addition, and I checked that every function in the autodoc lists is actually exported by numpy_random. It has fallen pretty far behind master, though, so it needs a rebase before it can merge; details inline.
- This one needs a rebase before it can merge: it's 171 commits behind master and conflicts in
how_to.rst, where master has since added a thread-safety section. The red 3.14t Jenkins builds look like a side effect of the old base too, since it predates the free-threading support from #159, so a rebase should clear those.
|
|
||
| # remove linter flags from rendered docstrings | ||
|
|
||
|
|
There was a problem hiding this comment.
#165 also reworks api.rst (autosummary tables plus numpydoc) and removes the # no-cython-lint markers that this hook strips, and both PRs touch the same mklrand.pyx docstrings. Would it make sense to land #165 first and rebase this on top, keeping the new interfaces and patching pages and dropping the overlapping api.rst/conf.py changes?
| .. autofunction:: mkl_random.is_patched | ||
|
|
||
|
|
||
| Context manager |
There was a problem hiding this comment.
Could we also cover the command-line patching here? On master, python -m mkl_random --patch install|uninstall|status manages a persistent patch, and python -m mkl_random --with-numpy-patch <command> runs a single command with the patch applied; neither is mentioned yet. A short section, or a follow-up issue, would round this out.
| different streams of randomness, also known as basic random number generators. | ||
|
|
||
| The basic random number generator is chosen by specifying :code:`brng` keyword argument to the constructor of :code:`mkl.RandomState` class. | ||
| The basic random number generator is chosen by specifying :code:`brng` keyword argument to the constructor of :code:`mkl.MKLRandomState` class. |
There was a problem hiding this comment.
Nit: mkl.MKLRandomState here should be mkl_random.MKLRandomState (the old mkl.RandomState typo carried over in the rename).
| The basic random number generator is chosen by specifying :code:`brng` keyword argument to the constructor of :code:`mkl.MKLRandomState` class. | |
| The basic random number generator is chosen by specifying :code:`brng` keyword argument to the constructor of :code:`mkl_random.MKLRandomState` class. |
This PR adds documentation for patching and for the
interfacessubmodule