lightly-ai / lightly

A python library for self-supervised learning on images.
https://docs.lightly.ai/self-supervised-learning/
MIT License
3.19k stars 286 forks source link

Add Documentation for lightly/models/modules #1700

Closed ayush22iitbhu closed 1 month ago

ayush22iitbhu commented 1 month ago

1687

I have updated the docstrings for the following files:

  1. lightly/models/modules/center.py
  2. lightly/models/modules/heads_timm.py
  3. lightly/models/modules/heads.py
ayush22iitbhu commented 1 month ago

@MalteEbner I've done the instructed changes. Also, the file lightly/models/modules/heads.py fails to format when I run the make format command with the message "unindent does not match any outer indentation level (, line 362)"

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.86%. Comparing base (c9b84fd) to head (8d593dc). Report is 2 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1700 +/- ## ======================================= Coverage 84.86% 84.86% ======================================= Files 155 155 Lines 6508 6508 ======================================= Hits 5523 5523 Misses 985 985 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.