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 image compression #2256

Merged
merged 5 commits into from
Jan 7, 2025
Merged

Updated image compression #2256

merged 5 commits into from
Jan 7, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Jan 7, 2025

Summary by Sourcery

Remove deprecated quality_lower and quality_upper parameters from ImageCompression transform, and update tests accordingly.

Enhancements:

  • Simplified the ImageCompression transform by removing deprecated parameters.

Tests:

  • Updated tests to reflect the removal of deprecated parameters in ImageCompression transform.

Copy link
Contributor

sourcery-ai bot commented Jan 7, 2025

Reviewer's Guide by Sourcery

This pull request refactors the ImageCompression transform to use quality_range instead of the deprecated quality_lower and quality_upper parameters. It simplifies the initialization logic and removes the associated deprecation warnings. The tests have been updated to reflect these changes.

Sequence diagram for simplified image compression process

sequenceDiagram
    participant C as Client
    participant IC as ImageCompression
    participant F as fmain
    C->>IC: apply(image)
    IC->>IC: get_params()
    Note over IC: Generate random quality
    Note over IC: Determine image type (.jpg/.webp)
    IC->>F: image_compression(img, quality, image_type)
    F-->>C: compressed_image
Loading

Class diagram showing changes to ImageCompression initialization schema

classDiagram
    class InitSchema {
        +quality_range: tuple[int, int]
        +compression_type: Literal["jpeg", "webp"]
    }
    note for InitSchema "Removed deprecated quality_lower and quality_upper fields
Simplified validation logic"
Loading

File-Level Changes

Change Details Files
Refactored ImageCompression to use quality_range.
  • Removed deprecated quality_lower and quality_upper parameters from ImageCompression.
  • Updated the validation logic to use quality_range.
  • Removed tests related to deprecated parameters.
  • Simplified the get_params method by directly assigning the image type based on compression_type.
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 back test cases for the current initialization parameters (quality_range and compression_type) to maintain test coverage of the core functionality.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

albumentations/augmentations/transforms.py Show resolved Hide resolved
Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.90%. Comparing base (b1a79c2) to head (ebc37b8).
Report is 362 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2256       +/-   ##
=========================================
+ Coverage      0   89.90%   +89.90%     
=========================================
  Files         0       50       +50     
  Lines         0     8963     +8963     
=========================================
+ Hits          0     8058     +8058     
- Misses        0      905      +905     
Flag Coverage Δ
ubuntu-py3.12 89.90% <100.00%> (?)

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 8c983af into main Jan 7, 2025
16 checks passed
@ternaus ternaus deleted the update_image_compression branch January 7, 2025 22:06
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