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

[Bugfix] handle prompt_logprobs in _apply_min_tokens_penalty #3876

Merged
merged 3 commits into from
Apr 10, 2024

Conversation

tjohnson31415
Copy link
Contributor

I implemented _apply_min_tokens_penalty in #3124, but was not aware that having prompt_logprobs in the sampling parameters affects the shape of logits. This PR fixes a bug that would occur if using min_tokens and prompt_logprobs together where the start_idx cursor would not be tracking across sequences correctly. The fix is to detect sequences with prompt_logprobs and skip over the rows in logits for all but the last token in the prompt.

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!

Signed-off-by: Travis Johnson <tsjohnso@us.ibm.com>
Copy link
Collaborator

@njhill njhill left a comment

Choose a reason for hiding this comment

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

Thanks @tjohnson31415!

Do you think you could add a test? Could just set stop_token_ids to be the id of the first token expected?

Signed-off-by: Travis Johnson <tsjohnso@us.ibm.com>
Signed-off-by: Travis Johnson <tsjohnso@us.ibm.com>
@tjohnson31415
Copy link
Contributor Author

@njhill I have added some tests with prompt_logprobs: I added a few more test cases to the test_sampler_min_tokens_penalty tests and updated the request generation / validation accordingly.

I also added a few sentences to the Sampler doc string to describe the situation with prompt_logprobs adding rows to logits. Let me know if that is clear.

@njhill
Copy link
Collaborator

njhill commented Apr 9, 2024

@tjohnson31415 this looks great thank you! Sorry, I didn't realize the test changes would be so involved.

This changes the tests to assume that each batch will comprise only either all prompt or all decode seq groups right? Which will always be the case right now but I'm concerned might not be soon with the chunked prefill changes. So we may need to change the test(s) again at that point to cover hybrid batches.

FYI @rkooo567 ... with hybrid batches, will ordering be such that all prefill sequences will come before the decode sequences?

@rkooo567
Copy link
Collaborator

rkooo567 commented Apr 9, 2024

@njhill yeah ordered by prefill -> decode (within input_tokens). The ordering can be controlled from the scheduler.

@njhill njhill merged commit 0258b7a into vllm-project:main Apr 10, 2024
35 checks passed
@tjohnson31415 tjohnson31415 deleted the fix-min-tokens-penalty branch April 10, 2024 15:15
SageMoore pushed a commit to neuralmagic/nm-vllm that referenced this pull request Apr 11, 2024
andy-neuma pushed a commit to neuralmagic/nm-vllm that referenced this pull request Apr 12, 2024
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request Apr 22, 2024
mawong-amd pushed a commit to ROCm/vllm that referenced this pull request Jun 3, 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.

None yet

3 participants