docs: add array shape dimensions to Normal distribution type hints#100
Open
professor314 wants to merge 2 commits into
Open
docs: add array shape dimensions to Normal distribution type hints#100professor314 wants to merge 2 commits into
professor314 wants to merge 2 commits into
Conversation
Author
|
Hey, sorry about the formatting. I ran the project's Black formatter and pushed a fix. I saw issue #35 and thought the Normal distribution would be a good starting point since it's the most commonly used one. Let me know if there's anything else that needs adjusting. |
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.
Summary
Adds jaxtyping shape annotations to the
Normaldistribution class, replacing bareArraytype hints withFloat[Array, " *shape"]where appropriate.Changes
Floatfrom jaxtypinglocandscalefields asFloat[Array, " *shape"]supportreturnsFloat[Array, ""](scalar bounds)Float[Array, " *shape"]matching the event shapeMotivation
Addresses #35. Shape-annotated type hints make the API clearer for users reading docs or using IDE autocompletion, and enable more precise runtime checking via beartype in tests.
This PR covers the Normal distribution as a starting point. The same pattern can be applied to other distributions in follow-up PRs.
Testing
Type-annotation-only change. No behavioral changes. The existing test suite (
normal_test.py) continues to pass.