-
Notifications
You must be signed in to change notification settings - Fork 10
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
feat: initial infrastructures for multi-backend support #62
Merged
Conversation
This file contains 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.
This PR provides initial infrastructures for multi-backend support and type checking.
Design goals
Goals for multi-backend support
camtools
shall be able to process and return both numpy array and torch tensors. This is done automatically by decorators.camtools
,camtools
can detected if torch is installed, and enable the corresponding backends.set_backend()
.Goals for type checking
camtools
shall be type hinted with the expected tensor shape and dtype.ct.sanity
.Changes of this PR
ivy
,jaxtyping
, andeinops
.ivy
: interoperate between numpy and torch. Shall only be used internally.jaxtyping
: type hinting for the library.torch
remains an optional dependency.ct.backend.get_backend()
andct.backend.set_backend()
and to set and get the default backend forcamtools
, this change is global and will affect all subsequent invocations to camtools functions.@ct.backend.with_native_backend
will ensure that the function will use camtools' default backend's native tensor format (np.ndarray
ortorch.Tensor
). It will also convert list inputs to native tensor format if the type hint is a tensor. Seetest/test_typing.py
for examples.@ct.typing.check_shape_and_dtype
will enforce shape and dtype checks based on the type hints for tensors. Seetest/test_typing.py
for examples. This check will eventually replace most of the functions inct.sanity
.Examples