[mypy] Add mypy type annotation part 1 #4006

rkooo567 · 2024-04-11T12:24:22Z

This PR introduces mypy and fixes some issues from some of the directories.

The goal

[done] mypy vllm/attention/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/core/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/distributed/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/engine/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/entrypoints/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/executor/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/usage/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/*.py --follow-imports=skip --config-file pyproject.toml
[done] mypy vllm/transformer_utils/*.py --follow-imports=skip --config-file pyproject.toml

Followup

mypy vllm/engine/*.py --follow-imports=skip --config-file pyproject.toml
mypy vllm/worker/*.py --follow-imports=skip --config-file pyproject.toml
mypy vllm/spec_decoding/*.py --follow-imports=skip --config-file pyproject.toml
mypy vllm/model_executor/*.py --follow-imports=skip --config-file pyproject.toml
mypy vllm/lora/*.py --follow-imports=skip --config-file pyproject.toml

For other files, I am planning to do it in a separate PR

Partially addressing #3680

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!

DarkLight1337 · 2024-04-11T15:44:55Z

#3816 also has a similar idea; you should communicate with @michaelfeil to avoid conflicts.

pyproject.toml

vllm/core/scheduler.py

vllm/sampling_params.py

michaelfeil

Added some comments!

michaelfeil · 2024-04-11T16:00:50Z

@DarkLight1337 My mypy errors are all in slightly different files. Should be independent.

DarkLight1337 · 2024-04-11T16:07:02Z

@DarkLight1337 My mypy errors are all in slightly different files. Should be independent.

OP plans to commit further changes so it is better to notify in advance. Thanks for the speedy reply btw!

michaelfeil · 2024-04-11T17:22:46Z

I'll maybe check in with the above PR. I like how the PR introduces mypy ./some/folder gradually. Perhaps it makes sense to split up into multiple PRs to make it easier to review and less likley to have some conflicts that need to be resolved after approval.

rkooo567 · 2024-04-11T21:52:04Z

@DarkLight1337 thanks for notifying me!

@michaelfeil so I guess we can merge your PR first? since it introduces the mypy to the CI.

rkooo567 · 2024-04-11T23:27:11Z

This is ready for the review.

michaelfeil · 2024-04-11T23:58:53Z

vllm/sequence.py

@@ -364,7 +364,7 @@ class SequenceGroupState:
    """Mutable state tied to a specific sequence group"""

    # torch.Generator used in seeded sampling
-    generator: Optional = None
+    generator: Optional[torch.Generator] = None


potentially not imported

I think it is fixed with the other PR that's merged!

simon-mo

lgtm overall but we should move run mypy to format.sh

simon-mo · 2024-04-11T23:55:02Z

.github/workflows/mypy.yaml

+    - name: Mypy
+      run: |
+        ls
+        chmod u+x run_mypy.sh


you just need to do the chmod once btw

simon-mo · 2024-04-11T23:57:43Z

run_mypy.sh

put this in format.sh?

Moved back to format.sh.

Btw, the reason why I made this file was to avoid duplication between format.sh and mypy.yaml. I just copied/pasted them there, but lmk if you have other good idea

simon-mo · 2024-04-12T00:04:51Z

vllm/config.py

+        assert speculative_model is not None
+        assert num_speculative_tokens is not None


i'm surprised you still need these while there's the if statement before. mypy should be catching these?

I think the if above is speculative_model is None and num_speculative_tokens is None, so it doesn't cover only one of them is None.

vllm/transformers_utils/tokenizer.py

simon-mo · 2024-04-12T00:17:38Z

Merged @michaelfeil's PR!

rkooo567 · 2024-04-12T00:23:26Z

Thanks for the review! will follow up comments by eod today

vllm/executor/ray_gpu_executor.py

vllm/core/scheduler.py

DarkLight1337 · 2024-04-12T06:25:43Z

Just a heads-up, I have updated type annotations in vllm.entrypoints.openai via #4028.

rkooo567 · 2024-04-12T11:36:55Z

It is mergeable! I think the lora failure is unrelated

rkooo567 · 2024-04-12T21:30:59Z

cc @simon-mo it is ready to merge!

mypy part 1

18894ad

rkooo567 changed the title ~~[mypy] Add mypy type annotation part 1~~ [WIP][mypy] Add mypy type annotation part 1 Apr 11, 2024