-
Notifications
You must be signed in to change notification settings - Fork 53
feat: add broadcast_shapes to the specification
#983
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
Open
kgryte
wants to merge
2
commits into
data-apis:main
Choose a base branch
from
kgryte:feat/broadcast_shapes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| __all__ = [ | ||
| "broadcast_arrays", | ||
| "broadcast_shapes", | ||
| "broadcast_to", | ||
| "concat", | ||
| "expand_dims", | ||
|
|
@@ -35,6 +36,35 @@ def broadcast_arrays(*arrays: array) -> List[array]: | |
| """ | ||
|
|
||
|
|
||
| def broadcast_shapes(*shapes: Tuple[int, ...]) -> Tuple[int, ...]: | ||
| """ | ||
| Broadcasts one or more shapes against one another. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| shapes: Tuple[int, ...] | ||
| an arbitrary number of to-be broadcasted shapes. | ||
|
|
||
| Returns | ||
| ------- | ||
| out: Tuple[int, ...] | ||
| a broadcasted shape. | ||
|
|
||
| Raises | ||
| ------ | ||
| ValueError | ||
| If provided shapes which are not broadcast compatible (see :ref:`broadcasting`), a ``ValueError`` **should** be raised. | ||
|
|
||
| Notes | ||
| ----- | ||
|
|
||
| - If not provided one or more arguments, the function **must** return an empty tuple. | ||
|
|
||
| .. note:: | ||
| Array libraries which build computation graphs (e.g., ndonnx and Dask) commonly support shapes having dimensions of unknown size. If a shape contains a value other than an integer (e.g., ``None`` for a dimension of unknown size), behavior is unspecified and thus implementation-defined. Array-conforming libraries **may** choose to propagate such values (e.g., if a shape contains a dimension size of ``None``, the returned broadcasted shape also has a corresponding dimension having a size equal to ``None``) or raise an exception. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This can be phrased such that it works for computation graphs in the expected manner I believe, since the broadcasting math is abstract anyway and any sentinels can propagate correctly. To be discussed in the next call I think. |
||
| """ | ||
|
|
||
|
|
||
| def broadcast_to(x: array, /, shape: Tuple[int, ...]) -> array: | ||
| """ | ||
| Broadcasts an array to a specified shape. | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably say something like "The shape should match the regular broadcasting rules as documented in :ref:
broadcasting" to make the specification a little bit more tight.