Add frequecny masking

[ternaus]

Fixes: #2075

Summary by Sourcery

Add a new FrequencyMasking transform to the spectrogram augmentations, update documentation, and include tests for the new feature.

New Features:

• Introduce FrequencyMasking transform to apply frequency domain masking on spectrograms, enhancing model robustness against frequency variations.

Documentation:

• Add FrequencyMasking to the list of available transforms in the README documentation.

Tests:

• Include tests for the new FrequencyMasking transform to ensure its correct functionality.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR adds a new FrequencyMasking transform class that implements frequency domain masking for spectrograms, based on the SpecAugment paper. The implementation extends the existing XYMasking base class, configuring it specifically for frequency masking with a single vertical mask.

Class diagram for FrequencyMasking

classDiagram
    class XYMasking {
        <<abstract>>
        +float p
        +bool|None always_apply
        +int fill_value
        +int|None mask_fill_value
        +tuple mask_y_length
        +int num_masks_x
        +int num_masks_y
        +get_transform_init_args_names() tuple[str, ...]
    }
    class FrequencyMasking {
        +int freq_mask_param
        +float p
        +bool|None always_apply
        +get_transform_init_args_names() tuple[str, ...]
    }
    XYMasking <|-- FrequencyMasking
    note for FrequencyMasking "Specialized for frequency masking with a single vertical mask"

Loading

File-Level Changes

Change	Details	Files
Added new FrequencyMasking transform class for spectrogram augmentation	Implemented FrequencyMasking as a specialized version of XYMasking Added configuration for single vertical mask with customizable frequency mask parameter Included warning message about using XYMasking directly for more flexibility Added comprehensive docstring with usage instructions and references	albumentations/augmentations/spectrogram/transform.py
Updated documentation and tests to include the new FrequencyMasking transform	Added FrequencyMasking to the README.md transform table Added FrequencyMasking to the test augmentation definitions Removed TimeMasking from test_transforms.py's test case	README.md tests/aug_definitions.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @ternaus - I've reviewed your changes - here's some feedback:

Overall Comments:

• It looks like TimeMasking was accidentally removed from test_transforms.py - please restore this test case while adding the new FrequencyMasking test.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.25%. Comparing base (b1a79c2) to head (1175866).
Report is 257 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #2123       +/-   ##
=========================================
+ Coverage      0   90.25%   +90.25%     
=========================================
  Files         0       47       +47     
  Lines         0     7748     +7748     
=========================================
+ Hits          0     6993     +6993     
- Misses        0      755      +755     

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