Skip to content

[Bugfix] Fix crashing for multimodal when image passed with height == 1 #9141

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

Closed

Conversation

Pernekhan
Copy link
Contributor

vLLM is failing when the image with Wx1 dimensions are passed. This is because of transformers library throwing exceptions for this cases.

Here is the log that vLLM was crashing:

INFO 10-07 06:31:28 engine.py:288] Added request chat-fadb404935fa4be686a7bb42081775c4.
The channel dimension is ambiguous. Got image shape (1, 499, 3). Assuming channels are the first dimension.
ERROR 10-07 06:31:28 image.py:59] Failed to process image ([<PIL.Image.Image image mode=RGB size=499x1 at 0x7FA654695DF0>])
ERROR 10-07 06:31:28 engine.py:157] ValueError('mean must have 1 elements if it is an iterable, got 3')
ERROR 10-07 06:31:28 engine.py:157] Traceback (most recent call last):
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/engine/multiprocessing/engine.py", line 155, in start
ERROR 10-07 06:31:28 engine.py:157]     self.run_engine_loop()
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/engine/multiprocessing/engine.py", line 218, in run_engine_loop
ERROR 10-07 06:31:28 engine.py:157]     request_outputs = self.engine_step()
ERROR 10-07 06:31:28 engine.py:157]                       ^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/engine/multiprocessing/engine.py", line 236, in engine_step
ERROR 10-07 06:31:28 engine.py:157]     raise e
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/engine/multiprocessing/engine.py", line 227, in engine_step
ERROR 10-07 06:31:28 engine.py:157]     return self.engine.step()
ERROR 10-07 06:31:28 engine.py:157]            ^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/engine/llm_engine.py", line 1264, in step
ERROR 10-07 06:31:28 engine.py:157]     outputs = self.model_executor.execute_model(
ERROR 10-07 06:31:28 engine.py:157]               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/executor/gpu_executor.py", line 130, in execute_model
ERROR 10-07 06:31:28 engine.py:157]     output = self.driver_worker.execute_model(execute_model_req)
ERROR 10-07 06:31:28 engine.py:157]              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/worker/worker_base.py", line 303, in execute_model
ERROR 10-07 06:31:28 engine.py:157]     inputs = self.prepare_input(execute_model_req)
ERROR 10-07 06:31:28 engine.py:157]              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/worker/worker_base.py", line 291, in prepare_input
ERROR 10-07 06:31:28 engine.py:157]     return self._get_driver_input_and_broadcast(execute_model_req)
ERROR 10-07 06:31:28 engine.py:157]            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/worker/worker_base.py", line 253, in _get_driver_input_and_broadcast
ERROR 10-07 06:31:28 engine.py:157]     self.model_runner.prepare_model_input(
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/worker/enc_dec_model_runner.py", line 251, in prepare_model_input
ERROR 10-07 06:31:28 engine.py:157]     model_input = self._prepare_model_input_tensors(
ERROR 10-07 06:31:28 engine.py:157]                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/worker/model_runner.py", line 1141, in _prepare_model_input_tensors
ERROR 10-07 06:31:28 engine.py:157]     builder.add_seq_group(seq_group_metadata)
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/worker/model_runner.py", line 728, in add_seq_group
ERROR 10-07 06:31:28 engine.py:157]     per_seq_group_fn(inter_data, seq_group_metadata)
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/worker/model_runner.py", line 660, in _compute_multi_modal_input
ERROR 10-07 06:31:28 engine.py:157]     mm_kwargs = self.multi_modal_input_mapper(mm_data)
ERROR 10-07 06:31:28 engine.py:157]                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/multimodal/registry.py", line 126, in map_input
ERROR 10-07 06:31:28 engine.py:157]     input_dict = plugin.map_input(model_config, data_value)
ERROR 10-07 06:31:28 engine.py:157]                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/multimodal/base.py", line 279, in map_input
ERROR 10-07 06:31:28 engine.py:157]     return mapper(InputContext(model_config), data, **mm_processor_kwargs)
ERROR 10-07 06:31:28 engine.py:157]            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/vllm/multimodal/image.py", line 56, in _default_input_mapper
ERROR 10-07 06:31:28 engine.py:157]     .preprocess(data, return_tensors="pt") \
ERROR 10-07 06:31:28 engine.py:157]      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/transformers/models/mllama/image_processing_mllama.py", line 711, in preprocess
ERROR 10-07 06:31:28 engine.py:157]     image = self.normalize(
ERROR 10-07 06:31:28 engine.py:157]             ^^^^^^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/transformers/image_processing_utils.py", line 111, in normalize
ERROR 10-07 06:31:28 engine.py:157]     return normalize(
ERROR 10-07 06:31:28 engine.py:157]            ^^^^^^^^^^
ERROR 10-07 06:31:28 engine.py:157]   File "/usr/local/lib/python3.12/dist-packages/transformers/image_transforms.py", line 392, in normalize
ERROR 10-07 06:31:28 engine.py:157]     raise ValueError(f"mean must have {num_channels} elements if it is an iterable, got {len(mean)}")
ERROR 10-07 06:31:28 engine.py:157] ValueError: mean must have 1 elements if it is an iterable, got 3
CRITICAL 10-07 06:31:28 launcher.py:99] MQLLMEngine is already dead, terminating server process


PR Checklist (Click to Expand)

Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Doc] for documentation fixes and improvements.
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
  • [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
  • [Kernel] for changes affecting CUDA kernels or other compute kernels.
  • [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
  • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

  • We adhere to Google Python style guide and Google C++ style guide.
  • Pass all linter checks. Please use format.sh to format your code.
  • The code need to be well-documented to ensure future contributors can easily understand the code.
  • Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
  • Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.

Adding or changing kernels

Each custom kernel needs a schema and one or more implementations to be registered with PyTorch.

  • Make sure custom ops are registered following PyTorch guidelines: Custom C++ and CUDA Operators and The Custom Operators Manual
  • Custom operations that return Tensors require meta-functions. Meta-functions should be implemented and registered in python so that dynamic dims can be handled automatically. See above documents for a description of meta-functions.
  • Use torch.libary.opcheck() to test the function registration and meta-function for any registered ops. See tests/kernels for examples.
  • When changing the C++ signature of an existing op, the schema must be updated to reflect the changes.
  • If a new custom type is needed, see the following document: Custom Class Support in PT2.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

  • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
  • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
  • After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
  • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

Copy link

github-actions bot commented Oct 7, 2024

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@Pernekhan Pernekhan force-pushed the fix-image-failure-cases branch 3 times, most recently from abe1a16 to de51e4c Compare October 8, 2024 00:01
@Pernekhan Pernekhan marked this pull request as ready for review October 8, 2024 00:04
@Pernekhan Pernekhan force-pushed the fix-image-failure-cases branch from de51e4c to d04a106 Compare October 8, 2024 00:09
@DarkLight1337
Copy link
Member

Hmm, wouldn't it be better to fix this issue on the HF side? This seems like a bandaid solution.

@Pernekhan
Copy link
Contributor Author

Hmm, wouldn't it be better to fix this issue on the HF side? This seems like a bandaid solution.

of course, the best way is to fix it from HF side, but for people who can't wait the fix from HF side, they can use this commit I guess.

I've created an issue in HF: huggingface/transformers#34029
Let's track this and maybe upvote/comment in the issue for better prioritization in hf

@sfyumi sfyumi mentioned this pull request Oct 14, 2024
1 task
@hmellor
Copy link
Member

hmellor commented Feb 4, 2025

@Pernekhan did you find time to fix this on the HF side?

@Pernekhan
Copy link
Contributor Author

@hmellor haven’t got a chance. Are you facing this problem?

@hmellor
Copy link
Member

hmellor commented Feb 4, 2025

I'm not facing it myself, no. Just maintaining vLLM :)

@Pernekhan
Copy link
Contributor Author

I will close this issue as we’ve decided to implement the fix (eventually) in HF

@Pernekhan Pernekhan closed this Feb 4, 2025
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.

3 participants