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

[Core] Set linear_weights directly on the layer #3977

Merged
merged 9 commits into from
Apr 11, 2024

Conversation

Yard1
Copy link
Collaborator

@Yard1 Yard1 commented Apr 10, 2024

Currently, all vLLM linear layers use a linear_weights attribute to store a dictionary of tensors to be used for actually calculating the matmuls. Those same tensors are also set on the layer itself, leading to the tensors being referenced both in the dictionary and on the layer. If the references to the tensors on the layer are replaced (eg. by model loading code), then the tensors will stop being equal leading to incorrect matmul results. This PR removes the double reference by avoiding the storing of the linear_weights dictionary and instead setting the tensors directly as attributes on the layer, meaning we are left with only a single source of truth.

See #3476 (comment) for more context

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.

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!

@Yard1 Yard1 marked this pull request as draft April 10, 2024 20:40
@Yard1 Yard1 changed the title Turn linear_weights attribute into a dynamic property Set linear_weights directly on the layer Apr 10, 2024
@Yard1 Yard1 marked this pull request as ready for review April 10, 2024 21:46
@Yard1 Yard1 changed the title Set linear_weights directly on the layer [Core] Set linear_weights directly on the layer Apr 10, 2024
params_dtype: torch.dtype) -> Dict[str, Any]:
"""Create weights for a linear layer."""
output_size: int, params_dtype: torch.dtype,
**extra_weight_attrs):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could this just be an optional weight_loader?

I see the value of enabling kwargs here for future extensibility, but I don't see a case that exists yet other than weight_loader so far, perhaps making the argument explicit is better until we have a reason to allow kwargs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Actually, making it a kwarg will be easier as we don't need extra handling to not set the weight_loader if it's left unspecified.

Copy link
Collaborator

Choose a reason for hiding this comment

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

:)

layer.register_parameter("scales", scales)
set_weight_attrs(scales, extra_weight_attrs)

layer.exllama_state = exllama_state
Copy link
Collaborator

Choose a reason for hiding this comment

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

The LinearLayer does not need to know this info, so I think it should be GPTQLinearMethod.exllama_state ... It probably should not have been in the weights dict before

This will avoid having this dangling member

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ah actually I don't think this is possible since GPTQLinearMethod is a singleton across all layers

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds good

@robertgshaw2-neuralmagic
Copy link
Collaborator

LGTM, left a few minor comments

This reverts commit e20cdc1.
@Yard1 Yard1 enabled auto-merge (squash) April 11, 2024 20:31
@Yard1 Yard1 merged commit a10d305 into vllm-project:main Apr 11, 2024
35 checks passed
@Yard1 Yard1 deleted the linear_weights_property branch April 11, 2024 20:39
sangstar added a commit to coreweave/vllm that referenced this pull request Apr 11, 2024
@jeejeelee jeejeelee mentioned this pull request Apr 12, 2024
andy-neuma pushed a commit to neuralmagic/nm-vllm that referenced this pull request Apr 12, 2024
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request Apr 22, 2024
@chu-tianxiang chu-tianxiang mentioned this pull request May 24, 2024
3 tasks
Temirulan pushed a commit to Temirulan/vllm-whisper that referenced this pull request Sep 6, 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.

2 participants