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

Fix warning in AdditiveNoise #2271

Merged
merged 6 commits into from
Jan 14, 2025
Merged

Fix warning in AdditiveNoise #2271

merged 6 commits into from
Jan 14, 2025

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Jan 14, 2025

Fixes: #2270

Summary by Sourcery

Validate noise parameters using the appropriate NoiseParams class and store the validated parameters as a dictionary.

Bug Fixes:

  • Fix a warning caused by incorrect noise parameter validation in AdditiveNoise.

Build:

  • Update ruff pre-commit hook to v0.9.1.

Copy link
Contributor

sourcery-ai bot commented Jan 14, 2025

Reviewer's Guide by Sourcery

This pull request fixes a warning raised by the static type checker ruff by ensuring that noise parameters are validated before being used. It also updates ruff to v0.9.1.

Sequence diagram for noise parameter validation in AdditiveNoise

sequenceDiagram
    participant AN as AdditiveNoise
    participant NP as NoiseParams Classes
    AN->>AN: validate_noise_params()
    Note over AN: Get default params if none provided
    AN->>AN: Add noise_type to params_dict
    AN->>NP: Create NoiseParams object
    NP-->>AN: Return validated params
    AN->>AN: Store validated params as dict
    Note over AN: Return self
Loading

Class diagram for AdditiveNoise parameter validation

classDiagram
    class AdditiveNoise {
        +noise_type: str
        +noise_params: dict
        +validate_noise_params() Self
    }
    class NoiseParams {
        <<interface>>
        +noise_type: str
        +model_dump() dict
    }
    class UniformParams {
        +noise_type: str
    }
    class GaussianParams {
        +noise_type: str
    }
    class PoissonParams {
        +noise_type: str
    }
    class BetaParams {
        +noise_type: str
    }
    NoiseParams <|-- UniformParams
    NoiseParams <|-- GaussianParams
    NoiseParams <|-- PoissonParams
    NoiseParams <|-- BetaParams
    AdditiveNoise ..> NoiseParams: uses
Loading

File-Level Changes

Change Details Files
Validate noise parameters before use
  • Added validation of noise parameters using the appropriate NoiseParams class.
  • Stored the validated noise parameters as a dictionary.
albumentations/augmentations/transforms.py
Updated ruff version
  • Updated ruff from v0.8.6 to v0.9.1 in the pre-commit configuration file.
.pre-commit-config.yaml

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 Jan 14, 2025

Codecov Report

Attention: Patch coverage is 97.56098% with 1 line in your changes missing coverage. Please review.

Project coverage is 89.84%. Comparing base (b1a79c2) to head (e7d4eac).
Report is 376 commits behind head on main.

Files with missing lines Patch % Lines
albumentations/augmentations/blur/functional.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2271       +/-   ##
=========================================
+ Coverage      0   89.84%   +89.84%     
=========================================
  Files         0       50       +50     
  Lines         0     8829     +8829     
=========================================
+ Hits          0     7932     +7932     
- Misses        0      897      +897     
Flag Coverage Δ
ubuntu-py3.12 89.84% <97.56%> (?)

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 5f9260b into main Jan 14, 2025
16 checks passed
@ternaus ternaus deleted the fix_warnings branch January 14, 2025 21:41
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.

Type mismatch in validation of noise_params
1 participant