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] Reduce unnecessary compute when logprobs=None #6532

Merged
merged 15 commits into from
Jul 29, 2024

Conversation

peng1999
Copy link
Contributor

This PR refactors _get_logprobs function in sampler module, to get rid of some unnecessary CPU and GPU works when logprobs=None in SamplerParams.

Tested using A100 80G GPU, running Qwen2-0.5B-Instruct and batch_size=2048. The latency of _get_logprobs reduced from ~30ms to ~5ms.

Before:

图片

After:

图片

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!

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 trigger fastcheck CI to run, which consists only a small and essential subset of tests to quickly catch errors with the flexibility to run extra individual tests on top (you can do this by unblocking test steps in the Buildkite run).

Full CI run is still required to merge this PR so once the PR is ready to go, please make sure to run it. If you need all test signals in between PR commits, you can trigger full CI as well.

To run full CI, you can do one of these:

  • Comment /ready on the PR
  • Add ready label to the PR
  • Enable auto-merge.

🚀

@rkooo567 rkooo567 self-assigned this Jul 18, 2024
@peng1999 peng1999 changed the title Reduce unnecessary compute when logprobs=None [Core] Reduce unnecessary compute when logprobs=None Jul 18, 2024
if num_logprobs is None and not use_beam_search:
for next_token_id in next_token_ids:
# Use a dummy logprob
sampled_logprobs.append({next_token_id: Logprob(0.0)})
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is 0 a value that makes sense for a logprob? We are still using real token ids here, so maybe 1.0 would be more representative?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you think using NaN here? The value will propagate to cumulative_logprobs. I think it's better to show a NaN than an arbitrary positive number here.

Copy link
Collaborator

Choose a reason for hiding this comment

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

yeah + 1 in nan

Copy link
Collaborator

@rkooo567 rkooo567 left a comment

Choose a reason for hiding this comment

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

QQ: is this breaking API change? What was the previous behavior when logprobs = None?

gshtras added a commit to ROCm/vllm that referenced this pull request Jul 18, 2024
@peng1999
Copy link
Contributor Author

QQ: is this breaking API change? What was the previous behavior when logprobs = None?

The logprobs are already omitted if logprobs=None. So this API is not changing.

include_logprobs = seq_group.sampling_params.logprobs is not None

The changed part is cumulative_logprobs. Previously it is calculated even if logprobs=None, but this PR makes it 0 (or NaN, see #6532 (comment)) in this case. I think it's sensible. If users want to use cumulative_logprobs, they can just set logprobs=0.

Copy link
Collaborator

@comaniac comaniac left a comment

Choose a reason for hiding this comment

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

LGTM. Approve to unblock this PR.
Meanwhile, I agree that using NaN should be able to reduce some confusions.

Copy link
Collaborator

@rkooo567 rkooo567 left a comment

Choose a reason for hiding this comment

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

can you add a simple test? and let's merge it after that!

if num_logprobs is None and not use_beam_search:
for next_token_id in next_token_ids:
# Use a dummy logprob
sampled_logprobs.append({next_token_id: Logprob(0.0)})
Copy link
Collaborator

Choose a reason for hiding this comment

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

yeah + 1 in nan

Copy link
Collaborator

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

LGTM once NaN, thanks!

@peng1999
Copy link
Contributor Author

It seems that some tests failed when I set the cumulative_logprobs to NaN because NaN != NaN. How should I deal with this?

@comaniac
Copy link
Collaborator

It seems that some tests failed when I set the cumulative_logprobs to NaN because NaN != NaN. How should I deal with this?

It would be a bit tricky: https://stackoverflow.com/questions/13003202/python-nan-nan

I'd suggest one of the following:

  1. Change the type of Logprob.logprob to Optional[float] and use None instead of math.nan. This is simpler, but I'm not sure if anywhere else in vLLM uses logprobs as float and may crash if the value is None.
  2. Keep the type of Logprob.logprob as float, and assign 1.0 to it in this case. Additionally, add a new field valid: bool to indicate whether this value is valid or not. This makes Logprob fatter and more complicate, and it may still be mis-used if the consumer doesn't be aware of valid.

@rkooo567
Copy link
Collaborator

1 sounds like a good solution to me! can you actually update the sampling parameter docstring?

@comaniac comaniac enabled auto-merge (squash) July 23, 2024 02:19
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jul 23, 2024
auto-merge was automatically disabled July 23, 2024 10:19

Head branch was pushed to by a user without write access

@peng1999
Copy link
Contributor Author

I changed the dummy value from nan to inf for better comparability. The value will be discard eventually and end users will get both logprobs and cumulative_logprobs=None. I think the inf value is reasonable as an internal representation. Not using None inside Logprob to minimize code change.

The failed test seems to be irrelevant to this PR.

Copy link
Collaborator

@comaniac comaniac left a comment

Choose a reason for hiding this comment

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

I'm ok with inf. Leave to @rkooo567 to approve and merge.

tests/samplers/test_logprobs.py Show resolved Hide resolved
@comaniac comaniac enabled auto-merge (squash) July 29, 2024 05:17
@comaniac comaniac merged commit db9e570 into vllm-project:main Jul 29, 2024
73 checks passed
@peng1999 peng1999 deleted the opt-logprobs branch July 30, 2024 02:08
tjohnson31415 added a commit to tjohnson31415/vllm that referenced this pull request Jul 30, 2024
* upstream/main: (66 commits)
  [Bugfix] Fix PaliGemma MMP (vllm-project#6930)
  [TPU] Fix greedy decoding (vllm-project#6933)
  [Kernel] Tuned int8 kernels for Ada Lovelace (vllm-project#6848)
  [Kernel] Fix marlin divide-by-zero warnings (vllm-project#6904)
  [ci] GHA workflow to remove ready label upon "/notready" comment (vllm-project#6921)
  [Kernel] Remove unused variables in awq/gemm_kernels.cu (vllm-project#6908)
  [Frontend] New `allowed_token_ids` decoding request parameter (vllm-project#6753)
  [Bugfix] Allow vllm to still work if triton is not installed. (vllm-project#6786)
  [TPU] Support tensor parallelism in async llm engine (vllm-project#6891)
  [Kernel] Fix deprecation function warnings squeezellm quant_cuda_kernel (vllm-project#6901)
  [Core] Reduce unnecessary compute when logprobs=None (vllm-project#6532)
  [Kernel] Tuned FP8 Kernels for Ada Lovelace (vllm-project#6677)
  [Model] Initialize support for InternVL2 series models (vllm-project#6514)
  [Misc] Pass cutlass_fp8_supported correctly in fbgemm_fp8 (vllm-project#6871)
  Add Nemotron to PP_SUPPORTED_MODELS (vllm-project#6863)
  [Kernel] Increase precision of GPTQ/AWQ Marlin kernel (vllm-project#6795)
  [TPU] Reduce compilation time & Upgrade PyTorch XLA version  (vllm-project#6856)
  [Docs] Add RunLLM chat widget (vllm-project#6857)
  [Model] Initial support for BLIP-2 (vllm-project#5920)
  [CI/Build][Doc] Update CI and Doc for VLM example changes (vllm-project#6860)
  ...
kylesayrs pushed a commit to neuralmagic/vllm that referenced this pull request Aug 17, 2024
gshtras added a commit to ROCm/vllm that referenced this pull request Aug 22, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

4 participants