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

Add time reverse #2121

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Add time reverse #2121

merged 2 commits into from
Nov 8, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Nov 8, 2024

Fixes: #2119

Summary by Sourcery

Add a new 'TimeReverse' transformation for spectrogram images, which reverses the time axis similar to a horizontal flip. Update documentation to reflect this addition and include tests to verify its functionality.

New Features:

  • Introduce a new transformation called 'TimeReverse' for spectrogram images, which reverses the time axis, analogous to a horizontal flip in image processing.

Enhancements:

  • Update the README to include the new 'TimeReverse' transformation in the list of available spatial-level transforms.

Tests:

  • Add test cases for the new 'TimeReverse' transformation to ensure its correct functionality.

Copy link
Contributor

sourcery-ai bot commented Nov 8, 2024

Reviewer's Guide by Sourcery

This PR introduces a new TimeReverse transform for spectrogram augmentation, which is implemented as a subclass of HorizontalFlip. The implementation includes necessary test updates and documentation changes. The PR also includes some cleanup in the test_targets.py file by simplifying the DUAL_TARGETS dictionary.

Class diagram for the new TimeReverse transform

classDiagram
    class HorizontalFlip {
        +p: float
        +always_apply: bool | None
    }
    class TimeReverse {
        +p: float
        +always_apply: bool | None
    }
    TimeReverse --|> HorizontalFlip
    note for TimeReverse "TimeReverse is a subclass of HorizontalFlip, providing a semantically meaningful name for spectrograms."
Loading

File-Level Changes

Change Details Files
Added new TimeReverse transform for spectrogram augmentation
  • Created TimeReverse class that inherits from HorizontalFlip
  • Added comprehensive docstring explaining the transform's purpose and usage
  • Implemented initialization with probability and always_apply parameters
albumentations/augmentations/spectrogram/transform.py
Updated tests to include TimeReverse transform
  • Added TimeReverse to the list of test augmentation definitions
  • Included TimeReverse in transform test cases
tests/aug_definitions.py
tests/test_transforms.py
Modified test targets configuration
  • Simplified DUAL_TARGETS dictionary by removing redundant entries
  • Updated default target set in test_dual function to include all target types
tests/test_targets.py
Updated documentation
  • Added TimeReverse to the table of spatial-level transforms
  • Marked TimeReverse as supporting image, mask, bboxes, and keypoints targets
README.md

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 Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.24%. Comparing base (b1a79c2) to head (e8b0561).
Report is 255 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2121       +/-   ##
=========================================
+ Coverage      0   90.24%   +90.24%     
=========================================
  Files         0       47       +47     
  Lines         0     7718     +7718     
=========================================
+ Hits          0     6965     +6965     
- Misses        0      753      +753     

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

@ternaus ternaus merged commit 2a3a18a into main Nov 8, 2024
16 checks passed
@ternaus ternaus deleted the add_time_reverse branch November 8, 2024 20:57
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.

[New Transform] TimeReverse
1 participant