Skip to content

Conversation

@mratsim
Copy link
Contributor

@mratsim mratsim commented Nov 10, 2025

The link in the Quip README is pointing to SpinQuant.

Note: We might want to link directly to the relevant lines but:

  • we need to say "as of llmcompressor vXX.X, the parameters are --> link-with-git-tag, possibly sending people to outdated configuration a year from now.
  • or we don't git tag and the line might change with refactoring.

Signed-off-by: Mamy Ratsimbazafy <mamy_github@numforge.co>
@github-actions
Copy link

👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review.

Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @mratsim, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a documentation inaccuracy by updating a broken internal link within the QuIPModifier section of the examples/transform/README.md. The change ensures that users are directed to the correct source file for QuIPModifier arguments, improving the clarity and usability of the documentation.

Highlights

  • Documentation Fix: Corrected an outdated link in the examples/transform/README.md file, which previously pointed to SpinQuant instead of the correct QuIP module for QuIPModifier docstrings.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly fixes a broken link in the examples/transform/README.md documentation, where the link for QuIPModifier was pointing to the spinquant implementation instead of the quip one. The change is accurate and improves the documentation. I have added one suggestion to use a relative path for the link to ensure it works correctly for users viewing the file locally after cloning the repository. Additionally, the change to add a newline at the end of the file is a good practice.

Copy link
Collaborator

@kylesayrs kylesayrs left a comment

Choose a reason for hiding this comment

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

Thanks for the fix! I think linking to the entire file should be fine for now, as linking to lines has the drawbacks you mentioned as well as issues with forward compatability.

@kylesayrs kylesayrs added the ready When a PR is ready for review label Nov 10, 2025
Copy link
Collaborator

@brian-dellabetta brian-dellabetta left a comment

Choose a reason for hiding this comment

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

Thanks for the fix! I think most projects circumvent the changing line number issue with building api docs and pointing to them. I think that would be a better long-term solution

@brian-dellabetta brian-dellabetta merged commit 9a8dc1f into vllm-project:main Nov 10, 2025
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready When a PR is ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants