Remove axisN keyword arguments from linalg.diag and linalg.trace
#241
Conversation
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 was referenced Aug 19, 2021
|
Thanks, @kgryte! |
asmeurer
added a commit
to asmeurer/numpy
that referenced
this pull request
Oct 7, 2021
The NumPy versions operate on the first two axes, but the array API diagonal should operate on the last two, so that they work correctly on stacks of matrices. See data-apis/array-api#241.
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.
This PR
axis1andaxis2keyword arguments fromlinalg.diagandlinalg.trace.Background
linalg.diagandlinalg.trace, as currently specified, are unique in their parameterization. Namely, for APIs which allow specification of axes, common convention is to useaxisoraxes. Furthermore, prior art (NumPy) used0and1as the default axes, which runs counter to the current prevalent practice of batching along the last (innermost) two dimensions.gh-215 proposed changing the defaults to
-2and-1, respectively. Subsequent discussion (both in gh-215 and in consortium meeting 2021-07-29) contended that they should be removed altogether.This PR follows consensus found in the consortium meeting to simply remove the
axisNkeyword arguments. If future needs arise to specify axes in the future, such additions can be made to the specification in a future revision.