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

[Benchmark] Refactor sample_requests in benchmark_throughput #3613

Merged
merged 3 commits into from
Apr 4, 2024

Conversation

gty111
Copy link
Contributor

@gty111 gty111 commented Mar 25, 2024

Sample_requests in benchmark_throughput.py is time consuming, because it will tokenize all the prompts and completions by default. But we only use a part of them. So we can generate dataset on the fly instead of tokenizing everything.

time python3 benchmarks/benchmark_throughput.py --dataset ShareGPT_V3_unfiltered_cleaned_split.json --num-prompts 100

Before

Throughput: 10.07 requests/s, 4755.11 tokens/s

real    1m0.832s
user    37m7.098s
sys     1m17.297s

After

Throughput: 11.45 requests/s, 5739.42 tokens/s

real    0m32.236s
user    0m24.767s
sys     0m17.651s

And the difference of throughput can be caused by the random selection.


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
Member

@ywang96 ywang96 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! This change makes sense to me and the time saved definitely adds up if you need to run this script repetitively.

Could you just do a quick run and compare the total number of input & output tokens from default args (1000 prompts) before and after this PR? Ideally we would like to avoid any surprises (I don't think there will be any, but just making sure).

@gty111
Copy link
Contributor Author

gty111 commented Mar 26, 2024

Could you just do a quick run and compare the total number of input & output tokens from default args (1000 prompts) before and after this PR? Ideally we would like to avoid any surprises (I don't think there will be any, but just making sure).

Sure.

Before

# input tokens : 221789
# output toekns : 233978

After

# input tokens : 224365
# output toekns : 231083

@rkooo567
Copy link
Collaborator

I am confused why it affects the e2e throughput? Seems like sampling requests happen before we measure the elapsed time?

@gty111
Copy link
Contributor Author

gty111 commented Mar 26, 2024

I am confused why it affects the e2e throughput? Seems like sampling requests happen before we measure the elapsed time?

Because the requests are randomly sampled, so the test requests before this PR are different from those after this PR (random.sample VS random.shuffle).

@ywang96
Copy link
Member

ywang96 commented Mar 26, 2024

I am confused why it affects the e2e throughput? Seems like sampling requests happen before we measure the elapsed time?

@rkooo567 Request sampling does happen before we measure the elapsed time, but as @gty111 mentioned the set of requests is different now for a given seed since the dataset is randomly shuffled first, then the first N prompts & expected outputs are tokenized to be counted (and passed if needed).

I think since input & output tokens do fall in the same ballpark, this QoL PR is worth merging especially for people who run this script a lot.

@WoosukKwon
Copy link
Collaborator

@ywang96 Can we merge this? Just wondering what blocks the merge.

@ywang96
Copy link
Member

ywang96 commented Apr 4, 2024

@ywang96 Can we merge this? Just wondering what blocks the merge.

@WoosukKwon Yea of course (back then I didn't have the merge permission)

@WoosukKwon
Copy link
Collaborator

@ywang96 I see. 🤣 Please merge this if you think it's ready.

@ywang96
Copy link
Member

ywang96 commented Apr 4, 2024

@zhuohan123 Just FYI this will change the dataset sampling slightly so don't be surprised to see the results change since you have been running this script a lot...

@ywang96 ywang96 enabled auto-merge (squash) April 4, 2024 08:17
@ywang96 ywang96 merged commit b778200 into vllm-project:main Apr 4, 2024
32 checks passed
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request Apr 22, 2024
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