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

[QoL fix] [Image processing] Add warning on assumption of channel dim #31364

Merged
merged 6 commits into from
Jun 13, 2024

Conversation

aliencaocao
Copy link
Contributor

@aliencaocao aliencaocao commented Jun 11, 2024

Sometimes the input image can have height or width 1 and in HWC format. One example is if you np.asarray(PIL.Image). The current function to infer channel dim assumes the CHW silently which can cause confusion to users as the image will be wrongly processed as a grayscale image, which will raise further, harder to interpret errors when running through models.

This PR adds a warning when this happens. It also set the channel dim to last if inputs are PIL.Image as they are always in HWC after np.asarray, avoiding ambiguity in this case.

The default behaviour of assuming first dim as the channel has not changed to prevent any breaking changes.

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

@amyeroberts

Use PIL info whenever possible to decide channel axis
Copy link
Collaborator

@amyeroberts amyeroberts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this! Flagging the ambiguous case is a good idea, although I suspect a very rare case (it implies the image has height or width dimension of 1 or 3).

src/transformers/models/siglip/image_processing_siglip.py Outdated Show resolved Hide resolved
Improve warning message
Copy link
Collaborator

@amyeroberts amyeroberts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for iterating!

Just some tweaks and should be ready to merge

src/transformers/image_utils.py Outdated Show resolved Hide resolved
src/transformers/models/siglip/image_processing_siglip.py Outdated Show resolved Hide resolved
src/transformers/image_utils.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@amyeroberts amyeroberts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this warning and iterating on this!

@amyeroberts amyeroberts merged commit 3c4a8dc into huggingface:main Jun 13, 2024
20 checks passed
@aliencaocao aliencaocao deleted the fix-infer-img-dim branch June 13, 2024 10:04
@aliencaocao aliencaocao restored the fix-infer-img-dim branch June 13, 2024 10:04
@aliencaocao aliencaocao deleted the fix-infer-img-dim branch June 13, 2024 10:04
@aliencaocao aliencaocao changed the title [QoL fix] [Image processing] Add warning on assumption of channel dim and avoid infering when inputs are PIL.Image [QoL fix] [Image processing] Add warning on assumption of channel dim Jun 13, 2024
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.

2 participants