Skip to content

Add linear algebra design principles #149

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

Merged
merged 5 commits into from
May 12, 2021
Merged

Add linear algebra design principles #149

merged 5 commits into from
May 12, 2021

Conversation

kgryte
Copy link
Contributor

@kgryte kgryte commented Mar 25, 2021

This PR

  • adds a section on design principles for linear algebra APIs.

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks @kgryte. Two other things come to mind:

  1. Namespaces. NumPy has the weird split between in linalg functions between its main namespace and numpy.linalg. Other libraries tend to follow that. There's no optimal solution; we should say something about it here though.
  2. You may want to include a part of Add specification for computing the dot product (linalg: vecdot) #137. A principle may be "orthogonality", which is a reason for including only certain "dot" functions.

@rgommers rgommers added the Narrative Content Narrative documentation content. label Mar 25, 2021
@kgryte
Copy link
Contributor Author

kgryte commented Mar 25, 2021

@rgommers I've added an orthogonality principle and a note regarding namespaces.

@kgryte
Copy link
Contributor Author

kgryte commented May 12, 2021

I've removed the note, and will submit a follow-up PR regarding the mirroring of top-level linear algebra APIs in the linalg submodule as discussed during recent meetings.

@kgryte kgryte merged commit 83c6be3 into main May 12, 2021
@kgryte kgryte deleted the linalg-design-principles branch May 12, 2021 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Narrative Content Narrative documentation content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants