fix: improve test coverage

[Benjamin-eecs]

Description

• Improve code coverage
• Update README
• Add codecov.yml

[codecov-commenter]

Codecov Report

Base: 70.36% // Head: 91.73% // Increases project coverage by +21.37% :tada:

Coverage data is based on head (fa1d6a3) compared to base (c58dff7). Patch coverage: 97.61% of modified lines in pull request are covered.

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #78       +/-   ##
===========================================
+ Coverage   70.36%   91.73%   +21.37%     
===========================================
  Files          72       66        -6     
  Lines        3009     2551      -458     
===========================================
+ Hits         2117     2340      +223     
+ Misses        892      211      -681     

Flag	Coverage Δ
unittests	91.73% <97.61%> (+21.37%)	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
torchopt/__init__.py	100.00% <ø> (ø)
torchopt/pytree.py	100.00% <ø> (+28.99%)	:arrow_up:
torchopt/utils.py	86.77% <77.78%> (+29.92%)	:arrow_up:
torchopt/transform/utils.py	91.07% <81.82%> (+16.07%)	:arrow_up:
torchopt/base.py	86.36% <83.33%> (+8.75%)	:arrow_up:
torchopt/alias/utils.py	98.77% <97.87%> (+5.91%)	:arrow_up:
torchopt/accelerated_op/__init__.py	100.00% <100.00%> (+77.27%)	:arrow_up:
torchopt/accelerated_op/_src/adam_op.py	100.00% <100.00%> (+100.00%)	:arrow_up:
torchopt/accelerated_op/adam_op.py	100.00% <100.00%> (+25.32%)	:arrow_up:
torchopt/alias/adam.py	100.00% <100.00%> (+21.74%)	:arrow_up:
... and 55 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.