Improve transformer api

[BalzaniEdoardo]

Small PR allowing the chaining behavior of TransformerBasis.

Before this PRs, basis methods returning self could not be chained when the basis was wrapped by the TransformerBasis class.

Old behavior

>>> import nemos as nmo
>>> from nemos.basis._basis import Basis
>>> from nemos.basis._transformer_basis import TransformerBasis
>>> transformer_basis = nmo.basis.BSplineEval(5).to_transformer()
>>> out = transformer_basis.set_input_shape(1)
>>> isinstance(out, TransformerBasis)
False
>>> isinstance(out, Basis)
True

New behavior

>>> import nemos as nmo
>>> from nemos.basis._basis import Basis
>>> from nemos.basis._transformer_basis import TransformerBasis
>>> transformer_basis = nmo.basis.BSplineEval(5).to_transformer()
>>> out = transformer_basis.set_input_shape(1)
>>> isinstance(out, TransformerBasis)
True
>>> isinstance(out, Basis)
False

Key Features

• Decorator that processes the output of chainable basis methods, setting the method output (the updated basis object) to the _basis attribute of the transformer, and returns the transformer.
• New tuple attribute of the TransformerBasis listing all the chainable methods of basis.
• Run-time decoration of chainable methods in the __getattr__ when first called + caching. Run-time decorating is necessary because if set at initialization, it would create a circular reference, and result in infinite loop when pickling.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 97.85714% with 6 lines in your changes missing coverage. Please review.

Project coverage is 97.09%. Comparing base (3691356) to head (51584bb).
Report is 1 commits behind head on development.

Files with missing lines	Patch %	Lines
src/nemos/basis/basis.py	92.30%	4 Missing ⚠️
src/nemos/basis/_basis_mixin.py	99.11%	1 Missing ⚠️
src/nemos/basis/_transformer_basis.py	98.11%	1 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff               @@
##           development     #280      +/-   ##
===============================================
+ Coverage        96.13%   97.09%   +0.96%     
===============================================
  Files               34       34              
  Lines             2507     2686     +179     
===============================================
+ Hits              2410     2608     +198     
+ Misses              97       78      -19     

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

[sjvenditto]

I committed a fix to a couple typos I found, otherwise it looks good!

[BalzaniEdoardo]

Great! Thanks

…

On Tue, Dec 17, 2024, 4:19 PM Sarah Jo Venditto ***@***.***> wrote: ***@***.**** approved this pull request. I committed a fix to a couple typos I found, otherwise it looks good! — Reply to this email directly, view it on GitHub <#280 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AG2MOSYD5MLCEFD7JFINZR32GCINJAVCNFSM6AAAAABTTVEBUKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKMJQGE2TGMRXHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>