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 plankian jitter #1976

Merged
merged 4 commits into from
Oct 8, 2024
Merged

Fix plankian jitter #1976

merged 4 commits into from
Oct 8, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Oct 8, 2024

Fixes: #1968

Summary by Sourcery

Fix the Planckian jitter function to handle out-of-range temperatures by clamping them to valid values, enhance interpolation logic, and add comprehensive tests for edge cases and consistency.

Bug Fixes:

  • Fix the Planckian jitter function to correctly handle temperature values outside the defined range by clamping them to the nearest valid temperature.

Enhancements:

  • Improve the Planckian jitter function by ensuring linear interpolation between the closest valid temperatures, and handling edge cases where the temperature is at or near the minimum or maximum values.

Tests:

  • Add new test cases for Planckian jitter to cover edge cases, interpolation, consistency, and invalid mode handling.

Copy link
Contributor

sourcery-ai bot commented Oct 8, 2024

Reviewer's Guide by Sourcery

This pull request addresses the issue of plankian jitter in the albumentations library. The changes focus on improving the robustness and correctness of the planckian_jitter function, adding comprehensive test cases, and refining the PlanckianJitter transform class. The modifications ensure proper handling of edge cases, interpolation, and consistency across different modes and temperature ranges.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Improved planckian_jitter function implementation
  • Added temperature clamping to ensure values are within the valid range
  • Refined interpolation logic for temperature coefficients
  • Removed unnecessary clipping of values greater than 1
albumentations/augmentations/functional.py
Updated PlanckianJitter transform class
  • Modified constant values to use dynamic min and max temperatures from PLANCKIAN_COEFFS
  • Refined get_params method to ensure temperature is within valid range
  • Improved sampling logic for both uniform and gaussian methods
albumentations/augmentations/transforms.py
Added comprehensive test cases for planckian_jitter
  • Implemented edge case tests for various temperatures
  • Added interpolation tests
  • Included consistency tests for different modes
  • Created a test for invalid mode handling
tests/test_functional.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 and they look great!

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 Outdated Show resolved Hide resolved
tests/test_functional.py Show resolved Hide resolved
tests/test_functional.py Show resolved Hide resolved
@ternaus ternaus merged commit 1d71574 into main Oct 8, 2024
17 checks passed
@ternaus ternaus deleted the fix_plankian_jitter branch October 8, 2024 01:04
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.

PlanckianJitter gaussian sampling not working
1 participant