Skip to content

Conversation

zeroorhero
Copy link

support valkey database

FILL IN THE PR DESCRIPTION HERE

FIX #xxxx (link existing issues this PR will resolve)

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!

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 starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

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

🚀

Changqi Lu added 2 commits September 23, 2024 11:47
Add external database valkey operations.
Add valkey in prefill and decode nodes to transfer kv cache.

Signed-off-by: Changqi Lu <[email protected]>
Copy link
Collaborator

@KuntaiDu KuntaiDu left a comment

Choose a reason for hiding this comment

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

Changes requested. Thank you for contributing code and make valkey work! It will be much more scalable in datacenter scenario.

Comment on lines +300 to +316
class ValkeyPipe(TorchDistributedPipe):
"""
A pipe that uses the valkey protocol to transfer tensors between ranks.
"""

def __init__(self):
self.transport_thread: Optional[ThreadPoolExecutor] = None
self.buffer_size = 0
self.buffer_size_lock = threading.Lock()
self.device = "cpu"
self.none_tensor = torch.tensor([NONE_INT], device=self.device)

self.rcv_metadata_buffer = torch.zeros(self.METADATA_LENGTH,
dtype=self.METADATA_DTYPE,
device=self.device)

def _send_metadata(self, d_metadata_buffer: torch.Tensor, tensor_key:str = ""):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would be nice if you can move this pipe to a separate file.


@abstractmethod
def send_tensor(self, tensor: Optional[torch.Tensor]) -> None:
def send_tensor(self, tensor: Optional[torch.Tensor], tensor_key: str = "") -> None:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Adding tensor_key is definitely needed for DBs. Would be great if you can make it Optional[str] to force people to generate this metadata if their implementation correctness is based on correct tensor_key .

Comment on lines +160 to +167
elif self.kv_transfer_driver.startswith("valkey"):
url = self.kv_transfer_driver.split("://")[1]
ip, port = parse_url(url)
# TODO add PING command
self.sender = KVDatabaseTransfer(ip, int(port), self.local_rank, ValkeyPipe())
self.recver = KVDatabaseTransfer(ip, int(port), self.local_rank, ValkeyPipe())
else:
raise ValueError("Invalid kv_transfer_driver")
Copy link
Collaborator

Choose a reason for hiding this comment

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

lol we definitely need a factory class to build the lookup buffer in the future, but let us keep it as is for now.

Comment on lines +52 to +69
def drop_select(self, input_tokens: torch.Tensor,
roi: torch.Tensor) -> List[Optional[torch.Tensor]]:

if not self.init_valkey:
ops.valkey_init(self.ip, self.port, True)
self.init_valkey = True

tensor_key = self._encode_tensors(input_tokens, roi) + "/" + str(self.local_rank)
key_key = tensor_key + "/key"
val_key = tensor_key + "/value"
hid_key = tensor_key + "/hidden"

key = self.data_pipe.recv_tensor(key_key)
val = self.data_pipe.recv_tensor(val_key)
hid = self.data_pipe.recv_tensor(hid_key)
res = [input_tokens, roi, key, val, hid]

return [tensor.to(self.recv_device) for tensor in res]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would be great if you can make sure the valkey entry from the valkey database at prefill instance & decode instance are properly removed after drop_select to avoid OOM. (That's why we call it drop select -- we want to guarantee that the item selected from the lookup buffer will be dropped after drop_select call).

@zeroorhero
Copy link
Author

Changes requested. Thank you for contributing code and make valkey work! It will be much more scalable in datacenter scenario.

Thanks!

@kuangdao
Copy link

m

@cherhh
Copy link

cherhh commented Jan 9, 2025

Could you please provide some benchmark tests?

@hmellor hmellor closed this Mar 10, 2025
@mergify mergify bot added documentation Improvements or additions to documentation ci/build labels Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/build documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants