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

Cleanup docstrings in lightly/utils subpackage #1698

Merged
merged 10 commits into from
Oct 18, 2024

Conversation

HarshitVashisht11
Copy link
Contributor

fixes #1675

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.

Thanks for your PR!

Two geral comments:

  • Please focus on updating docstrings or error strings. Logic changes, if any, should be done in separate PRs. It also makes this easier to approved and get merged :)
  • Before any commit, format the code using the auto formatter. See the contribution docs.

lightly/utils/bounding_box.py Outdated Show resolved Hide resolved
lightly/utils/bounding_box.py Outdated Show resolved Hide resolved
lightly/utils/bounding_box.py Outdated Show resolved Hide resolved
lightly/utils/debug.py Outdated Show resolved Hide resolved
lightly/utils/dependency.py Outdated Show resolved Hide resolved
lightly/utils/dependency.py Outdated Show resolved Hide resolved
lightly/utils/embeddings_2d.py Outdated Show resolved Hide resolved
lightly/utils/lars.py Show resolved Hide resolved
lightly/utils/lars.py Show resolved Hide resolved
lightly/utils/lars.py Show resolved Hide resolved
Copy link

codecov bot commented Oct 14, 2024

Codecov Report

Attention: Patch coverage is 75.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 84.86%. Comparing base (e80dda7) to head (664e6c4).
Report is 3 commits behind head on master.

Files with missing lines Patch % Lines
lightly/utils/embeddings_2d.py 0.00% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1698      +/-   ##
==========================================
+ Coverage   84.85%   84.86%   +0.01%     
==========================================
  Files         155      155              
  Lines        6509     6508       -1     
==========================================
  Hits         5523     5523              
+ Misses        986      985       -1     

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

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.

Thank you very much for updating the PR @HarshitVashisht11 !

Only a few last points, then this is ready to merge :)
Also don't to forget to run make format before any commits.

lightly/utils/bounding_box.py Outdated Show resolved Hide resolved
lightly/utils/bounding_box.py Outdated Show resolved Hide resolved
lightly/utils/hipify.py Outdated Show resolved Hide resolved
lightly/utils/lars.py Outdated Show resolved Hide resolved
lightly/utils/optim.py Outdated Show resolved Hide resolved
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.

Thanks for your update!

Your formatter seems to have a different version than the required one, I fixed it and pushed.

Let's get this merged :)

@MalteEbner MalteEbner enabled auto-merge (squash) October 18, 2024 13:44
@MalteEbner MalteEbner merged commit c9b84fd into lightly-ai:master Oct 18, 2024
13 of 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.

Cleanup docstrings in lightly/utils subpackage.
3 participants