Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation for lightly/models/modules #1700

Merged

Conversation

ayush22iitbhu
Copy link
Contributor

#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

Copy link
Contributor

@MalteEbner MalteEbner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, well done!

Just one note about style: Explanations of args go in another line, see the example file. This makes it more readable, especially for longer explanations.

lightly/models/modules/center.py Outdated Show resolved Hide resolved
lightly/models/modules/center.py Outdated Show resolved Hide resolved
lightly/models/modules/heads.py Show resolved Hide resolved
lightly/models/modules/heads.py Outdated Show resolved Hide resolved
lightly/models/modules/heads.py Outdated Show resolved Hide resolved
lightly/models/modules/heads.py Outdated Show resolved Hide resolved
lightly/models/modules/heads.py Outdated Show resolved Hide resolved
lightly/models/modules/heads_timm.py Outdated Show resolved Hide resolved
lightly/models/modules/heads_timm.py Outdated Show resolved Hide resolved
lightly/models/modules/heads_timm.py Outdated Show resolved Hide resolved
@ayush22iitbhu
Copy link
Contributor Author

ayush22iitbhu commented Oct 18, 2024

@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)"

@MalteEbner MalteEbner force-pushed the cleanup_lightly/models/modules branch from 536a4a7 to 166a46a Compare October 18, 2024 14:02
Copy link
Contributor

@MalteEbner MalteEbner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks perfect now, thanks a lot!

I quickly fixed the wrong indent of the docstring for the SMoGPrototypes and formatted the file, it is ready to merge now.

@MalteEbner MalteEbner enabled auto-merge (squash) October 18, 2024 14:05
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

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

@MalteEbner MalteEbner merged commit 5ac3898 into lightly-ai:master Oct 18, 2024
14 checks passed
payo101 pushed a commit to payo101/lightly that referenced this pull request Oct 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants