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

Enable Async output process for HPU #342

Open
wants to merge 2 commits into
base: habana_main
Choose a base branch
from

Conversation

zhouyu5
Copy link

@zhouyu5 zhouyu5 commented Sep 27, 2024

FILL IN THE PR DESCRIPTION HERE

This PR refer to #7049 to implement Asynchronous Output Processor on HPU. It is open by default, to disable it, please pass the --disable_async_output_proc flag.

From my local test on latest habana_main branch(commit 29fb5ed), the throughput improves from 3847 TPS to 4011 TPS.

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.

Adding or changing kernels

Each custom kernel needs a schema and one or more implementations to be registered with PyTorch.

  • Make sure custom ops are registered following PyTorch guidelines: Custom C++ and CUDA Operators and The Custom Operators Manual
  • Custom operations that return Tensors require meta-functions. Meta-functions should be implemented and registered in python so that dynamic dims can be handled automatically. See above documents for a description of meta-functions.
  • Use torch.libary.opcheck() to test the function registration and meta-function for any registered ops. See tests/kernels for examples.
  • When changing the C++ signature of an existing op, the schema must be updated to reflect the changes.
  • If a new custom type is needed, see the following document: Custom Class Support in PT2.

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!

@@ -417,6 +417,7 @@ class ModelInputForHPU(ModelRunnerInputBase):
virtual_engine: int = 0
lora_mask: Optional[torch.Tensor] = None
lora_logits_mask: Optional[torch.Tensor] = None
async_callback: Optional[Callable] = None

Choose a reason for hiding this comment

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

Where is this set?
Vllm code names it output_proc_callback_fn shouldnt we keep the name?

Copy link
Author

@zhouyu5 zhouyu5 Sep 27, 2024

Choose a reason for hiding this comment

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

@michalkuligowski
It is first set in llm_engine.py, see:

if model_config.use_async_output_proc:
    process_model_outputs = weak_bind(self._process_model_outputs)
    self.async_callbacks = [
        partial(process_model_outputs,
                ctx=self.scheduler_contexts[v_id])
        for v_id in range(self.parallel_config.pipeline_parallel_size)
    ]
...
if allow_async_output_proc:
    execute_model_req.async_callback = self.async_callbacks[
        virtual_engine]

then pass to worker_base.py, which is inherited by HabanaWorker,

if execute_model_req.async_callback:
    model_input = dataclasses.replace(  # type: ignore
        model_input,
        async_callback=execute_model_req.async_callback)

For its name, it is initially called output_proc_callback_fn, but in vllm's latest code, it's changed to async_callback, since it could involve other operations, not only output processing, see this comment in PR#7911,
image

Choose a reason for hiding this comment

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

Formatting issues

Copy link
Author

Choose a reason for hiding this comment

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

Thanks. Formatted now. @michalkuligowski

@michalkuligowski michalkuligowski added the intel Issues or PRs submitted by Intel label Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
intel Issues or PRs submitted by Intel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants