add notebook showing API changes (function names)

[haesleinhuepf]

I'm just adding a notebook here so that we could answer questions such as this one easier in the future.

I could also add a notebook that shows parameter name changes. Does this make sense @StRigaud ? Happy to discuss in an upcoming meeting.

[StRigaud]

HI @haesleinhuepf

I did a draft PR already for updating the "read the doc" webpage here: #173

This introduce one new page to the deployment page of the repo which track the prototype change.
We can also add a notebook for easy testing sure

[haesleinhuepf]

ah ok thanks @StRigaud . Do I see it right that #173 contains a manually written documentation, while the notebook here is automatic? I could update it to write the API differences into a .rst file, which could then become part of the website.

[StRigaud]

I didn't see properly what the notebook was doing, sorry.

Yes, its a good way to track small changes! I'm in favor. However I would move it to the demo folder in the interoperability section.
And we should still keep tracks of the modification in the documentations, even if by hand, thats why it is good to have issues :)

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.18%. Comparing base (c3ebb4a) to head (3fa8251).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #202   +/-   ##
=======================================
  Coverage   85.18%   85.18%           
=======================================
  Files          18       18           
  Lines        1802     1802           
=======================================
  Hits         1535     1535           
  Misses        267      267           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[StRigaud]

Actually, I think we could integrate the notebool directly in the doc.

I have added a function which look at the difference per tiers, to make it easier to read.