[Doc] Add typing hints / mypy types cleanup #3816

michaelfeil · 2024-04-03T05:46:26Z

Mostly typing only changes - should have no runtime effects. Fixed some sources of bugs.

I found a note in the Contribution guidelines **Note:** Currently, the repository does not pass the mypy tests.
Feel free to ignore or pick the issue up if there are are to many conflicts.

FIX: no existing issue
Related: #1780

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!

ywang96

Thank you for your contribution on this cleanup effort! Left a few comments!

benchmarks/backend_request_func.py

ywang96 · 2024-04-06T21:47:59Z

vllm/core/block/interfaces.py

-    @abstractproperty
+    @property
+    @abstractmethod


Just a note to the audience why this change makes sense
https://docs.python.org/3.10/library/abc.html#abc.abstractproperty

docs/source/conf.py

vllm/logger.py

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

ywang96

LGTM! cc @WoosukKwon @zhuohan123 about the decorator changes in interface.py. Can one of you approve as well if you don't see anything problem with it?

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

benchmarks/backend_request_func.py

-    latency: float = 0
-    ttft: float = 0  # Time to first token
+    latency: float = 0.0
+    ttft: float = 0.0  # Time to first token


so unfortunate mypy cannot handle this :(

On the other hand mypy hints a potential source for an actual bug - I think in this context any plausible use of that int should however also be compatible with int or float.
E.g. int(str(0)) works but int(str(0.0)) breaks.

rkooo567 · 2024-04-11T21:53:54Z

vllm/engine/metrics.py

@@ -135,7 +141,7 @@ def __init__(self, local_interval: float, labels: Dict[str, str]) -> None:
        self.labels = labels
        self.metrics = Metrics(labelnames=list(labels.keys()))

-    def info(self, type: str, obj: object) -> None:
+    def info(self, type: str, obj: SupportsMetricsInfo) -> None:


QQ: should we change the var name obj?

it would slight improve readability, but I am not sure if there is any dependency on the kwarg name. obj is no a great variable name, I agree.

rkooo567 · 2024-04-11T21:54:26Z

vllm/transformers_utils/tokenizers/baichuan.py

-            logger.error(f"Vocabulary path ({save_directory}) "
-                         "should be a directory")
-            return
+            raise ValueError(f"Vocabulary path ({save_directory}) "


QQ: what's the motivation behind the functional change here?

This function was just copied in from some baichuan repo. The exception is more of a this should never happen thing. save_vocabulary is not used by vllm. I also don't want to remove the file entirely - but the return None is not compliant to the function signature.

*file -> function

I think the reason why the function is included at all, is to keep the diff to baichuan repo low.

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

michaelfeil added 2 commits April 2, 2024 22:38

add improved typing

68244df

update logger and benchmark function

ccc15ab

michaelfeil changed the title ~~[Doc] Add remaining mypy types to codebase~~ [Doc] Add typing hints / mypy types cleanup Apr 3, 2024

michaelfeil added 10 commits April 2, 2024 22:47

fix with ruff

54ca154

fix w isort

16de54a

fix with yapf

0724817

fix with yapf

164b19d

fix rest of typing

e68ee26

adding more type hints

65228f1

format!

bd0833b

format!2

6b86585

update additional mypy hints

766c23a

update interfaces

2f9cc7d

ywang96 self-assigned this Apr 5, 2024

ywang96 reviewed Apr 6, 2024

View reviewed changes

michaelfeil and others added 3 commits April 6, 2024 16:14

Update docs/source/conf.py

08eef91

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

Update docs/source/conf.py

bd50df3

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

Update vllm/logger.py

0526dea

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

ywang96 approved these changes Apr 7, 2024

View reviewed changes

DarkLight1337 mentioned this pull request Apr 11, 2024

[mypy] Add mypy type annotation part 1 #4006

Merged

rkooo567 approved these changes Apr 11, 2024

View reviewed changes

simon-mo merged commit c2b4a1b into vllm-project:main Apr 12, 2024
35 checks passed

michaelfeil deleted the improved-typing branch April 12, 2024 01:06

andy-neuma pushed a commit to neuralmagic/nm-vllm that referenced this pull request Apr 12, 2024

[Doc] Add typing hints / mypy types cleanup (vllm-project#3816)

cd9f354

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request Apr 22, 2024

[Doc] Add typing hints / mypy types cleanup (vllm-project#3816)

c65f7b6

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

dtrifiro mentioned this pull request May 15, 2024

bump ubi base image tag opendatahub-io/vllm#24

Merged

mawong-amd pushed a commit to ROCm/vllm that referenced this pull request Jun 3, 2024

[Doc] Add typing hints / mypy types cleanup (vllm-project#3816)

cb73dd0

Co-authored-by: Roger Wang <136131678+ywang96@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc] Add typing hints / mypy types cleanup #3816

[Doc] Add typing hints / mypy types cleanup #3816

michaelfeil commented Apr 3, 2024 •

edited

ywang96 left a comment

ywang96 Apr 6, 2024

ywang96 left a comment

rkooo567 Apr 11, 2024

michaelfeil Apr 11, 2024

rkooo567 Apr 11, 2024

michaelfeil Apr 11, 2024

rkooo567 Apr 11, 2024

michaelfeil Apr 11, 2024

michaelfeil Apr 11, 2024

[Doc] Add typing hints / mypy types cleanup #3816

[Doc] Add typing hints / mypy types cleanup #3816

Conversation

michaelfeil commented Apr 3, 2024 • edited

PR Title and Classification

Code Quality

Notes for Large Changes

What to Expect for the Reviews

Thank You

ywang96 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ywang96 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelfeil commented Apr 3, 2024 •

edited