FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Update namedtuple field names for `linalg.qr` and `linalg.svd` by kgryte · Pull Request #313 · data-apis/array-api · GitHub

Repository navigation

Update namedtuple field names for linalg.qr and linalg.svd - #313

Merged
kgryte merged 1 commit into
mainfrom
namedtuple-fields
Nov 5, 2021
Merged

kgryte merged 1 commit into
mainfrom
namedtuple-fields

Conversation

kgryte commented Nov 5, 2021

Copy link
Copy Markdown
Contributor

This PR

  • resolves Named tuple field names of linear algebra functions #295.
  • updates namedtuple field names for linalg.qr and linalg.svd. Previously, all namedtuple field names throughout the specification were lowercase for internal consistency. However, this was considered problematic for two reasons: (1) PyTorch is currently the only library supporting the specification in returning namedtuples and had already chosen to capitalize certain field names (e.g., (Q,R) in linalg.qr). Thus, requiring lowercase field names would introduce a breaking change. (2) For certain operations, capitalization allows matching mathematical naming conventions. Accordingly, this PR adopts PyTorch's naming conventions. Namely, (Q,R) for QR decomposition and (U,S,Vh) for singular value decomposition.

kgryte added Maintenance Bug fix, typo fix, or general maintenance. API change Changes to existing functions or objects in the API. topic: Linear Algebra Linear algebra. labels Nov 5, 2021
kgryte added this to the v2021 milestone Nov 5, 2021

kgryte commented Nov 5, 2021

Copy link
Copy Markdown
Contributor Author

As the changes proposed in the PR were discussed and agreed upon during today's call (4 November 2021), will merge. If any further changes are necessary, they can be addressed in follow-up PRs.

kgryte merged commit c08d302 into main Nov 5, 2021
kgryte deleted the namedtuple-fields branch November 5, 2021 04:23
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

Labels

API change Changes to existing functions or objects in the API. Maintenance Bug fix, typo fix, or general maintenance. topic: Linear Algebra Linear algebra.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Named tuple field names of linear algebra functions

1 participant


Back | FazBrowse Home | New Git URL