Update docs for PRNGKeyArray union and minimum Python version - #402
Open
rishabhsai wants to merge 1 commit into
Open
rishabhsai wants to merge 1 commit into
rishabhsai wants to merge 1 commit into
Conversation
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
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.
docs/api/array.mddocumentsjaxtyping.PRNGKeyArrayas a two-member union, but #388 addedUInt32[jax.Array, "4"]for therbg/unsafe_rbgPRNG implementations and the page has not been touched since before that merged, so a reader would conclude an old-style four-uint32key is rejected;import jaxtyping; print(jaxtyping.PRNGKeyArray)printstyping.Union[jaxtyping.Key[Array, ''], jaxtyping.UInt32[Array, '2'], jaxtyping.UInt32[Array, '4']].Separately,
README.mdanddocs/index.mdboth say "Requires Python 3.10+." whilepyproject.tomlhasrequires-python = ">=3.11", raised in #380, sopip install jaxtypingrefuses to install on 3.10 while the README promises it works.This updates the union line, extends its parenthetical to say which implementations give four
uint32s, changes both "3.10+" lines to "3.11+", anduv run mkdocs buildstill succeeds.