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]: During testing, use pytest monkeypatch for safely overriding the env var that indicates the vLLM backend #5210

Merged

Conversation

afeldman-nm
Copy link
Contributor

@afeldman-nm afeldman-nm commented Jun 3, 2024

Issue #5208 details how tests/kernels/test_attention_selector.py attempts to set VLLM_ATTENTION_BACKEND in order to override automatic backend selection during a unit test, and then reset VLLM_ATTENTION_BACKEND to its prior value as part of test cleanup; however, an unhandled edge-case (VLLM_ATTENTION_BACKEND unset prior to test) causes the test to leave VLLM_ATTENTION_BACKEND set in the environment, which in turn breaks other unrelated tests that are incompatible with the backend override specified by VLLM_ATTENTION_BACKEND.

To fix this issue & avoid it in the future, this PR

  • Introduces a context manager env_var_fixture(var_name: str, value: str) -> Iterator[None] in tests/utils.py which temporarily sets an environment variable, and then resets it upon exiting the context manager. The variable will be unset upon exiting the context manager, if it was unset when the context manager was entered.

This PR is also helps address #187 , insofar as that the encoder/decoder unit tests in PR #4888 were failing due to #5208

Usage:

with env_var_fixture("my_var","my_val"):
    # code that depends on my_val == "my_val"

# my_var is returned to original value or unset
  • Introduces tests/kernels/utils.py for kernels-related helper functions
  • In tests/kernels/utils.py, introduces a context manager backend_override_fixture(backend_name: str) -> Iterator[None] which wraps env_var_fixture() in order to create a test fixture for safely forcing backend overrides by setting VLLM_ATTENTION_BACKEND. Upon exiting the context manager, the backend override will be removed. Usage:
with backend_override_fixture("backend_name"):
    # code that depends on vLLM backend

# VLLM_ATTENTION_BACKEND is returned to original value
# or unset
  • Updates tests/kernels/test_attention_selector.py to use backend_override_fixture() in lieu of all instances where VLLM_ATTENTION_BACKEND was being explicitly set and reset.

FIX #5208

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!

@afeldman-nm afeldman-nm marked this pull request as draft June 3, 2024 15:42
@afeldman-nm afeldman-nm marked this pull request as ready for review June 3, 2024 16:34
Copy link
Collaborator

@sroy745 sroy745 left a comment

Choose a reason for hiding this comment

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

2 minor comments. Otherwise LGTM.

tests/kernels/utils.py Outdated Show resolved Hide resolved
tests/kernels/utils.py Outdated Show resolved Hide resolved
@afeldman-nm afeldman-nm changed the title [Bugfix]: Context managers for backend unit test fixtures & environment variable test fixtures generally [Bugfix]: During testing, use pytest monkeypatch for safely overriding the env var that indcates the vLLM backend Jun 3, 2024
@afeldman-nm afeldman-nm changed the title [Bugfix]: During testing, use pytest monkeypatch for safely overriding the env var that indcates the vLLM backend [Bugfix]: During testing, use pytest monkeypatch for safely overriding the env var that indicates the vLLM backend Jun 3, 2024
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

Thanks for the fix!

@simon-mo simon-mo merged commit f42a006 into vllm-project:main Jun 4, 2024
63 of 65 checks passed
blinkbear pushed a commit to blinkbear/vllm that referenced this pull request Jun 6, 2024
robertgshaw2-redhat pushed a commit to neuralmagic/nm-vllm that referenced this pull request Jun 11, 2024
joerunde pushed a commit to joerunde/vllm that referenced this pull request Jun 17, 2024
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jun 27, 2024
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jul 8, 2024
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jul 24, 2024
@afeldman-nm afeldman-nm deleted the afeldman-nm/backend_context_manager branch August 7, 2024 04:46
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
4 participants