Add random horizontal flip

[ternaus]

Fixes: #2079

Summary by Sourcery

Add RandomHorizontalFlip as an alias for HorizontalFlip to maintain compatibility with torchvision and Kornia APIs, update documentation, and include tests for the new transform.

New Features:

• Introduce RandomHorizontalFlip class as an alias for HorizontalFlip to provide compatibility with torchvision and Kornia APIs.

Documentation:

• Add documentation entry for RandomHorizontalFlip in the README file, including a link to its detailed description.

Tests:

• Add test case for RandomHorizontalFlip in the aug_definitions and test_transforms files to ensure its functionality.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR adds a new RandomHorizontalFlip transform class that serves as an alias for the existing HorizontalFlip transform. The implementation is designed to maintain API compatibility with torchvision and Kornia libraries, making it easier for users to migrate from these libraries to albumentations.

Class diagram for the new RandomHorizontalFlip class

classDiagram
    class RandomHorizontalFlip {
        +float p = 0.5
        +bool|None always_apply
        +_targets: (Targets.IMAGE, Targets.MASK, Targets.BBOXES, Targets.KEYPOINTS)
        +InitSchema InitSchema
        +__init__(p: float = 0.5, always_apply: bool | None = None)
    }
    class HorizontalFlip
    RandomHorizontalFlip --|> HorizontalFlip
    class Targets {
        <<enumeration>>
        IMAGE
        MASK
        BBOXES
        KEYPOINTS
    }
    class BaseTransformInitSchema
    RandomHorizontalFlip ..> BaseTransformInitSchema : uses

Loading

File-Level Changes

Change	Details	Files
Implement RandomHorizontalFlip transform class as an alias for HorizontalFlip	Create new RandomHorizontalFlip class inheriting from HorizontalFlip Add comprehensive docstring with usage examples and references Include warning message recommending direct use of HorizontalFlip Define supported targets (image, mask, bboxes, keypoints) Set default probability to 0.5	albumentations/augmentations/tk/transform.py
Update documentation and tests to include the new transform	Add RandomHorizontalFlip to the README table of spatial transforms Add RandomHorizontalFlip to the test definitions Include RandomHorizontalFlip in transform tests	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 and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟢 Complexity: all looks good
• 🟢 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.34%. Comparing base (b1a79c2) to head (55380b2).
Report is 260 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #2126       +/-   ##
=========================================
+ Coverage      0   90.34%   +90.34%     
=========================================
  Files         0       48       +48     
  Lines         0     7797     +7797     
=========================================
+ Hits          0     7044     +7044     
- Misses        0      753      +753     

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