Document MKLRandomState in the API reference and align docstrings with NumPy - #165
Open
vlad-perevezentsev wants to merge 5 commits into
Open
Document MKLRandomState in the API reference and align docstrings with NumPy#165vlad-perevezentsev wants to merge 5 commits into
MKLRandomState in the API reference and align docstrings with NumPy#165vlad-perevezentsev wants to merge 5 commits into
Conversation
vlad-perevezentsev
requested review from
antonwolfy,
jharlow-intel,
ndgrigorian and
xaleryb
as code owners
August 26, 2026 15:07
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR documents
MKLRandomStatetogether with its methods, and renders it withnumpydocfor consistency with NumPy's docs.Previously the API reference only showed the deprecated
RandomStatealias, without its methods.MKLRandomStateand its methods via per-methodautosummarypages.array_likeparameters, fix wrong parameter types/names, add missingReturnssections and constraint/default notes.