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 the lightly/data subpackage #1741

Merged
merged 10 commits into from
Nov 22, 2024

Conversation

ChiragAgg5k
Copy link
Contributor

This PR will mark completing cleanup of _image.py, lightly_subset.py and multi_view_collage.py files in the data subpackage according to issue #1689

after this _video.py, collage.py and dataset.py files will be left, which will be done in separate PRs due to their long size.

@ChiragAgg5k
Copy link
Contributor Author

seems like tests are failing due to issues not introduced via this pr...

@guarin
Copy link
Contributor

guarin commented Nov 20, 2024

seems like tests are failing due to issues not introduced via this pr...

Hi, the tests fail because torchvision.transforms.Transform doesn't exist and your PR tries to import it.

@ChiragAgg5k
Copy link
Contributor Author

ooohh ok got it. fixed it

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

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

Project coverage is 85.31%. Comparing base (ad7230e) to head (4a1933f).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
lightly/data/_image.py 83.33% 2 Missing ⚠️
lightly/data/lightly_subset.py 87.50% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1741      +/-   ##
==========================================
+ Coverage   85.23%   85.31%   +0.08%     
==========================================
  Files         162      162              
  Lines        6730     6729       -1     
==========================================
+ Hits         5736     5741       +5     
+ Misses        994      988       -6     

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


🚨 Try these New Features:

@ChiragAgg5k
Copy link
Contributor Author

@guarin do review the pr when u can, thanks :D

@philippmwirth
Copy link
Contributor

@guarin do review the pr when u can, thanks :D

Hi @ChiragAgg5k and thanks a lot for your contribution! Before I review, could you please remove the newly typed files from the list of files ignored by mypy here? Thank you!

@ChiragAgg5k
Copy link
Contributor Author

@philippmwirth hi there, the PR does not focus on dataset.py file for now, thats why it's been ignored. Given the size of this file, it will be fixed in another PR

@ChiragAgg5k
Copy link
Contributor Author

I tried removing files which were formatted from the ignore, and it lead to some errors. i will push the fixes soon

@ChiragAgg5k
Copy link
Contributor Author

@philippmwirth any update?

@philippmwirth
Copy link
Contributor

@philippmwirth any update?

Did you not want to push the fixes first?

@ChiragAgg5k
Copy link
Contributor Author

@philippmwirth yup i do. but i am facing an issue here:

the tests are failing due to an error in the code itself:

Screenshot 2024-11-22 at 1 07 56 PM

@philippmwirth
Copy link
Contributor

Thanks, @ChiragAgg5k, I'll take a look.

Copy link
Contributor

@philippmwirth philippmwirth 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 @ChiragAgg5k for your help! I quickly fixed the typing problem you encountered.

@philippmwirth philippmwirth merged commit 8a6685f into lightly-ai:master Nov 22, 2024
14 checks passed
vectorvp pushed a commit to vectorvp/lightly that referenced this pull request Nov 26, 2024
Clean up docstrings and typecheck _image.py, lightly_subset.py, and multi_view_collate.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants