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] Fix load config when using bools #9533

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

madt2709
Copy link

Fixes #9499

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.

🚀

@madt2709 madt2709 changed the title [bugfix] Fix load config when using bools [Bugfix] Fix load config when using bools Oct 20, 2024
Comment on lines +1316 to +1303
if value:
processed_args.append('--' + key)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we have some boolean arguments that aren't just store_true. I know you can specify --trust-remote-code=True on the CLI so maybe the issue could also be solved by the mismatch of capitalization on true vs True - what do you think?

Copy link
Author

@madt2709 madt2709 Oct 20, 2024

Choose a reason for hiding this comment

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

I searched for store_false on this file: https://github.com/vllm-project/vllm/blob/main/vllm/engine/arg_utils.py and couldn't find any instances of it.

However, with a second look, there's two types of boolean flags:

  • action='store_true' eg --trust-remote-code
  • action=StoreBoolean eg --disable-logprobs-during-spec-decoding.

In the store_true case, --trust-remote-code=True doesn't work eg run vllm serve facebook/opt-125m --trust-remote-code=True and it errors with vllm serve: error: argument --trust-remote-code: ignored explicit argument 'True'.

In the StoreBoolean case, --disable-logprobs-during-spec-decoding=True does work.

So I think my code needs to add an extra check for these StoreBoolean arguments and explicitly set the value in that case.

Copy link
Author

Choose a reason for hiding this comment

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

Updated the PR to handle StoreBoolean values.

  • Moved StoreBoolean to vllm/utils.py to avoid circular imports
  • Updated the _load_config_from_file to not be static so it can check which arguments are in StoreBoolean case
  • Added a check for the StoreBoolean

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah you were right about the difference there, but yes I was referring to the usage of StoreBoolean! Thanks for looking into this

@madt2709
Copy link
Author

Hi @mgoin, thanks for taking the time to look over this. What's the process for getting this reviewed? First time contributing here.

@mgoin mgoin added the ready ONLY add when PR is ready to merge/full CI is needed label Oct 24, 2024
Copy link
Collaborator

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

Just ask and ping related folks, as you did. I think this is good to go, thanks!

@madt2709 madt2709 force-pushed the fix-load-config branch 2 times, most recently from 45e1af4 to cc7c75b Compare October 24, 2024 22:43
@madt2709
Copy link
Author

madt2709 commented Oct 25, 2024

Thanks @mgoin! There's a failing test buildkite/ci-aws/pr/distributed-tests-2-gpus which is failing. I tried rebasing onto main but also seems to be also failing on main branch so unlikely to be related to the change. Can you bypass the requirements please and merge this? Or let me know if there's some other way I should be fixing this.

Signed-off-by: madt2709 <theodore.dias@hotmail.co.uk>
Signed-off-by: madt2709 <theodore.dias@hotmail.co.uk>
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
2 participants