Skip to content

[Spec Decode] Clean up spec decode example #20240

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

Merged
merged 3 commits into from
Jun 30, 2025
Merged

Conversation

WoosukKwon
Copy link
Collaborator

This PR cleans up the spec decoding example, removing outdated parameters and print more metrics.

Signed-off-by: Woosuk Kwon <[email protected]>
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.

🚀

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.

Summary of Changes

Hello @WoosukKwon, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on refining the spec_decode.py example script. My aim was to clean up the command-line interface by removing obsolete parameters and to enhance the output by providing more comprehensive and accurate performance metrics for speculative decoding, making the example more relevant and informative.

Highlights

  • Argument Cleanup: I've removed several outdated or unused command-line arguments (--dataset, --max-num-seqs, --draft-tp, --max-num-batched-tokens, --max-model-len) from the parse_args function in spec_decode.py to streamline the script's interface.
  • Configuration Simplification: I've removed the draft_tensor_parallel_size and max_model_len parameters from the speculative_config dictionaries for both eagle and ngram methods, and also removed max_model_len from the LLM constructor call, aligning with the argument cleanup.
  • Enhanced Metric Reporting: I've updated the script to print more detailed metrics, including total_num_output_tokens, num_draft_tokens, and num_accepted_tokens. The mean acceptance length calculation has also been updated to use these new metrics for more accurate reporting. Additionally, mtp has been added as a new choice for the --method argument.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@mergify mergify bot added the documentation Improvements or additions to documentation label Jun 30, 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 PR cleans up the spec decoding example by removing outdated parameters and printing more metrics. There are a couple of issues that need to be addressed. The first is that the removed command-line arguments are still being used, which will cause the script to crash. The second is a potential division-by-zero error when calculating metrics.

print(f"num_drafts: {num_drafts}")
print(f"num_draft_tokens: {num_draft_tokens}")
print(f"num_accepted_tokens: {num_accepted_tokens}")
print(f"mean acceptance length: {1 + (num_accepted_tokens / num_drafts):.2f}")
Copy link
Contributor

Choose a reason for hiding this comment

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

high

To prevent a potential ZeroDivisionError, add a condition to check if num_drafts is zero before performing the division.

Suggested change
print(f"mean acceptance length: {1 + (num_accepted_tokens / num_drafts):.2f}")
print(f"mean acceptance length: {1 + (num_accepted_tokens / num_drafts):.2f}")

Copy link
Collaborator

Choose a reason for hiding this comment

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

seems legit, maybe a condition to use 0 or num_accepted_tokens / num_drafts.

@draftbk
Copy link
Contributor

draftbk commented Jun 30, 2025

I found there is a duplicated example and was wondering if we want to clean that up:

print(f"num_drafts: {num_drafts}")
print(f"num_draft_tokens: {num_draft_tokens}")
print(f"num_accepted_tokens: {num_accepted_tokens}")
print(f"mean acceptance length: {1 + (num_accepted_tokens / num_drafts):.2f}")
Copy link
Collaborator

Choose a reason for hiding this comment

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

seems legit, maybe a condition to use 0 or num_accepted_tokens / num_drafts.

Signed-off-by: Woosuk Kwon <[email protected]>
@WoosukKwon
Copy link
Collaborator Author

@draftbk Good catch. Let's remove it in this PR. IIRC, @ekagra-ranjan also found the redundancy.

@WoosukKwon WoosukKwon merged commit 2965c99 into main Jun 30, 2025
8 of 12 checks passed
@WoosukKwon WoosukKwon deleted the woosuk/fix-sd-example branch June 30, 2025 15:28
CSWYF3634076 pushed a commit to CSWYF3634076/vllm that referenced this pull request Jul 2, 2025
avigny pushed a commit to avigny/vllm that referenced this pull request Jul 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants