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 random grayscale #2128

Merged
merged 3 commits into from
Nov 9, 2024
Merged

Add random grayscale #2128

merged 3 commits into from
Nov 9, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Nov 9, 2024

Fixes: #2080

Summary by Sourcery

Add a new 'RandomGrayscale' transformation to the library, allowing images to be randomly converted to grayscale. Update documentation and tests to include this new feature.

New Features:

  • Introduce a new transformation class 'RandomGrayscale' that randomly converts images to grayscale with a specified probability, providing compatibility with torchvision and Kornia APIs.

Documentation:

  • Add documentation for the new 'RandomGrayscale' transformation in the README file, including a link to its detailed description.

Tests:

  • Include 'RandomGrayscale' in various test cases to ensure its functionality and compatibility with other augmentations.

Copy link
Contributor

sourcery-ai bot commented Nov 9, 2024

Reviewer's Guide by Sourcery

This PR adds a new RandomGrayscale transform class that provides compatibility with torchvision and Kornia APIs by acting as an alias for the existing ToGray transform. The implementation includes comprehensive documentation, test coverage, and necessary updates to export the new transform.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added new RandomGrayscale transform class as an alias for ToGray
  • Implemented RandomGrayscale class inheriting from ToGray
  • Added comprehensive docstring with usage examples and references
  • Set default probability to 0.1 to match other libraries
  • Added deprecation warning suggesting direct ToGray usage
albumentations/augmentations/tk/transform.py
Updated test coverage for the new transform
  • Added RandomGrayscale to various test sets for mask fill value
  • Included in multichannel image augmentation tests
  • Added to float multichannel image tests
  • Added to different channel count tests
tests/test_augmentations.py
tests/aug_definitions.py
Updated documentation and exports
  • Added RandomGrayscale to all exports
  • Added RandomGrayscale to README.md pixel-level transforms list
  • Updated torchvision documentation links for flip transforms
albumentations/augmentations/tk/transform.py
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ternaus - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Nov 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.33%. Comparing base (b1a79c2) to head (9b30139).
Report is 262 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2128       +/-   ##
=========================================
+ Coverage      0   90.33%   +90.33%     
=========================================
  Files         0       48       +48     
  Lines         0     7812     +7812     
=========================================
+ Hits          0     7057     +7057     
- Misses        0      755      +755     

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

@ternaus ternaus merged commit 03ee7ec into main Nov 9, 2024
16 checks passed
@ternaus ternaus deleted the add_random_grayscale branch November 9, 2024 02:33
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.

[New transform] Add RandomGRayscale
1 participant