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 random perspective #2129

Merged
merged 5 commits into from
Nov 9, 2024
Merged

Add random perspective #2129

merged 5 commits into from
Nov 9, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Nov 9, 2024

Fixes: #2081

Summary by Sourcery

Add a new RandomPerspective transformation to the library, providing an alias for the existing Perspective transform to improve compatibility with torchvision and Kornia APIs. Update documentation and tests to reflect this addition and enhance clarity on API compatibility.

New Features:

  • Introduce a new RandomPerspective transformation as an alias for the existing Perspective transform, enhancing compatibility with torchvision and Kornia APIs.

Enhancements:

  • Improve documentation for existing transformations to clarify compatibility with torchvision and Kornia APIs.

Documentation:

  • Add RandomPerspective to the list of available spatial-level transforms in the README.

Tests:

  • Update test cases to include the new RandomPerspective transformation, ensuring its functionality and compatibility.

Copy link
Contributor

sourcery-ai bot commented Nov 9, 2024

Reviewer's Guide by Sourcery

This PR adds a new RandomPerspective transform class that serves as an alias for the existing Perspective transform, maintaining API compatibility with torchvision and Kornia libraries. The implementation includes parameter mapping between the different APIs and proper integration with the existing codebase.

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

File-Level Changes

Change Details Files
Added new RandomPerspective transform class
  • Created RandomPerspective class that inherits from Perspective
  • Implemented parameter mapping from torchvision/Kornia style to Albumentations style
  • Added input validation using Pydantic schema
  • Added comprehensive docstring with usage examples and references
  • Added support for image, mask, keypoints, and bboxes targets
albumentations/augmentations/tk/transform.py
Updated test suite and documentation
  • Added RandomPerspective to the list of augmentations in tests
  • Updated README with new transform in the spatial transforms table
  • Added RandomPerspective to mask target exclusion list
  • Adjusted keypoint matching tolerance in transform tests
tests/aug_definitions.py
tests/test_core.py
tests/test_transforms.py
README.md
Code cleanup and consistency improvements
  • Removed redundant always_apply parameter from transform initializations
  • Updated compatibility notes in existing transform classes
  • Added new imports for required types and classes
albumentations/augmentations/tk/transform.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: all looks good
  • 🟢 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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

tests/aug_definitions.py Show resolved Hide resolved
albumentations/augmentations/tk/transform.py Show resolved Hide resolved
Copy link

codecov bot commented Nov 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.37%. Comparing base (b1a79c2) to head (0cdc4bb).
Report is 263 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2129       +/-   ##
=========================================
+ Coverage      0   90.37%   +90.37%     
=========================================
  Files         0       48       +48     
  Lines         0     7827     +7827     
=========================================
+ Hits          0     7074     +7074     
- Misses        0      753      +753     

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

@ternaus ternaus merged commit c2a3e05 into main Nov 9, 2024
16 checks passed
@ternaus ternaus deleted the add_random_perspective branch November 9, 2024 03:22
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.

[Feature Request] Add ReandomPerspective
1 participant