Rename sparse functions to match numpy array API

[jessegrabowski]

Description

Rename tensor.sparse.mul -> tensor.sparse.multiply and tensor.sparse.sub -> tensor.sparse.subtract

Related Issue

• Closes
• Related to Rename pytensor.tensor.math.mul to pytensor.tensor.math.multiply to match array API standard #1370, Rename pytensor.tensor.math.sub to pytensor.tensor.math.subtract to match array API  #1371

Checklist

• Checked that the pre-commit linting/style checks pass
• Included tests that prove the fix is effective or that the new feature works
• Added necessary documentation (docstrings and/or example notebooks)
• If you are a pro: each commit corresponds to a relevant logical change

Type of change

• New feature / enhancement
• Bug fix
• Documentation
• Maintenance
• Other (please specify):

---

📚 Documentation preview 📚: https://pytensor--1663.org.readthedocs.build/en/1663/

[ricardoV94]

hmm I'm sure that issue was meant for tensor operations not sparse. Those don't exist on numpy so we can't "match their API". How does scipy call them?

not sure

[Armavica]

I would vote for yes, scipy also calls them multiply. And as far as I understand it's not numpy's API that we want to match but the Array API which is supposed to apply to whatever behaves like an array?

But why not also change the tensor operations in tensor/math.py while we are at it?

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.61%. Comparing base (95acdb3) to head (f188038).
⚠️ Report is 28 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1663      +/-   ##
==========================================
+ Coverage   81.56%   81.61%   +0.04%     
==========================================
  Files         242      242              
  Lines       53819    53533     -286     
  Branches     9485     9433      -52     
==========================================
- Hits        43899    43691     -208     
+ Misses       7431     7366      -65     
+ Partials     2489     2476      -13     

Files with missing lines	Coverage Δ
pytensor/sparse/basic.py	82.68% <100.00%> (+0.04%)	⬆️

... and 25 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ricardoV94]

We want to match numpy/scipy API, in case it doesn't have an equivalent (like subtract it seems), we can use the array API as the next best thing. That's where numpy/scipy want to converge anyway

[ricardoV94]

So both changes are fine

[jessegrabowski]

Do you want me to do the pytensor.tensor stuff in this PR too? Happy to. I did sparse in this PR because I searched for open issues related to sparse and this came up.

[ricardoV94]

As you prefer, it's your work

[jessegrabowski]

But why not also change the tensor operations in tensor/math.py while we are at it?

I started looking into this, but it seems like a pretty big job. I made the trivial replacements, then \started hitting all kinds of random bugs with rewrites and prettyprint and was quickly demotivated.

[Armavica]

But why not also change the tensor operations in tensor/math.py while we are at it?

I started looking into this, but it seems like a pretty big job. I made the trivial replacements, then \started hitting all kinds of random bugs with rewrites and prettyprint and was quickly demotivated.

In that case that's perhaps best left as another issue&PR? It sounds like the kind of PRs that keep me entertained

[jessegrabowski]

In that case that's perhaps best left as another issue&PR? It sounds like the kind of PRs that keep me entertained

Yes, that's what I would prefer. I'll edit this PR so it doesn't close #1370 and #1371, and edit those issuse to clarify we need to do the rename for pytensor.tensor

[jessegrabowski]

Ok done, lmk if you guys want anything else changed in this PR or not.

[jessegrabowski]

I sold out my principals for the good of the project, someone please approve my pr :(