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

[Feature] Update benchmark_throughput.py to support image input #9851

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

lk-chen
Copy link

@lk-chen lk-chen commented Oct 30, 2024

Update benchmark_throughput to support image input. Tested with ShareGPT4V

on top of #9779 to tackle #9778

BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE


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!

cc @comaniac @ywang96

Linkun Chen and others added 9 commits October 29, 2024 13:22
* Give the request tuple a name
* Add helper message for --dataset flag

Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
* This is preparation to support multi-modality input, by reusing existing TextPrompt structure
* no significant metrics diff, see below
 - before: Throughput: 13.99 requests/s, 2933.11 total tokens/s, 2758.10 output tokens/s
 - after: Throughput: 13.99 requests/s, 2932.69 total tokens/s, 2757.70 output tokens/s
 - test command: `python benchmarks/benchmark_throughput.py --model mistral-community/pixtral-12b  --max-model-len=8192 --dataset ../sharegpt4v_instruct_gpt4-vision_cap100k.json`

Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
dbg
Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
This reverts commit 2623fea.

Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
This reverts commit eb6e01b.

Signed-off-by: Linkun Chen <github+anyscale@lkchen.net>
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 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.

🚀

Copy link
Collaborator

@comaniac comaniac left a comment

Choose a reason for hiding this comment

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

Otherwise LGTM. cc @ywang96 @DarkLight1337


is_multi_model = any(
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
is_multi_model = any(
is_multi_modal = any(

Comment on lines +338 to +339
print("\033[91mWARNING\033[0m: Multi-modal request detected. "
"The following metrics is not accurate.")
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
print("\033[91mWARNING\033[0m: Multi-modal request detected. "
"The following metrics is not accurate.")
print("\033[91mWARNING\033[0m: Multi-modal request detected. "
"The following metrics is not accurate because image tokens are not counted. See vllm-project/vllm/issues/9778 for details")

Comment on lines +92 to +93
assert isinstance(image_path,
str), "Only support single image input"
Copy link
Collaborator

Choose a reason for hiding this comment

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

We could make a TODO to support multi-image inputs.


Args:
question: The input question text to wrap with special tokens
model: The name of the model being used, to determine which special tokens to add
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please fix the format by running bash format.sh locally (and probably need to manually solve line too long errors in comments).

Comment on lines +55 to +58
model = model.lower()
if "pixtral" in model:
return f"<s>[INST]{question}\n[IMG][/INST]"
raise ValueError(f"Unsupported model {model}")
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is fine for now, but as a follow up we could consider leveraging HF tokenizer's chat template.

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.

2 participants