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] Catch up with removed parameter 'is_prompt' in cpu/xpu model runner #7807

Closed

Conversation

anencore94
Copy link

@anencore94 anencore94 commented Aug 23, 2024

FILL IN THE PR DESCRIPTION HERE

FIX #6225

I've encountered the same issue above. There might be refactoring issue from #4681.
There is no longer exists a parameter 'is_prompt' in AttentionMetadata class. Looks like such field's role was moved to each method (to determine the token is for prompt or decoding)
But, in cpu/xpu model runner, they use such parameter as a key-value args. Thus, making an error when serving some model with cpu device.

How to reproduce

VLLM_CPU_KVCACHE_SPACE=16 python benchmarks/benchmark_throughput.py --model mosaicml/mpt-7b --input-len 128 --output-len 512 --trust-remote-code --backend=vllm  --device cpu --dtype bfloat16

Built vllm package with editable mode (pip install -e .)

  • error log
INFO 08-23 07:42:03 cpu_executor.py:207] # CPU blocks: 2048
Processed prompts:   0%|                                                                                                                 | 0/1000 [00:00<?, ?it/s, est. speed input: 0.00 toks/s, output: 0.00 toks/s][rank0]: Traceback (most recent call last):
[rank0]:   File "/vllm/benchmarks/benchmark_throughput.py", line 439, in <module>
[rank0]:     main(args)
[rank0]:   File "/vllm/benchmarks/benchmark_throughput.py", line 227, in main
[rank0]:     elapsed_time = run_vllm(
[rank0]:   File "/vllm/benchmarks/benchmark_throughput.py", line 127, in run_vllm
[rank0]:     llm.generate(prompts, sampling_params, use_tqdm=True)
[rank0]:   File "/vllm/vllm/utils.py", line 1030, in inner
[rank0]:     return fn(*args, **kwargs)
[rank0]:   File "/vllm/vllm/entrypoints/llm.py", line 345, in generate
[rank0]:     outputs = self._run_engine(use_tqdm=use_tqdm)
[rank0]:   File "/vllm/vllm/entrypoints/llm.py", line 686, in _run_engine
[rank0]:     step_outputs = self.llm_engine.step()
[rank0]:   File "/vllm/vllm/engine/llm_engine.py", line 1319, in step
[rank0]:     output = self.model_executor.execute_model(
[rank0]:   File "/vllm/vllm/executor/cpu_executor.py", line 222, in execute_model
[rank0]:     output = self.driver_method_invoker(self.driver_worker,
[rank0]:   File "/vllm/vllm/executor/cpu_executor.py", line 356, in _driver_method_invoker
[rank0]:     return getattr(driver, method)(*args, **kwargs)
[rank0]:   File "/vllm/vllm/worker/worker_base.py", line 290, in execute_model
[rank0]:     inputs = self.prepare_input(execute_model_req)
[rank0]:   File "/vllm/vllm/worker/worker_base.py", line 278, in prepare_input
[rank0]:     return self._get_driver_input_and_broadcast(execute_model_req)
[rank0]:   File "/vllm/vllm/worker/worker_base.py", line 249, in _get_driver_input_and_broadcast
[rank0]:     self.model_runner.prepare_model_input(
[rank0]:   File "/vllm/vllm/worker/cpu_model_runner.py", line 322, in prepare_model_input
[rank0]:     ) = self._prepare_prompt(seq_group_metadata_list)
[rank0]:   File "/vllm/vllm/worker/cpu_model_runner.py", line 201, in _prepare_prompt
[rank0]:     attn_metadata = self.attn_backend.make_metadata(
[rank0]:   File "/vllm/vllm/attention/backends/abstract.py", line 47, in make_metadata
[rank0]:     return cls.get_metadata_cls()(*args, **kwargs)
[rank0]: TypeError: FlashAttentionMetadata.__init__() got an unexpected keyword argument 'is_prompt'
Processed prompts:   0%|                                                                                                                 | 0/1000 [00:00<?, ?it/s, est. speed input: 0.00 toks/s, output: 0.00 toks/s]

Root cause: Incorrect Attention Backend Selection on CPU

  • Context: When running vllm with device="cpu", the engine correctly sets executor_class to CPUExecutor.
  • Root Cause:
    • The get_attn_backend() function incorrectly selects FlashAttentionBackend instead of TorchSDPABackend.
    • This happens because which_attn_to_use() bases its decision on the package configuration (CPU/GPU), ignoring the runtime device parameter.
  • Impact:
    • This results in the wrong backend being used in CPU environments, leading to potential errors and performance issues.
    • Additionally, there’s an issue with argument mismatches due to the incorrect backend being selected.
  • Proposed Solution:
    • Update which_attn_to_use() to consider the device parameter when selecting the backend.

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 run fastcheck CI which consists a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of default ones by unblocking the steps in your fast-check build on Buildkite UI.

Once the PR is approved and ready to go, please make sure to run full CI as it is required to merge (or just use auto-merge).

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

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

🚀

@anencore94 anencore94 changed the title remove deleted parameter [Bugfix] Catch up with removed parameter 'is_prompt' in cpu/xpu model runner Aug 23, 2024
@anencore94
Copy link
Author

/ready

@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 23, 2024
@anencore94 anencore94 marked this pull request as ready for review August 23, 2024 04:23
Copy link
Collaborator

@WoosukKwon WoosukKwon left a comment

Choose a reason for hiding this comment

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

Hi @anencore94, thanks for submitting the PR.

Did you install the vLLM CPU backend following these instructions: https://docs.vllm.ai/en/latest/getting_started/cpu-installation.html?

It seems like the issue you posted is not actually relevant to the CPU backend.

@anencore94
Copy link
Author

I see. I'll update the description

@anencore94 anencore94 marked this pull request as draft August 23, 2024 08:31
@anencore94
Copy link
Author

anencore94 commented Aug 23, 2024

I found the root cause, but not sure how to fix it. I'll close this PR and write a comment describing what I've found on the original issue.

@anencore94 anencore94 closed this Aug 23, 2024
@anencore94 anencore94 deleted the bugfix/is_prompt_error branch August 26, 2024 01:00
@anencore94
Copy link
Author

PTAL when you have some time. @WoosukKwon

#6225 (comment)

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
2 participants