DEP: linalg.solve_toeplitz/matmul_toeplitz: warn on n-D c, r
#22193
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
It isn't ideal to do it after RC2 of course, but I think we can probably do it. I put a tentative backport label. Ideally we signal our deprecation intentions at RC1, but I've accepted more dramatic last-minute additions than this for this cycle. Anyway, I'll see if there's strong pushback on it... but the label will at least remind me to look and see what the discussion (if one develops) was. |
c, rc, r
j-bowhay
reviewed
Dec 26, 2024
|
If we are going to backport this is it worth also updating the release notes with the added deprecation in this pr? |
mdhaber
commented
Dec 26, 2024
This was referenced Dec 27, 2024
mdhaber
commented
Dec 27, 2024
[skip ci]
[docs only]
j-bowhay
approved these changes
Dec 27, 2024
tylerjereddy
approved these changes
Dec 27, 2024
tylerjereddy
pushed a commit
to tylerjereddy/scipy
that referenced
this pull request
Jan 2, 2025
6 tasks
tylerjereddy
added a commit
that referenced
this pull request
Jan 2, 2025
…inal * DEP: linalg.solve_toeplitz/matmul_toeplitz: warn on n-D `c`, `r` (#22193) * DEP: linalg.solve_toeplitz: warn on n-D c, r * MAINT: linalg.matmul_toeplitz: add admonition to documentation; test warning * DOC: update release notes [docs only] * DOC: differentiate.jacobian: correct/improve documentation about callable interface [docs only] * Update scipy/differentiate/_differentiate.py [docs only] * DOC: Update 1.15.0 relnotes * Update the SciPy `1.15.0` release notes following additional backport activity. * MAINT: PR 22233 wheel build [wheel build] * Test wheel builds in above PR before release process starts. [wheel build] --------- Co-authored-by: Matt Haberland <mhaberla@calpoly.edu>
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.
Reference issue
Toward gh-21466
gh-21446
What does this implement/fix?
linalg.toeplitz,linalg.solve_toeplitz,linalg.matmul_toeplitzdocument thatcandrwith dimensionality greater than 1 will beraveled.gh-21446 added a warning that
toeplitzwould no longerravelin 1.17; rather, multidimensional arrays would be treated as batches of 1-D arrays.This adds similar warnings to
linalg.solve_toeplitzandlinalg.matmul_toeplitz. It also removes the documentation that n-D arrays will be raveled; it is still implicit in the admonition, and we don't really want to advertise it for new uses.Additional information
@tylerjereddy any chance we can get this into 1.15 from the perspective that
toeplitz,solve_toeplitz,matmul_toeplitzare a tuple and should have been treated together? This also fixes typos in the existing warnings.If not, I propose that we still document that this behavior will be changed in 1.17. Our public deprecation policy is
and in the Core Developer Guide, it says the change can be implemented 6 months after the release that includes the warning (and historically, the winter release tends to be >6 months after the summer release). I know we usually give two releases, but it would be nice to finish these up at the same time, and I expect these will be very low impact.