Skip to content

style: add jaxtyping annotations and contributor documentation #423

Merged
begumcig merged 8 commits intomainfrom
jaxtyping-integration
Oct 30, 2025
Merged

style: add jaxtyping annotations and contributor documentation #423
begumcig merged 8 commits intomainfrom
jaxtyping-integration

Conversation

@begumcig
Copy link
Copy Markdown
Member

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Additional Notes

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
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't this feature be implemented in a whole lot of other places too?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@begumcig begumcig merged commit 2e0f70d into main Oct 30, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants