Better documentation for jnp.load #24403
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
superbobry
approved these changes
Oct 20, 2024
| @@ -320,11 +321,43 @@ def _convert_and_clip_integer(val: ArrayLike, dtype: DType) -> Array: | |||
| return clip(val, min_val, max_val).astype(dtype) | |||
|
|
|||
|
|
|||
| @util.implements(np.load, update_doc=False) | |||
| def load(*args: Any, **kwargs: Any) -> Array: | |||
| def load(file: IO[bytes] | str | os.PathLike[Any], *args: Any, **kwargs: Any) -> Array: | |||
There was a problem hiding this comment.
OOC can we use os.PathLike[str] here or do we want to allow both str and bytes?
There was a problem hiding this comment.
I'm honestly not sure, I thought PathLike[Any] would be the safest annotation here.
| This function is a simple wrapper of :func:`numpy.load`, but in the case of | ||
| ``.npy`` files created with :func:`numpy.save` or :func:`jax.numpy.save`, | ||
| the output will be returned as a :class:`jax.Array`, and ``bfloat16`` data | ||
| types will be restored. For ``.npz`` files, results will be returned as |
There was a problem hiding this comment.
I suspect it should be possible to return jax.Arrays for .npz files as well. Is there a reason why we don't do that?
There was a problem hiding this comment.
loading an npz returns a lazy view of the file buffer, with various methods to actually load the (NumPy) arrays. Having it return JAX arrays would require re-implementing that object. Not impossible, but not something anyone has sat down and done.
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.
Part of #21461