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

[Doc] Update Ray Data distributed offline inference example #4871

Merged
merged 1 commit into from
May 17, 2024

Conversation

Yard1
Copy link
Collaborator

@Yard1 Yard1 commented May 17, 2024

This PR makes use of the new ray_remote_args_fn API added to Ray Data to allow for tensor parallelism when conducting batch inference with vLLM and Ray Data.

FIX #4410


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!

@Yard1
Copy link
Collaborator Author

Yard1 commented May 17, 2024

cc @c21 @richardliaw

@Yard1 Yard1 changed the title Update Ray Data distributed offline inference example [Doc] Update Ray Data distributed offline inference example May 17, 2024
Copy link
Contributor

@c21 c21 left a comment

Choose a reason for hiding this comment

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

LGTM

@stikkireddy
Copy link

@Yard1 did you happen to test this with tp > 1? IIRC with tp > 1 vllm also calls ray init and does that impact this at all?

@Yard1
Copy link
Collaborator Author

Yard1 commented May 17, 2024

@stikkireddy yes, I tested it with multiple TP factors and both in single and multi-node setups. ray.init() can be called multiple times without issues.

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

@simon-mo simon-mo merged commit c5711ef into main May 17, 2024
53 of 55 checks passed
pg = ray.util.placement_group(
[{
"GPU": 1,
"CPU": 1
Copy link

Choose a reason for hiding this comment

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

Why do we need to set CPU: 1 here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it's not directly necessary (it will work fine without that), but it shows that we will still be running a CPU process per each worker

@Yard1 Yard1 deleted the update_ray_data_example branch May 24, 2024 05:05
@chenhongyu2048
Copy link

If my understanding is correct, is there data parallelism between nodes and tensor parallelism inside nodes in the documentation offline_inference_distributed.py?

@c21
Copy link
Contributor

c21 commented Jun 6, 2024

If my understanding is correct, is there data parallelism between nodes and tensor parallelism inside nodes in the documentation offline_inference_distributed.py?

Yes. Data is sharded across nodes, and each node does inference on a portion of data. Each node supports tensor parallelism acorss multiple GPUs.

Temirulan pushed a commit to Temirulan/vllm-whisper that referenced this pull request Sep 6, 2024
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.

[Doc]: Offline Inference Distributed Broken for TP
8 participants