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

Removed deprecations from CenterCrop #2233

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Jan 7, 2025

Summary by Sourcery

Enhancements:

  • Remove deprecated parameters from CenterCrop

Copy link
Contributor

sourcery-ai bot commented Jan 7, 2025

Reviewer's Guide by Sourcery

This PR removes deprecated arguments from the CenterCrop transform. The deprecated arguments pad_mode, pad_cval, and pad_cval_mask are replaced by border_mode, fill, and fill_mask, respectively. A validator function that issued warnings about the deprecations was also removed.

Class diagram showing changes to InitSchema class

classDiagram
    class InitSchema {
        +height: int
        +width: int
        +pad_if_needed: bool
        +pad_position: PositionType
        +border_mode: BorderModeType
        +fill: ColorType
        +fill_mask: ColorType
        -pad_mode: BorderModeType [REMOVED]
        -pad_cval: ColorType [REMOVED]
        -pad_cval_mask: ColorType [REMOVED]
        -validate_dimensions() [REMOVED]
    }
    note for InitSchema "Removed deprecated parameters
and validation method"
Loading

File-Level Changes

Change Details Files
Removed deprecated arguments and validator
  • Removed the deprecated arguments pad_mode, pad_cval, and pad_cval_mask from the InitSchema class.
  • Removed the validator function that checked for the deprecated arguments and issued warnings.
  • Updated the __init__ method signature to remove the deprecated arguments.
  • Replaced usages of deprecated arguments with their updated counterparts within the class methods.
albumentations/augmentations/crops/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 - here's some feedback:

Overall Comments:

  • Please document this breaking change in the changelog/release notes, as removing these deprecated parameters will affect users who haven't yet updated to the new parameter names.
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 Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.60%. Comparing base (b1a79c2) to head (c937ad0).
Report is 339 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2233       +/-   ##
=========================================
+ Coverage      0   89.60%   +89.60%     
=========================================
  Files         0       50       +50     
  Lines         0     9205     +9205     
=========================================
+ Hits          0     8248     +8248     
- Misses        0      957      +957     

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

@ternaus ternaus merged commit 599cbcf into main Jan 7, 2025
16 checks passed
@ternaus ternaus deleted the remove_deprecated_center_crop branch January 7, 2025 12:34
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