ImageProcessor - check if input pixel values between 0-255 by amyeroberts · Pull Request #25688 · huggingface/transformers

amyeroberts · 2023-08-23T16:07:12Z

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?

HuggingFaceDocBuilderDev · 2023-08-23T16:25:19Z

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

ArthurZucker

Thanks, left a few nits on the doc!

ArthurZucker · 2023-08-23T16:48:17Z

src/transformers/models/deformable_detr/image_processing_deformable_detr.py

I guess we can also update the doc here

ArthurZucker · 2023-08-23T16:48:56Z

src/transformers/models/deta/image_processing_deta.py

same here I guess

ArthurZucker · 2023-08-23T16:49:05Z

src/transformers/models/detr/image_processing_detr.py

ArthurZucker · 2023-08-23T16:49:22Z

src/transformers/models/glpn/image_processing_glpn.py

ArthurZucker · 2023-08-24T05:17:16Z

src/transformers/models/beit/image_processing_beit.py

        """Preprocesses a single image."""
        # All transformations expect numpy arrays.
        image = to_numpy_array(image)
+        if _is_scaled_image(image) and do_rescale:


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

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.

ArthurZucker · 2023-08-24T05:21:33Z

src/transformers/models/layoutlmv2/image_processing_layoutlmv2.py

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

ArthurZucker · 2023-08-24T05:22:01Z

src/transformers/models/levit/image_processing_levit.py

doc needs to be udpated to?

ArthurZucker · 2023-08-24T05:25:42Z

src/transformers/models/owlvit/image_processing_owlvit.py

docstring can be updated to

ArthurZucker · 2023-08-24T05:26:12Z

src/transformers/models/pix2struct/image_processing_pix2struct.py

Only doc was updated, but no do_rescale exists

ArthurZucker · 2023-08-24T05:27:23Z

src/transformers/models/yolos/image_processing_yolos.py

doc can be updated!

rafaelpadilla

Nice work! 🙂

src/transformers/image_utils.py

src/transformers/models/layoutlmv2/image_processing_layoutlmv2.py

src/transformers/models/vivit/image_processing_vivit.py

rafaelpadilla

Thank you!

amyeroberts · 2023-08-24T16:16:45Z

@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.

…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

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

6eda52f

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

amyeroberts requested review from ArthurZucker and rafaelpadilla August 23, 2023 16:16

ArthurZucker approved these changes Aug 24, 2023

View reviewed changes

rafaelpadilla approved these changes Aug 24, 2023

View reviewed changes

src/transformers/image_utils.py Outdated Show resolved Hide resolved

src/transformers/models/layoutlmv2/image_processing_layoutlmv2.py Outdated Show resolved Hide resolved

amyeroberts added 2 commits August 24, 2023 14:32

Add missing docstrings

15685d5

_is_scale_image -> is_scaled_image

3baa935

amyeroberts commented Aug 24, 2023

View reviewed changes

src/transformers/models/vivit/image_processing_vivit.py Outdated Show resolved Hide resolved

Spelling is hard

8e8bc78

rafaelpadilla approved these changes Aug 24, 2023

View reviewed changes

Tidy up

b0faa48

amyeroberts merged commit 1b2381c into huggingface:main Aug 24, 2023

amyeroberts deleted the check-if-should-rescale branch August 24, 2023 16:24

Conversation

amyeroberts commented Aug 23, 2023

What does this PR do?

Before submitting

Uh oh!

HuggingFaceDocBuilderDev commented Aug 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ArthurZucker left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rafaelpadilla left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rafaelpadilla left a comment

Choose a reason for hiding this comment

Uh oh!

amyeroberts commented Aug 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

HuggingFaceDocBuilderDev commented Aug 23, 2023 •

edited

Loading