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.

Sign up for GitHub

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

Jump to bottom

ImageProcessor - check if input pixel values between 0-255 #25688

Merged
merged 5 commits into from
Aug 24, 2023
Merged

ImageProcessor - check if input pixel values between 0-255 #25688

merged 5 commits into from
Aug 24, 2023

Conversation

amyeroberts
Copy link
Collaborator

What does this PR do?

Adds a warning in the image processor if the user is passing in images that have already had their pixel values rescale between 0 and 1 and do_rescale=True. Additionally adds information in the docstring.

This has caused some confusion and error reports recently, when users have been passing in images that have already been partially transformed.

Related issues: #25195, #24857, #23096

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?

@amyeroberts amyeroberts changed the title Check if pixel values between 0-255 and add doc clarification ImageProcessor - check if input pixel values between 0-255 Aug 23, 2023
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Aug 23, 2023 •
edited
Loading

The documentation is not available anymore as the PR was closed or merged.

ArthurZucker
ArthurZucker approved these changes Aug 24, 2023
View reviewed changes
Copy link
Collaborator

@ArthurZucker ArthurZucker left a comment

Choose a reason for hiding this comment

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

Thanks, left a few nits on the doc!

src/transformers/models/deformable_detr/image_processing_deformable_detr.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

I guess we can also update the doc here

src/transformers/models/deta/image_processing_deta.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

same here I guess

src/transformers/models/detr/image_processing_detr.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

here too!

src/transformers/models/glpn/image_processing_glpn.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

And here

src/transformers/models/beit/image_processing_beit.py Outdated
@@ -236,6 +237,11 @@ def _preprocess_image(
"""Preprocesses a single image."""
# All transformations expect numpy arrays.
image = to_numpy_array(image)
if _is_scaled_image(image) and do_rescale:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you think it makes sense to also set do_rescale = False ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't want to do anything "magic" and surprise the user.

Checking whether the pixels are correct isn't a perfect test, and it'd be modifying the processor behaviour under an assumption.

src/transformers/models/layoutlmv2/image_processing_layoutlmv2.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do was updated but forward does not have do_rescale and check not used

src/transformers/models/levit/image_processing_levit.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

doc needs to be udpated to?

src/transformers/models/owlvit/image_processing_owlvit.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

docstring can be updated to

src/transformers/models/pix2struct/image_processing_pix2struct.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Only doc was updated, but no do_rescale exists

src/transformers/models/yolos/image_processing_yolos.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

doc can be updated!

rafaelpadilla
rafaelpadilla approved these changes Aug 24, 2023
View reviewed changes
Copy link
Contributor

@rafaelpadilla rafaelpadilla left a comment

Choose a reason for hiding this comment

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

Nice work! 🙂

src/transformers/image_utils.py Outdated Show resolved Hide resolved
src/transformers/models/layoutlmv2/image_processing_layoutlmv2.py Outdated Show resolved Hide resolved
rafaelpadilla
rafaelpadilla approved these changes Aug 24, 2023
View reviewed changes
Copy link
Contributor

@rafaelpadilla rafaelpadilla left a comment

Choose a reason for hiding this comment

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

Thank you!

@amyeroberts
Copy link
Collaborator Author

@rafaelpadilla @ArthurZucker Thanks bot for your detailed reviews! I've added the suggested updated: making the function name consistent with others _is_scaled_image -> is_scaled_image and any missing doc updates.

@amyeroberts amyeroberts merged commit 1b2381c into huggingface:main Aug 24, 2023
@amyeroberts amyeroberts deleted the check-if-should-rescale branch August 24, 2023 16:24
parambharat pushed a commit to parambharat/transformers that referenced this pull request Sep 26, 2023
@amyeroberts @parambharat
ImageProcessor - check if input pixel values between 0-255 (huggingfa…
2cc55fb 
…ce#25688)

* Check if pixel values between 0-255 and add doc clarification

* Add missing docstrings

* _is_scale_image -> is_scaled_image

* Spelling is hard

* Tidy up
blbadger pushed a commit to blbadger/transformers that referenced this pull request Nov 8, 2023
@amyeroberts @blbadger
ImageProcessor - check if input pixel values between 0-255 (huggingfa…
3899b60 
…ce#25688)

* Check if pixel values between 0-255 and add doc clarification

* Add missing docstrings

* _is_scale_image -> is_scaled_image

* Spelling is hard

* Tidy up
EduardoPach pushed a commit to EduardoPach/transformers that referenced this pull request Nov 18, 2023
@amyeroberts @EduardoPach
ImageProcessor - check if input pixel values between 0-255 (huggingfa…
00bef62 
…ce#25688)

* Check if pixel values between 0-255 and add doc clarification

* Add missing docstrings

* _is_scale_image -> is_scaled_image

* Spelling is hard

* Tidy up
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ArthurZucker ArthurZucker ArthurZucker approved these changes

@rafaelpadilla rafaelpadilla rafaelpadilla approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@amyeroberts @HuggingFaceDocBuilderDev @rafaelpadilla @ArthurZucker