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 gaussian blur #2144

Merged
merged 2 commits into from
Nov 17, 2024
Merged

Add random gaussian blur #2144

merged 2 commits into from
Nov 17, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Nov 17, 2024

Addresses: #2092

Summary by Sourcery

Add RandomGaussianBlur transform as an alias for GaussianBlur to ensure compatibility with Kornia API, refactor MotionBlur class, update documentation, and add a test case for the new transform.

New Features:

  • Introduce RandomGaussianBlur transform as an alias for GaussianBlur, providing compatibility with Kornia API.

Enhancements:

  • Refactor MotionBlur class to use BlurInitSchema and remove redundant blur limit validation.

Documentation:

  • Add documentation entry for RandomGaussianBlur in README.md.

Tests:

  • Add test case for RandomGaussianBlur in aug_definitions.py.

Copy link
Contributor

sourcery-ai bot commented Nov 17, 2024

Reviewer's Guide by Sourcery

This PR adds a new RandomGaussianBlur transform class that serves as an alias for the existing GaussianBlur transform, providing compatibility with Kornia's API while maintaining the same functionality. The implementation includes parameter mapping between the two naming conventions and adds appropriate documentation and tests.

Class diagram for the new RandomGaussianBlur transform

classDiagram
    class RandomGaussianBlur {
        - ScaleIntType kernel_size
        - ScaleFloatType sigma
        - bool|None always_apply
        - float p
        + RandomGaussianBlur(ScaleIntType kernel_size, ScaleFloatType sigma, bool|None always_apply, float p)
        + get_transform_init_args_names() tuple[str, ...]
    }
    class GaussianBlur {
        <<abstract>>
    }
    RandomGaussianBlur --|> GaussianBlur : Inherits
    note for RandomGaussianBlur "This class is an alias for GaussianBlur with parameter naming for Kornia compatibility."
Loading

File-Level Changes

Change Details Files
Added new RandomGaussianBlur transform class as an alias for GaussianBlur
  • Created new class inheriting from GaussianBlur
  • Mapped 'kernel_size' parameter to 'blur_limit'
  • Mapped 'sigma' parameter to 'sigma_limit'
  • Added deprecation warning encouraging use of GaussianBlur directly
  • Implemented transform initialization schema
albumentations/augmentations/tk/transform.py
Updated documentation and test coverage
  • Added RandomGaussianBlur to the pixel-level transforms list
  • Added RandomGaussianBlur to the test definitions
README.md
tests/aug_definitions.py
Refactored blur transform validation logic
  • Changed MotionBlur to use BlurInitSchema
  • Fixed return type annotation for get_transform_init_args_names
albumentations/augmentations/blur/transforms.py

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: 1 issue found
  • 🟡 Complexity: 1 issue found
  • 🟢 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.

tests/aug_definitions.py Show resolved Hide resolved
albumentations/augmentations/tk/transform.py Show resolved Hide resolved
Copy link

codecov bot commented Nov 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.37%. Comparing base (b1a79c2) to head (e570678).
Report is 276 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2144       +/-   ##
=========================================
+ Coverage      0   90.37%   +90.37%     
=========================================
  Files         0       48       +48     
  Lines         0     8045     +8045     
=========================================
+ Hits          0     7271     +7271     
- Misses        0      774      +774     

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

@ternaus ternaus merged commit a0ff18c into main Nov 17, 2024
16 checks passed
@ternaus ternaus deleted the add_RandomGaussianBlur branch November 17, 2024 00:26
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.

1 participant