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

[CI] Disable non-lazy string operation on logging #4326

Merged
merged 9 commits into from
Apr 26, 2024

Conversation

rkooo567
Copy link
Collaborator

Enable this config; https://docs.astral.sh/ruff/rules/#flake8-logging-log

Basically, if you use fstring, format string, string percentage ops, string concat ops, it is evaluated although logging level is not configured. This can affect the performance, and performance is extremely critical for vllm. There has been an accident like #4270 (comment) due to this issue (adding a simple debugging log adds 20% e2e throughput regression)

This fixes the issue by not allowing these ops.


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!

@rkooo567
Copy link
Collaborator Author

Hmm is there any way to apply a linter rule to specific files only in ruff? Maybe it is not needed across all the repo

@tdg5
Copy link

tdg5 commented Apr 24, 2024

Hmm is there any way to apply a linter rule to specific files only in ruff? Maybe it is not needed across all the repo

@rkooo567 , I made a PR to your PR branch fixing all the other logger lint errors 😁 rkooo567#20

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.

I like this change and agree with @tdg5 that we should just apply it across the board.

In practice it mainly only matters for debug logs since the other levels will typically be enabled anyhow, but still good to do everywhere.

Copy link
Collaborator

@simon-mo simon-mo left a comment

Choose a reason for hiding this comment

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

Yes please apply it across the board!

Fix logging lint errors
@rkooo567
Copy link
Collaborator Author

Thanks @tdg5 I merged your PR into this branch!

@rkooo567
Copy link
Collaborator Author

@simon-mo how can I make him a co-contributor of the PR? I will also fix remaining issues and ping you

@simon-mo
Copy link
Collaborator

image

Thanks @tdg5, upon merge the coauthor field should be updated.

@tdg5
Copy link

tdg5 commented Apr 25, 2024

Weird, I'm not sure why, but my local bash format.sh missed a bunch of logger lint that CI caught. I will make another PR to fix the other ones tomorrow if no one beats me to it.

@rkooo567
Copy link
Collaborator Author

@tdg5 it is because ./format.sh only selects files that are modified in the PR! I will wait for your PR for tmrw then! Thank you so much for contribution again to the PR!

@tdg5
Copy link

tdg5 commented Apr 25, 2024

Thanks @rkooo567! Second PR is here: rkooo567#21

@rkooo567
Copy link
Collaborator Author

@simon-mo do you know why this has merge conflict? It seems like I don't have it when I merge main in the local env

@tdg5
Copy link

tdg5 commented Apr 25, 2024

@rkooo567 I saw the merge conflict earlier, which didn't really seem like an unmergable conflict, but now the UI doesn't show a merge issue needing to be resolved, so maybe just UI weirdness?

@rkooo567
Copy link
Collaborator Author

oh that's right. it is gone after I refreshed..

@rkooo567
Copy link
Collaborator Author

I will fix the test failure tmrw

@tdg5
Copy link

tdg5 commented Apr 25, 2024

@rkooo567 , what test failure are you seeing? I tried looking at the buildkite failures but all I saw were indications that the test suites had been terminated by signals. There's a lot of output, so I probably missed an actual failure.

@rkooo567
Copy link
Collaborator Author

oh yeah. it might be just infra issue.

@tdg5
Copy link

tdg5 commented Apr 25, 2024

@rkooo567 branch conflict resolution here: rkooo567#22

@ywang96 ywang96 merged commit a88081b into vllm-project:main Apr 26, 2024
48 checks passed
robertgshaw2-neuralmagic pushed a commit to neuralmagic/nm-vllm that referenced this pull request May 6, 2024
Co-authored-by: Danny Guinther <dguinther@neuralmagic.com>
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request May 7, 2024
Co-authored-by: Danny Guinther <dguinther@neuralmagic.com>
Temirulan pushed a commit to Temirulan/vllm-whisper that referenced this pull request Sep 6, 2024
Co-authored-by: Danny Guinther <dguinther@neuralmagic.com>
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.

6 participants