broadcast_arrays et al: change the return type into a tuple#380
Draft
ev-br wants to merge 4 commits intodata-apis:mainfrom
Draft
broadcast_arrays et al: change the return type into a tuple#380ev-br wants to merge 4 commits intodata-apis:mainfrom
broadcast_arrays et al: change the return type into a tuple#380ev-br wants to merge 4 commits intodata-apis:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the broadcast_arrays function to return a tuple instead of a list, following the upcoming 2025.12 array API specification. This is an acknowledged backwards compatibility break.
Changes:
- Modified
torchimplementation to return tuple instead of list - Added wrapper for
cupyto convert list return to tuple - Noted need for numpy < 2 workaround (not yet implemented)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| array_api_compat/torch/_aliases.py | Changed return value from list comprehension to tuple generator |
| array_api_compat/cupy/_aliases.py | Added wrapper function to convert cp.broadcast_arrays result to tuple and added to all |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
9d01104 to
c746621
Compare
broadcast_arrays et al: change the return type into a tuple
This file contains hidden or 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.
Following the upcoming 2025.12 spec (data-apis/array-api#981), change the return type.
This is a backwards compat break, yes. As long as
array-api-compattargets the 2025 revision, we don't seem to need to branch on the array API version.broadcast_arraysbroadcast_arrays,meshgridreturn a tuple not list cupy/cupy#9582 lands for cupy 14, we'll be able to undo the workaroundAlso
meshgridtorchcupy: returns lists for cupy < 14, needs a workaround still?numpy: a workaround for numpy < 2 ?.
__array_namespace_info__().devices(): a matching -tests PR is ENH: Test return values which changes from lists to tuples in 2025.12 array-api-tests#406