# Pass Image color channels information to Transformers

[davychxn]

Background:
In Huggingface Transformers' image processor, e.g. CLIPImageProcessor, the constructor requires input of input_data_format, which gives the Image's color channels being in the first or the last position in its shape.

For example, if an image's shape is (512, 512, 3), it means its resolution is 512*512 pixels, and it has RBG, 3 color channels. In this case, input_data_format is ImageChannelDimension.LAST or ChannelDimension.LAST in Transformers.

Sometimes, people would use customized Image format in a shape of (3, 512, 512) for performance purpose. Transformers requires users to point it out, or it would infer to tell it from its shape.

Generally, an image would have 1 or 3 color channels representing Gray or RGB. So, the inferring algorithm in Transformers looks for 1 or 3 values in the image's shape.

If your input images are in the shape of (3, xxx, 1) or (1, xxx, 3), the inferring algorithm would get confused, and raise following exception: 'The channel dimension is ambiguous. Got image shape (1, xxx, 3). Assuming channels are the first dimension.' 'ValueError: mean must have 1 elements if it is an iterable, got 3'

Fix:

1. Add a class ImageChannelDimension to define 2 possible Image color channels position in an Image's shape
2. Input this information in model.encode method, and pass it to Tokenizer and image processor from Transformers.

[davychxn]

How to reproduce the issue:
Use this image:

Save above image as "header-separator.png".

Run the official example:

from sentence_transformers import SentenceTransformer, util
from PIL import Image

#Load CLIP model
model = SentenceTransformer('clip-ViT-B-32')

#Encode an image:
img_emb = model.encode(Image.open('header-separator.png'))

[davychxn]

With the fix we can tokenize image in the shape of (xxx, xxx, 3) like:

from sentence_transformers import SentenceTransformer, util
...
// By default
model.encode(Image.open('image.png'))
// or
model.encode(Image.open('image.png'), input_data_format=util.ImageChannelDimension.LAST)

And tokenize image in the shape of (3, xxx, xxx) like:

model.encode(optimizeImage(Image.open('image.png')), input_data_format=util.ImageChannelDimension.FIRST)

[davychxn]

@tomaarsen Hi Tom, would you help to check my PR? Thank you.

[davychxn]

@fpgmaas Hi Florian, would you take some time to review my PR? Thank you.

[fpgmaas]

This should probably be an Enum

[davychxn]

This class is copied from Transformers' repo. It is defined like this there. Because the string defined in the class is needed by Transformers' image-processor. If we use Enum, I think, we'll get integer values? And we need to convert to string before passing to Transformers?

[fpgmaas]

Maybe input_data_format is not an appropriate name? In my opinion the name should be more specific. Maybe just image_channel_dimension?

[fpgmaas]

Hey @davychxn , I am not a maintainer of the project and I lack in-depth knowledge to judge your proposed changes, so I'm afraid I cannot approve the PR. However, I left a few review comments anyways to help the PR along.

[davychxn]

Maybe input_data_format is not an appropriate name? In my opinion the name should be more specific. Maybe just image_channel_dimension?

@fpgmaas Fixed.

[davychxn]

Hey @davychxn , I am not a maintainer of the project and I lack in-depth knowledge to judge your proposed changes, so I'm afraid I cannot approve the PR. However, I left a few review comments anyways to help the PR along.

Thank you for your great help, Florian. I'll try to reach Tom separately.

[davychxn]

Hi @tomaarsen , would you review my change? Any improvement we'll need here? Thank you.

[davychxn]

This PR is needed while writing code to this project: https://github.com/Immortalise/SearchAnything
The issue can crash the code there, I had to use a hard-coded workaround.

I submitted the initial fix PR to Transformers, but @amyeroberts suggested fix in your repo. The closed PR is: huggingface/transformers#31950