Add support for numpy struct dtype #211
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
jaxtyping/_array_types.py
Outdated
Comment on lines
752
to
789
| def make_numpy_struct_dtype(dtype, name): | ||
| """This is a convenience function to create type annotation for numpy structured array | ||
| It does exact match on the name, order, and dtype of all its fields | ||
|
|
||
| !!! Example: | ||
|
|
||
| ```python | ||
| label_t = np.dtype([('first', np.uint8), ('second', np.int8)]) | ||
| Label = make_numpy_struct_dtype(label_t, Label) | ||
| ``` | ||
| after that, you can use it just like any AbstractDtype | ||
| ```python | ||
| Label[np.array, 'a b c'] | ||
| ``` | ||
| """ | ||
| assert isinstance(dtype, np.dtype) |
There was a problem hiding this comment.
Nits:
- Can you add type annotations?
- Can you add
**Arguments:**and**Returns:**sections? (Seejaxtypedfor an example.) - Can you switch this from an
assertto aValueError? (The former I reserve for internal "developer mistake" errors, not "user passed in the wrong input" errors.)
Other than this, this PR looks good to me! Thank you for contributing :)
alexfanqi
force-pushed
the
main
branch
3 times, most recently
from
ce67283
to
21609c3
Compare
|
sorry, this took so long. How does this look? |
|
LGTM! Thank you for the contribution :) |
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.
Fixes #204