style: add jaxtyping annotations and contributor documentation #423
Merged
style: add jaxtyping annotations and contributor documentation #423
Conversation
| Make sure to develop your contribution in a way that is well documented, concise and easy to maintain. | ||
| We will do our best to have your contribution integrated and maintained into |pruna| but reserve the right to reject contributions that we do not feel are in the best interest of the project. | ||
|
|
||
| Tensor Annotations with jaxtyping |
Member
There was a problem hiding this comment.
shouldn't this feature be implemented in a whole lot of other places too?
Member
Author
There was a problem hiding this comment.
Yes! Totally agree that we should extend this in future, we have also talked about how it would be useful for certain algorithms. I think for now, we can start with this though, what do you think?
davidberenstein1957
approved these changes
Oct 30, 2025
9 tasks
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.
Description
This PR introduces jaxtyping type checking to Pruna's image collation functions
The core implementation was contributed by vaishnaviparabkar90 in PR #382 and this branch brings their work into the main PrunaAI repository. I made minor adjustments (styling, tests) to align with our current codebase and standards.
Full credit for the original implementation goes to @vaishnaviparabkar90 💜💜💜 Thanks a lot for your amazing contribution!
Related Issue
Fixes #(issue number)
Type of Change
How Has This Been Tested?
Checklist
Additional Notes