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

[Core] Refactoring sampler and support prompt logprob for chunked prefill #4309

Merged
merged 48 commits into from
Apr 26, 2024

Conversation

rkooo567
Copy link
Collaborator

@rkooo567 rkooo567 commented Apr 24, 2024

Summary;

Refactoring sampling metadata and sampler. More concretely

  • Introduce SequenceGroupToSample class instead of having multiple list data structure to combine
  • Instead of writing index looping logic again and again, we prepare the prefill/decode indices ahead of time and reuse it
  • Move prepare_sample to SamplingMetadata
  • Remove all indexing logics that assume requests are entire prefill or decode
  • Introduce do_sample to SequenceGroupMetadata. If it is set to False, sampling/sample logprob calculation for the corresponding seq_group is skipped.
  • Improve docstring and confusing variable names
  • Remove perform_sampling because it is leaky and overlaps with do_sample. I just use is_driver_worker directly for the same purpose.

Fix prompt logprob for chunked prefil

  • Existing logic has strong assumption where the seq group only contains entire prefill or decode.
  • Allow to incrementally update prompt logprobs
  • Allow to skip sampling when it is chunked prefill (since it is not required)

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!

vllm/engine/llm_engine.py Show resolved Hide resolved
vllm/engine/output_processor/multi_step.py Show resolved Hide resolved
seq_group.sampling_params.detokenize and self.detokenizer:
def process_prompt_logprob(self, seq_group: SequenceGroup,
outputs: List[SequenceGroupOutput]) -> None:
assert len(outputs) == 1, ("Single step should only has 1 output.")
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

cc @cadedaniel is this assumption correct?

Copy link
Collaborator

Choose a reason for hiding this comment

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

correct!

generators=generators,
)
return sampling_metadata
# def _prepare_sample(
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Will remove after confirming tests are passed

generators=generators,
)
return sampling_metadata
# def _prepare_sample(
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Will remove after confirming tests are passed

Copy link
Collaborator

@zhuohan123 zhuohan123 left a comment

Choose a reason for hiding this comment

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

Thank you for the refactor SangBin! The code looks much better now. I left some small comments. But in general the code looks pretty good to me.


seq_group_idx = categorized_seq_group_idx[sampling_type]
Copy link
Collaborator

Choose a reason for hiding this comment

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

seq_group_idx -> seq_group_ids? Originally I would like to emphasize this is a list of IDs.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

reverted to id. I thought it was confusing because each seq_group already has request_id (and it doesn't match). But no strong preference.

vllm/model_executor/layers/sampler.py Outdated Show resolved Hide resolved
vllm/model_executor/sampling_metadata.py Outdated Show resolved Hide resolved
vllm/engine/output_processor/multi_step.py Show resolved Hide resolved
@rkooo567
Copy link
Collaborator Author

@zhuohan123 thanks for the review! All comments are addressed!

@zhuohan123 zhuohan123 enabled auto-merge (squash) April 26, 2024 00:27
@zhuohan123 zhuohan123 merged commit 603ad84 into vllm-project:main Apr 26, 2024
48 checks passed
@rkooo567
Copy link
Collaborator Author

yay. Thanks for the review again @zhuohan123 !! time to refactoring model runner...

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

4 participants