Skip to content

[CI/Build] Increasing timeout for multiproc worker tests #8203

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

Merged
merged 2 commits into from
Sep 6, 2024

Conversation

alexeykondrat
Copy link
Contributor

On ROCm we have to use spawn instead of fork and it creates an overhead, so five seconds might not be enough to create and destroy eight worker processes.
Please note, increasing the timeout to 60 seconds will not impact the test execution time unless there is a problem.

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.

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

github-actions bot commented Sep 5, 2024

👋 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.

🚀

@alexeykondrat
Copy link
Contributor Author

/ready

@Alexei-V-Ivanov-AMD
Copy link
Collaborator

This PR fixes the "AMD Engine Test". The int argument of the join() operator defines the maximal count of seconds to wait for joining. Increasing this parameter doesn't result in the delay, rather it increases resilience of the tests that might be run on different machines, in different computational contexts, with different levels of host occupancy.

@Alexei-V-Ivanov-AMD
Copy link
Collaborator

/ready

@mgoin mgoin added the ready ONLY add when PR is ready to merge/full CI is needed label Sep 5, 2024
@simon-mo simon-mo requested a review from njhill September 6, 2024 01:13
@simon-mo
Copy link
Collaborator

simon-mo commented Sep 6, 2024

@njhill is increasing this timeout okay?

@njhill
Copy link
Member

njhill commented Sep 6, 2024

@Alexei-V-Ivanov-AMD this test exercises the multiproc worker mechanics in isolation, with dummy worker impls. I don’t think the time difference it takes to start these dummy workers with spawn vs fork would be very significant?

@alexeykondrat
Copy link
Contributor Author

alexeykondrat commented Sep 6, 2024

@Alexei-V-Ivanov-AMD this test exercises the multiproc worker mechanics in isolation, with dummy worker impls. I don’t think the time difference it takes to start these dummy workers with spawn vs fork would be very significant?

@njhill The experiment shows that it takes approximately 5-6 seconds to spawn those processes and less than a second if we fork them. So, 5 second timeout is not enough.

https://docs.python.org/3.10/library/multiprocessing.html#contexts-and-start-methods

@Alexei-V-Ivanov-AMD
Copy link
Collaborator

@njhill

From https://docs.python.org/3.10/library/multiprocessing.html#contexts-and-start-methods

"Starting a process using this method [spawn] is rather slow compared to using fork or forkserver."

@youkaichao
Copy link
Member

just chiming in, if you cannot resolve the disagreement, you can introduce an env var like VLLM_MP_JOIN_TIMEOUE, set it to 2 by default, and override it in the rocm backend, just like what I did in

if os.environ.get("VLLM_WORKER_MULTIPROC_METHOD", None) in ["fork", None]:
logger.warning("`fork` method is not supported by ROCm. "
"VLLM_WORKER_MULTIPROC_METHOD is overridden to"
" `spawn` instead.")
os.environ["VLLM_WORKER_MULTIPROC_METHOD"] = "spawn"

@Alexei-V-Ivanov-AMD
Copy link
Collaborator

@youkaichao I don't think this divergence between the platforms is necessary. As mentioned above, setting the time count to a reasonably large value will only affect our expectations on when the wait for the join operator becomes a burden. That way we only increase resilience of the test (something that is opposite to "flakiness", and we all want that test to be resilient). If join occurs faster, the execution continues without a delay.

@youkaichao
Copy link
Member

makes sense to me, let me chat with @njhill

@njhill
Copy link
Member

njhill commented Sep 6, 2024

Hey sorry ... no disagreement and sorry didn't mean to make a big deal of this, I was just trying to understand because this should be a platform-agnostic test. My only hesitation to bumping the timeout that much higher is in case we make some change to the mechanics that causes it to unintentionally take much longer, then we wouldn't catch it.

How about just increasing to something not quite as large, like 20 sec?

@Alexei-V-Ivanov-AMD
Copy link
Collaborator

@njhill

How about just increasing to something not quite as large, like 20 sec?

IMHO it'll work fine.

Copy link
Member

@njhill njhill left a comment

Choose a reason for hiding this comment

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

@simon-mo simon-mo merged commit 1447c97 into vllm-project:main Sep 6, 2024
34 checks passed
@alexeykondrat alexeykondrat deleted the fixing_amd_engine_test branch September 6, 2024 18:53
dtrifiro pushed a commit to opendatahub-io/vllm that referenced this pull request Sep 12, 2024
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 2024
LeiWang1999 pushed a commit to LeiWang1999/vllm-bitblas that referenced this pull request Mar 26, 2025
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.

6 participants