Move jax.extend.ffi module to top level jax.ffi
#25633
Open
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
dfm
force-pushed
the
move-ffi
branch
2 times, most recently
from
f901fab to
b775ab5
Compare
dfm
commented
Dec 20, 2024
There was a problem hiding this comment.
@jakevdp - As part of this PR, I'm renaming this file, and documenting the functions in their new location (under jax.ffi instead of jax.extend.ffi). This will break any existing links to the API docs. I think this is probably okay, but wanted to check with you if there are better ways of handling this kind of deprecation?
There was a problem hiding this comment.
you can add a redirect here:
Line 351 in 01e8f88
That will work for the module-level redirect. For the individual APIs, we'd have to keep documenting the deprecated versions until they're removed.
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.
In #21531, @froystig and I decided to land the JAX foreign function interface (FFI) under that
jax.extendsubmodule, since it can be considered a mechanism for extending JAX. Since then, this decision has been questioned (most recently from @mattjj and @jakevdp), because thejax.extendsubmodule really has a narrower scope: interfacing with JAX internals (see the extend JEP for more details). Instead, the FFI is designed to allow users to extend JAX without interacting with JAX internals. Furthermore, code underjax.extendisn't required to follow the API compatibility contract that JAX's public APIs, but our aim is for the FFI to be a stable and well-supported public API.With this in mind, this PR moves the FFI submodule back into the top level
jax.ffinamespace, while leaving a deprecated import shim underjax.extend.ffi.