Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Question] Integrate something like jaxtyping for more specific type annotations and runtime type-checking #63

Open
2 tasks done
dantp-ai opened this issue Dec 14, 2024 · 10 comments
Labels
question Further information is requested

Comments

@dantp-ai
Copy link

Question

Are there any plans on the roadmap to use something like jaxtyping for more specific type annotations and runtime type checking?

Additional context

Checklist

  • I have read the documentation (required)
  • I have checked that there is no similar issue in the repo (required)
@dantp-ai dantp-ai added the question Further information is requested label Dec 14, 2024
@araffin
Copy link
Owner

araffin commented Dec 14, 2024

Hello,
there is currently no plan for it.
Would you volunteer for such feature?

@dantp-ai
Copy link
Author

I can look into it. I'll start first with the tests folder.

@sandeshkatakam
Copy link

Hey,
I was actually considering opening an issue to explore adding jaxtyping support as well. It sounds like we're aligned in our interests, and If you like, I’d love to collaborate with you on this!

I can look into it. I'll start first with the tests folder.

@dantp-ai
Copy link
Author

@sandeshkatakam I'd be glad to collaborate. How should we do it best?

One idea would be that, I open a feature branch on my fork. You'll need to add my fork as a remote and check out the same branch. Once this is done, we can sync frequently and decided who works on specific parts to avoid conflicts. What do you think?

@sandeshkatakam
Copy link

sandeshkatakam commented Dec 29, 2024

@sandeshkatakam I'd be glad to collaborate. How should we do it best?

One idea would be that, I open a feature branch on my fork. You'll need to add my fork as a remote and check out the same branch. Once this is done, we can sync frequently and decided who works on specific parts to avoid conflicts. What do you think?

Yeah this seems great! I will add your fork as remote and push commits to the branch, after we decide on dividing the specific parts of the work. Thank you :)

@araffin
Copy link
Owner

araffin commented Dec 29, 2024

before you do too much work, please open a PR as soon as you have a proof of concept, so we can agree on the details

@sandeshkatakam
Copy link

@sandeshkatakam I'd be glad to collaborate. How should we do it best?

One idea would be that, I open a feature branch on my fork. You'll need to add my fork as a remote and check out the same branch. Once this is done, we can sync frequently and decided who works on specific parts to avoid conflicts. What do you think?

Let me know once you fork the repo and create a branch

@dantp-ai
Copy link
Author

@sandeshkatakam I'll open the PR at the latest on Thu.

@sandeshkatakam
Copy link

@sandeshkatakam I'll open the PR at the latest on Thu.

hey did you open the PR??

@dantp-ai
Copy link
Author

dantp-ai commented Jan 7, 2025

@sandeshkatakam I looked in a bit more detail how to use jaxtyping in the project. It can be paired with mypy for static analysis and additionally using e.g. beartype for runtime checks in critical sections (and avoid these runtime checks in performance-critical paths).

I'm blocked this week with some other stuff. Feel free to open a PR (from your fork) if you want to dive in already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants