-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
DOC: add Array API Standard support directive #21933
base: main
Are you sure you want to change the base?
Conversation
[docs only]
Xref #21255 |
Ah, right, I remembered a discussion but forgot it was a full issue. Yeah, looks like this would do very little of what you want : ) It is a generic advertisement with none of the details. I don't think an admonition would be the way to go for presenting details like the table in #21255 (comment); it is more of a way to get the word out that there's some sort of experimental support. |
#21255 is not going to happen in this release so I agree this could be a good idea. Also we could probably do with updating https://scipy.github.io/devdocs/dev/api-dev/array_api.html#currently-supported-functionality |
I added at least a partial list of updates in the release notes. Maybe we just include the admonitions at a module level and have it link to the list. Maybe we could add it to functions where other array types would offer big advantages, but it doesn't have to be added to every last function in stats, for instance. |
Thanks for starting this @mdhaber. I think we need an admonition of some sort (either per module or per function), so this could be a start. The main thing is indeed how one would add details to the admonition (e.g., supported by CuPy, not by xxx). Providing a "test this please" request without those details in the 1.15.0 docs may get us a whole bunch of bug reports for things we already know don't work. |
+1 for having an admonition that links to the complete (updated 😄 ) table in another page. Also, the admonition as implemented here would allow for text to be defined in the body of the admonition to be appended to the default text. So something like
would result in an admonition with title
|
Reference issue
gh-17597
gh-21255
What does this implement/fix?
This adds an admonition that advertises support for non-NumPy backends.
Additional information
Just an experiment; it's up for debate whether we want to do this yet.