Skip to content

Conversation

@tanruixiang
Copy link
Contributor

@tanruixiang tanruixiang commented Aug 11, 2025

Essential Elements of an Effective PR Description Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

Purpose

Fix the benchmark's README, the current multimodal-related example parameters are incorrect.
Improve the error messages for the benchmark's argument checks (Currently, the error message incorrectly lists the --endpoint-type parameter as --backend)

Test Plan

Test Result

(Optional) Documentation Update

@github-actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

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 either: Add ready label to the PR or enable auto-merge.

🚀

@mergify mergify bot added the performance Performance-related issues label Aug 11, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly fixes incorrect parameters in the benchmark's README examples and improves the clarity of an error message for the benchmark's argument checks. The changes accurately add the --endpoint-type parameter to the examples and update the error message to refer to endpoint-type instead of backend. These changes improve the usability and correctness of the benchmark documentation and error reporting.

@tanruixiang tanruixiang changed the title [Misc] Fix the benchmark's README and improve the error messages for … [Misc] Fix the benchmark's README and improve the error messages for the benchmark's argument checks Aug 11, 2025
@tanruixiang tanruixiang force-pushed the fix_benchmark_error_message_and_guide branch from 3464325 to 91abf64 Compare August 11, 2025 15:48
…the benchmark's argument checks

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
@tanruixiang tanruixiang force-pushed the fix_benchmark_error_message_and_guide branch from 91abf64 to 32a4dfa Compare August 11, 2025 15:50
@tanruixiang
Copy link
Contributor Author

@DarkLight1337 PTAL

Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

I think backend isn't actually used in vllm bench command, can you verify this? If so let's just remove --backend completely

@DarkLight1337
Copy link
Member

DarkLight1337 commented Aug 17, 2025

cc @mgazz @mgoin

@tanruixiang
Copy link
Contributor Author

tanruixiang commented Aug 17, 2025

@DarkLight1337
--backend was introduced by #20083.
Just for check whether the backend was compatible with the SampleParams.

    if sampling_params and args.backend not in OPENAI_COMPATIBLE_BACKENDS:
        raise ValueError("Sampling parameters are only supported by "
                         "openai-compatible backends.")

It appears to be different from endpoint-type, maybe different backends support the same endpoint-type.
I guess it needs to be retained to support different backends, such as tgi. 🤔

@DarkLight1337
Copy link
Member

DarkLight1337 commented Aug 17, 2025

I am a bit confused by this because I see --endpoint-type inside the old benchmarks/*.py having a very similar purpose as current --backend in vllm bench serve. See if others could provide more insights.

@DarkLight1337
Copy link
Member

DarkLight1337 commented Aug 18, 2025

Anyway let's merge this first to solve the issue

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) August 18, 2025 05:19
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 18, 2025
@tanruixiang
Copy link
Contributor Author

@DarkLight1337 It seems that the CI error is unrelated to this PR?🤔

@DarkLight1337
Copy link
Member

Yeah unrelated, let me force merge

@vllm-bot vllm-bot merged commit 03d4235 into vllm-project:main Aug 19, 2025
46 of 48 checks passed
princepride pushed a commit to princepride/vllm that referenced this pull request Aug 20, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
divakar-amd pushed a commit to divakar-amd/vllm_upstream that referenced this pull request Aug 20, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
cyang49 pushed a commit to cyang49/vllm that referenced this pull request Aug 20, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
djmmoss pushed a commit to djmmoss/vllm that referenced this pull request Aug 21, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
Signed-off-by: Duncan Moss <djm.moss@gmail.com>
epwalsh pushed a commit to epwalsh/vllm that referenced this pull request Aug 28, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
xiao-llm pushed a commit to xiao-llm/vllm that referenced this pull request Aug 28, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
Signed-off-by: Xiao Yu <xiao.yu@amd.com>
zhewenl pushed a commit to zhewenl/vllm that referenced this pull request Aug 28, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
mengxingkongzhouhan pushed a commit to mengxingkongzhouhan/vllm that referenced this pull request Aug 30, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
zhewenl pushed a commit to zhewenl/vllm that referenced this pull request Sep 3, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
FeiDaLI pushed a commit to FeiDaLI/vllm that referenced this pull request Sep 25, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
sducouedic pushed a commit to sducouedic/vllm that referenced this pull request Oct 16, 2025
…the benchmark's argument checks (vllm-project#22654)

Signed-off-by: tanruixiang <tanruixiang0104@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

performance Performance-related issues ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants