-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Conversation
Reviewer's Guide by SourceryThis 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 AdditiveNoisesequenceDiagram
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
Class diagram for AdditiveNoise parameter validationclassDiagram
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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAttention: Patch coverage is
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Fixes: #2270
Summary by Sourcery
Validate noise parameters using the appropriate
NoiseParams
class and store the validated parameters as a dictionary.Bug Fixes:
AdditiveNoise
.Build: