Skip to content

Update readme#1538

Merged
AlpinDale merged 2 commits into
mainfrom
update_readme
Sep 27, 2025
Merged

Update readme#1538
AlpinDale merged 2 commits into
mainfrom
update_readme

Conversation

@AlpinDale

Copy link
Copy Markdown
Member

Long overdue.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @AlpinDale, 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 focuses on updating the README.md file to provide a more current and comprehensive overview of the Aphrodite inference engine. It removes obsolete information, highlights newly integrated features and expanded quantization support, and refines the quickstart guide and system requirements for improved user experience and clarity.

Highlights

  • README Cleanup: Outdated news and caution sections have been removed from the README to streamline information.
  • Feature Expansion: New capabilities such as disaggregated inference, speculative decoding, multimodal support, and multi-LoRA support have been added to the features list.
  • Quantization Updates: The list of supported quantization methods has been significantly expanded with new entries and detailed links for AQLM, AutoRound, BitNet, EETQ, NVIDIA ModelOpt, TorchAO, VPTQ, compressed_tensors, and MXFP4.
  • Quickstart Example Refinement: The example model in the quickstart command has been updated from 'meta-llama/Meta-Llama-3.1-8B-Instruct' to 'Qwen/Qwen3-0.6B', and a note about using 'aphrodite run -h' for full arguments was added.
  • Docker and System Requirements: The Docker command syntax was corrected from '--api-keys' to '--api-key', the image download size mention was removed, and the Windows operating system requirement now explicitly specifies WSL2.
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.

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

Copy link
Copy Markdown
Contributor

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 updates the main README file to better reflect the current state of the project. The changes include removing an outdated "News" section, expanding the list of supported features and quantization methods, and updating command-line examples for clarity. My review identified a minor inaccuracy in the updated operating system requirements for Windows, which could be misleading. I've provided a suggestion to clarify this. Overall, these changes are a valuable improvement to the project's documentation.

Comment thread README.md
@AlpinDale AlpinDale merged commit e4e54c6 into main Sep 27, 2025
0 of 4 checks passed
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.

1 participant