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

[Misc] Enhance prefix-caching benchmark tool #6568

Merged

Conversation

Jeffwan
Copy link
Contributor

@Jeffwan Jeffwan commented Jul 19, 2024

I update the prefix-caching benchmark tool with following new features

  • Added support for using real ShareGPT data for testing.
  • Introduced new parameters to duplicate prompts for more extensive testing.
  • Implemented benchmark support against prompts with varying input token lengths.
  • Added functionality to sort or shuffle data, simulating real-world traffic patterns.

This update allows for more accurate and flexible performance testing on the prefix cache

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.

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!

- Added support for using real ShareGPT data for testing.
- Introduced new parameters to duplicate prompts for more extensive testing.
- Implemented benchmark support against prompts with varying input token lengths.
- Added functionality to sort or shuffle data, simulating real-world traffic patterns.

This update allows for more accurate and flexible performance testing on the prefix cache
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.

🚀

@hibukipanim
Copy link

hibukipanim commented Jul 19, 2024

amazing!

  • can you please see if this can reproduce the issue reported here: [Bug]: prefix-caching: inconsistent completions #5543 ?
  • does this also simulate concurrent requests? we have noticed some correctness/consistency issues that happen only in such cases with prefix-caching (didn't manage to open a dedicated issues about it yet)

@robertgshaw2-redhat
Copy link
Collaborator

Thanks!

@Jeffwan
Copy link
Contributor Author

Jeffwan commented Jul 19, 2024

amazing!

  • can you please see if this can reproduce the issue reported here: [Bug]: prefix-caching: inconsistent completions #5543 ?
  • does this also simulate concurrent requests? we have noticed some correctness/consistency issues that happen only in such cases (didn't manage to open a dedicated issues about it yet)

Let me try to reproduce these two issues

@KrishnaM251
Copy link
Contributor

amazing!

  • can you please see if this can reproduce the issue reported here: [Bug]: prefix-caching: inconsistent completions #5543 ?
  • does this also simulate concurrent requests? we have noticed some correctness/consistency issues that happen only in such cases (didn't manage to open a dedicated issues about it yet)

Let me try to reproduce these two issues

Please check back if you do 🙏. In the meantime, I will also try to reproduce the issue with your PR.

@Jeffwan
Copy link
Contributor Author

Jeffwan commented Jul 19, 2024

@KrishnaM251 @hibukipanim I have not verified the correctness or consistency in my test yet. It's great to know you found such issue. This PR right now focusing on more real world data, especially the efficiency between different prompt size. It may not fix the correctness issue but I will definitely try to help check the problem you mentioned as I can

@Jeffwan
Copy link
Contributor Author

Jeffwan commented Aug 3, 2024

Seems #7018 address the correctness issue. I have not tested it yet. I think maybe we can merge this tool change first? If there's additional correctness issue, let's track it in #5543 @robertgshaw2-neuralmagic

@Jeffwan
Copy link
Contributor Author

Jeffwan commented Aug 22, 2024

@robertgshaw2-neuralmagic @simon-mo kindly ping

@simon-mo simon-mo merged commit d3b5b98 into vllm-project:main Aug 22, 2024
28 checks passed
@Jeffwan Jeffwan deleted the jiaxin/support-prefix-range-benchmark branch August 22, 2024 23:37
omrishiv pushed a commit to omrishiv/vllm that referenced this pull request Aug 26, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 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.

5 participants