Add Documentation for lightly/models/modules

[ayush22iitbhu]

#1687

I have updated the docstrings for the following files:

1. lightly/models/modules/ijepa_timm.py
2. lightly/models/modules/ijepa.py
3. lightly/models/modules/masked_autoencoder_timm.py
4. lightly/models/modules/masked_autoencoder.py
5. lightly/models/modules/masked_casual_vision_transformer.py

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.90%. Comparing base (c57bdf1) to head (7a0ce71).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1704   +/-   ##
=======================================
  Coverage   84.90%   84.90%           
=======================================
  Files         156      156           
  Lines        6526     6526           
=======================================
  Hits         5541     5541           
  Misses        985      985           

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

[MalteEbner]

This looks great, thanks a lot!

I made two suggestions to make the docstrings a bit more helpful.

[ayush22iitbhu]

@MalteEbner I have done the changes for adding shape of tensors in docstring. Could you elaborate more on the adding typing in the function arguments?

[MalteEbner]

@MalteEbner I have done the changes for adding shape of tensors in docstring. Could you elaborate more on the adding typing in the function arguments?

Hey @ayush22iitbhu,

thanks for adding the tensor shapes!
While testing if they are correct, I found out the the IJEPA module is broken anyway and created the corresponding Issue: #1712
I reverted your last commit, as I would rather not document the shape than document it without testing if it is correct.

Sorry for this back-and-forth. I approved your commit as it is :)

[MalteEbner]

Well done!