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

Updated downscale #2264

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Updated downscale #2264

merged 1 commit into from
Jan 8, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Jan 8, 2025

Summary by Sourcery

Remove deprecated threshold, var_limit, mean, scale_min, scale_max, and interpolation parameters from Solarize, GaussNoise, and Downscale transforms. Update process_threshold and check_range methods in Solarize and GaussNoise respectively, to handle the changes. Refactor tests accordingly.

Enhancements:

  • Simplified the API of Solarize, GaussNoise, and Downscale transforms by removing deprecated parameters.

Tests:

  • Updated tests to reflect the API changes in Solarize, GaussNoise, and Downscale transforms.

Copy link
Contributor

sourcery-ai bot commented Jan 8, 2025

Reviewer's Guide by Sourcery

This pull request updates the Downscale, Solarize, and GaussNoise augmentations to remove deprecated arguments and use new parameter ranges. It also updates corresponding tests.

Class diagram showing changes to image transformation classes

classDiagram
    class Solarize {
      -threshold_range: tuple[float, float]
      +__init__(threshold_range: tuple[float, float], p: float)
    }
    note for Solarize "Removed deprecated 'threshold' parameter"

    class GaussNoise {
      -std_range: tuple[float, float]
      -mean_range: tuple[float, float]
      -per_channel: bool
      -noise_scale_factor: float
      +__init__(std_range: tuple[float, float], mean_range: tuple[float, float], per_channel: bool, noise_scale_factor: float)
      +apply(img: np.ndarray)
      +get_params_dependent_on_data(data: dict)
    }
    note for GaussNoise "Added support for legacy var_limit and mean parameters"

    class Downscale {
      -scale_range: tuple[float, float]
      -interpolation_pair: InterpolationDict
      +__init__(scale_range: tuple[float, float], interpolation_pair: InterpolationDict)
    }
    note for Downscale "Removed deprecated scale_min, scale_max, and interpolation parameters"
Loading

File-Level Changes

Change Details Files
Updated Solarize augmentation to use threshold_range instead of threshold.
  • Removed the deprecated threshold parameter.
  • Used threshold_range for specifying the solarization threshold.
  • Updated the InitSchema to reflect these changes.
  • Removed the normalization logic for the deprecated threshold parameter from the InitSchema.
albumentations/augmentations/transforms.py
Updated GaussNoise augmentation to use std_range and mean_range instead of var_limit and mean.
  • Removed the deprecated var_limit and mean parameters.
  • Used std_range and mean_range for specifying the standard deviation and mean ranges of the Gaussian noise.
  • Updated the InitSchema to reflect these changes.
  • Added logic to handle the deprecated parameters and convert them to the new ranges.
  • Removed the var_limit attribute from the class.
  • Updated the apply method to use the new ranges.
  • Updated tests to reflect the changes in parameter ranges and expected behavior.
albumentations/augmentations/transforms.py
tests/test_transforms.py
Updated Downscale augmentation to use scale_range instead of scale_min and scale_max, and interpolation_pair instead of interpolation.
  • Removed the deprecated scale_min, scale_max, and interpolation parameters.
  • Used scale_range for specifying the scaling factor range and interpolation_pair for specifying interpolation methods.
  • Updated the InitSchema to reflect these changes.
  • Removed validation logic for deprecated parameters.
  • Removed tests that used the deprecated parameters.
  • Removed test cases for invalid input related to the deprecated parameters.
albumentations/augmentations/transforms.py
tests/test_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 add equivalent tests for the new parameters (especially for Downscale's scale_range and interpolation_pair) to maintain the same level of test coverage for edge cases and different interpolation methods.
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 8, 2025

Codecov Report

Attention: Patch coverage is 80.95238% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.85%. Comparing base (b1a79c2) to head (70d1b4f).
Report is 370 commits behind head on main.

Files with missing lines Patch % Lines
albumentations/augmentations/transforms.py 80.95% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2264       +/-   ##
=========================================
+ Coverage      0   89.85%   +89.85%     
=========================================
  Files         0       50       +50     
  Lines         0     8843     +8843     
=========================================
+ Hits          0     7946     +7946     
- Misses        0      897      +897     
Flag Coverage Δ
ubuntu-py3.12 89.85% <80.95%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@ternaus ternaus merged commit 033f08f into main Jan 8, 2025
16 checks passed
@ternaus ternaus deleted the update_downscale branch January 8, 2025 00:50
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