Skip to content
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: array types: mention partial support in special #19677

Merged
merged 3 commits into from
Dec 12, 2023

Conversation

lucascolley
Copy link
Member

@lucascolley lucascolley commented Dec 11, 2023

Reference issue

Towards gh-19252

What does this implement/fix?

Document the partial support for the array API towards gh-18867 which is being released as part of SciPy 1.12.

Additional information

Should be backported to the 1.12 branch.

We could add extra information about how there is special casing to call out to PyTorch and CuPy despite compiled code underlying the SciPy implementations and an xp.special extension not being a thing (yet), but this might not be necessary.

@lucascolley lucascolley added scipy.special Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org backport-candidate This fix should be ported by a maintainer to previous SciPy versions. array types Items related to array API support and input array validation (see gh-18286) labels Dec 11, 2023
@lucascolley lucascolley added this to the 1.12.0 milestone Dec 11, 2023
Copy link
Contributor

@tylerjereddy tylerjereddy left a comment

Choose a reason for hiding this comment

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

I don't have strong views on whether "Array" should be capitalized or not, but I agree with Matt that this is a net improvement, thanks.

@tylerjereddy tylerjereddy merged commit a54d061 into scipy:main Dec 12, 2023
25 of 26 checks passed
@tylerjereddy
Copy link
Contributor

I squash-merged for backporting sanity

@lucascolley lucascolley deleted the special-array-api-docs branch December 12, 2023 21:25
@mdhaber
Copy link
Contributor

mdhaber commented Dec 12, 2023

Oops; was waiting for CI to finish and got distracted. In the future, feel free to me for merge @lucascolley!

nprav pushed a commit to nprav/scipy that referenced this pull request Dec 13, 2023
* mention partial support in `special`
* address review comments
* make capitalisation consistent
tylerjereddy pushed a commit to tylerjereddy/scipy that referenced this pull request Dec 15, 2023
* mention partial support in `special`
* address review comments
* make capitalisation consistent
@tylerjereddy tylerjereddy removed the backport-candidate This fix should be ported by a maintainer to previous SciPy versions. label Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
array types Items related to array API support and input array validation (see gh-18286) Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.special
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants