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

[bug fix][dist] Handle the case that a dict entry is a list of tensors. #6925

Closed
wants to merge 6 commits into from

Conversation

xwjiang2010
Copy link
Contributor

Fixes #5905 (comment)

Handles the case like tensor_dict["multi_modal_kwargs"]["pixel_values"] = a_list_of_tensors


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.

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

👋 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 consists a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of default ones by unblocking the steps in your fast-check build on Buildkite UI.

Once the PR is approved and ready to go, please make sure to run full CI as it is required to merge (or just use auto-merge).

To run full CI, you can do one of these:

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

🚀

@DarkLight1337
Copy link
Member

Can this support arbitrary layers of nested lists? This will be required for supporting multi-image inputs in the future.

@xwjiang2010
Copy link
Contributor Author

hmm, @DarkLight1337
actually let me try making it more generic than this. So that we can handle nested dict and list.

@xwjiang2010
Copy link
Contributor Author

yeah, @DarkLight1337 was just thinking of this and saw your comment :)
will try that so that we don't run into this issue again and again.

@xwjiang2010
Copy link
Contributor Author

This will be required for supporting multi-image inputs in the future.

Give me a concrete example?

@njhill
Copy link
Member

njhill commented Jul 30, 2024

Could we stack the tensors in this case? To also reduce the number of broadcast ops…

@DarkLight1337
Copy link
Member

DarkLight1337 commented Jul 30, 2024

This will be required for supporting multi-image inputs in the future.

Give me a concrete example?

Please first read my comment in the RFC.

Consider LLaVA-NeXT, which currently accepts shape [B, M, C, H, W] where M is the number of patches/crops. If M is different for each B, the output becomes a list of B elements each with shape [M, C, H, W].

When we support multi-image inputs, LLaVA-NeXT would then accept [B, N, M, C, H, W] where N is the number of input images. In this case, since M can also be different for each N, we need a 2-D nested list (over the B and N dimensions) since the value of M can be different for each combination of B and N.

@DarkLight1337
Copy link
Member

Could we stack the tensors in this case? To also reduce the number of broadcast ops…

I guess this is technically possible but also quite complicated. We would have to first identify the tensors with a common shape and concatenate them for broadcasting, then afterwards split them back into the original shapes.

Copy link
Member

@youkaichao youkaichao left a comment

Choose a reason for hiding this comment

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

Please don't make the logic too complicated. If this is just CPU tensor, you can directly treat it as opaque python object and broadcast it.

If it is GPU tensor, try to avoid broadcasting GPU tensors.

@DarkLight1337
Copy link
Member

DarkLight1337 commented Jul 30, 2024

If this is just CPU tensor, you can directly treat it as opaque python object and broadcast it.
If it is GPU tensor, try to avoid broadcasting GPU tensors.

Didn't know this. Let me try deferring the device move until after the broadcast then. Hope that this would simplify the logic.

@DarkLight1337
Copy link
Member

I have updated #6836 to fix the issue while also simplifying the code.

@xwjiang2010 xwjiang2010 marked this pull request as draft July 30, 2024 16:27
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.

4 participants