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

Can pass images as np.array (num_images, height, width, num_channels) #2185

Merged
merged 5 commits into from
Dec 12, 2024

Conversation

ternaus
Copy link
Collaborator

@ternaus ternaus commented Dec 11, 2024

Summary by Sourcery

Allow images to be passed as numpy arrays with shape (num_images, height, width, num_channels) to transformation functions, ensuring output format consistency. Update tests to cover both list and numpy array input formats.

New Features:

  • Enable passing images as numpy arrays with shape (num_images, height, width, num_channels) to the transformation functions.

Enhancements:

  • Ensure that transformed images maintain the same format as the input, whether as a list or a numpy array.

Tests:

  • Add parameterized tests to verify that transformations work correctly with both list and numpy array formats for images.

Copy link
Contributor

sourcery-ai bot commented Dec 11, 2024

Reviewer's Guide by Sourcery

This PR adds support for passing multiple images as a numpy array with shape (num_images, height, width, num_channels) instead of only supporting lists of images. The implementation modifies the core transform interface to handle both array and list formats while maintaining backward compatibility.

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

File-Level Changes

Change Details Files
Added support for numpy array input format in the transform interface
  • Modified apply_to_images to handle both numpy arrays and lists of images
  • Added input validation for numpy array format (3D or 4D arrays)
  • Ensured output format matches input format (array or list)
  • Added memory contiguity requirement for numpy array outputs
albumentations/core/transforms_interface.py
Updated data validation in composition module
  • Modified _check_multi_data to support numpy array input format
  • Added validation for array dimensions (3D or 4D)
  • Updated documentation to reflect new input format options
albumentations/core/composition.py
Added tests for numpy array input format
  • Extended test_images_as_target to handle both array and list formats
  • Added verification of output format matching input format
  • Added checks for array contiguity
tests/test_core.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: 3 issues found
  • 🟢 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.

tests/test_core.py Outdated Show resolved Hide resolved
tests/test_core.py Outdated Show resolved Hide resolved
tests/test_core.py Show resolved Hide resolved
tests/test_core.py Show resolved Hide resolved
tests/test_core.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 11, 2024

Codecov Report

Attention: Patch coverage is 73.33333% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.76%. Comparing base (b1a79c2) to head (59a993e).
Report is 307 commits behind head on main.

Files with missing lines Patch % Lines
albumentations/augmentations/transforms.py 66.66% 2 Missing ⚠️
albumentations/core/composition.py 60.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##           main    #2185       +/-   ##
=========================================
+ Coverage      0   89.76%   +89.76%     
=========================================
  Files         0       47       +47     
  Lines         0     8448     +8448     
=========================================
+ Hits          0     7583     +7583     
- Misses        0      865      +865     

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

@ternaus ternaus merged commit b86942a into main Dec 12, 2024
16 checks passed
@ternaus ternaus deleted the images_np_array branch December 12, 2024 02:08
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.

1 participant