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

[Mypy] Part 3 fix typing for nested directories for most of directory #4161

Merged
merged 10 commits into from
Apr 23, 2024

Conversation

rkooo567
Copy link
Collaborator

This fixes typing for most of the nested directories.

The remaining one has a lot of changes required for each of them.

Also move --follow-imports to the pyproject.toml


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!

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.

unsure about the nccl's ctypes part.

@@ -142,7 +142,7 @@ class ncclDataType_t(ctypes.c_int):
ncclNumTypes = 10

@classmethod
def from_torch(cls, dtype: torch.dtype) -> 'ncclDataType_t':
def from_torch(cls, dtype: torch.dtype) -> int:
Copy link
Collaborator

Choose a reason for hiding this comment

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

this is weird that mypy can't handle this, it should defenitely return the c_int

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hmm when I added a breakpoint, it does return int.

(Pdb) ncclDataType_t.from_torch(tensor.dtype)
7
(Pdb) type(ncclDataType_t.from_torch(tensor.dtype))
<class 'int'>

Do you think it is a bug?

Copy link
Member

Choose a reason for hiding this comment

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

Well, technically, this function indeed returns int. ctypes will automatically convert int to c_int . Note that ctypes.c_int is a class/container to hold an int, and itself is not an int.

TL;DR; def from_torch(cls, dtype: torch.dtype) -> int: is correct.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

# enums
class ncclDataType_t(ctypes.c_int):
    pass


class ncclDataTypeEnum:
    ncclInt8 = ncclDataType_t(0)
    ncclChar = ncclDataType_t(0)
    ncclUint8 = ncclDataType_t(1)
    ncclInt32 = ncclDataType_t(2)
    ncclInt = ncclDataType_t(2)
    ncclUint32 = ncclDataType_t(3)
    ncclInt64 = ncclDataType_t(4)
    ncclUint64 = ncclDataType_t(5)
    ncclFloat16 = ncclDataType_t(6)
    ncclHalf = ncclDataType_t(6)
    ncclFloat32 = ncclDataType_t(7)
    ncclFloat = ncclDataType_t(7)
    ncclFloat64 = ncclDataType_t(8)
    ncclDouble = ncclDataType_t(8)
    ncclBfloat16 = ncclDataType_t(9)
    ncclNumTypes = ncclDataType_t(10)

    @classmethod
    def from_torch(cls, dtype: torch.dtype) -> "ncclDataType_t":
        if dtype == torch.int8:
            return cls.ncclInt8
        if dtype == torch.uint8:
            return cls.ncclUint8
        if dtype == torch.int32:
            return cls.ncclInt32
        if dtype == torch.int64:
            return cls.ncclInt64
        if dtype == torch.float16:
            return cls.ncclFloat16
        if dtype == torch.float32:
            return cls.ncclFloat32
        if dtype == torch.float64:
            return cls.ncclFloat64
        if dtype == torch.bfloat16:
            return cls.ncclBfloat16
        raise ValueError(f"Unsupported dtype: {dtype}")

I fixed this way so that it returns the correct type.

Copy link
Collaborator Author

@rkooo567 rkooo567 Apr 18, 2024

Choose a reason for hiding this comment

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

oh @youkaichao I just saw your msg. So just returning int makes more sense if there's automatic conversion then ^?

Copy link
Member

Choose a reason for hiding this comment

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

I think automatic conversion makes more sense. The above code is difficult to read.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think technically inheriting c_int here is not necessary then? it is just like a simple enum

Copy link
Member

Choose a reason for hiding this comment

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

yes, that's ChatGPT's fault 😉

Copy link
Collaborator Author

@rkooo567 rkooo567 Apr 18, 2024

Choose a reason for hiding this comment

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

Fixed. PTAL!
81313dc

Comment on lines 182 to 183
ctypes.c_void_p, ctypes.c_void_p, ctypes.c_size_t, ctypes.c_int,
ctypes.c_void_p, ctypes.c_void_p
Copy link
Member

Choose a reason for hiding this comment

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

This is not intuitive. Let's keep ncclDataType_t and ncclRedOp_t here.

Does mypy understand the call signature of _c_ncclAllReduce? I suppose it will just ignore them. And we can leave a comment here, saying that int will be automatically converted by ctypes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I found ncclDataType_t being a random enum and type at the same time a bit weird though. Why don't we then just

ncclDataType_t(ctype.c_int):
    pass

ncclDataEnum:
    ... = 0
    .... = 1

?

Copy link
Member

Choose a reason for hiding this comment

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

Well, that's also doable.

Please use ncclDataType_t = ctype.c_int, and ncclDataTypeEnum

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

sgtm!

@rkooo567
Copy link
Collaborator Author

It is ready to merge!

@simon-mo simon-mo merged commit 0ae11f7 into vllm-project:main Apr 23, 2024
47 checks passed
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request May 7, 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
Development

Successfully merging this pull request may close these issues.

None yet

3 participants