Skip to content

Update README to include NPU support - #2830

Merged
csukuangfj merged 1 commit into
k2-fsa:masterfrom
csukuangfj:update-readme
Nov 27, 2025
Merged

csukuangfj merged 1 commit into
k2-fsa:masterfrom
csukuangfj:update-readme

Conversation

@csukuangfj

@csukuangfj csukuangfj commented Nov 27, 2025 •

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

Documentation

  • Added a "Supported NPUs" reference section with a compatibility matrix documenting support for RKNN, QNN, and Ascend neural processing units, along with corresponding documentation references.

✏️ Tip: You can customize this high-level summary in your review settings.

@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Nov 27, 2025
@csukuangfj
csukuangfj merged commit 7d1d227 into k2-fsa:master Nov 27, 2025
1 check was pending
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @csukuangfj, 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 enhances the project's documentation by updating the README.md file. The primary goal is to clearly communicate the project's support for various Neural Processing Units (NPUs), providing users with a quick overview and direct links to relevant documentation for Rockchip, Qualcomm, and Ascend NPUs. This improves discoverability and clarity regarding hardware acceleration capabilities.

Highlights

  • README Update: A new section titled "Supported NPUs" has been added to the README.md file.
  • NPU Support Listing: The new section includes a table detailing support for Rockchip NPU (RKNN), Qualcomm NPU (QNN), and Ascend NPU.
  • Documentation Links: Corresponding documentation links for each of the supported NPUs have been added to the README for easy access.
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. ↩

@csukuangfj
csukuangfj deleted the update-readme branch November 27, 2025 07:24
@coderabbitai

coderabbitai Bot commented Nov 27, 2025 •

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

Walkthrough

README.md receives a new "Supported NPUs" documentation section featuring a three-column table with RKNN, QNN, and Ascend NPUs marked with check marks, accompanied by three new reference links to corresponding documentation resources.

Changes

Cohort / File(s) Change Summary
Documentation: NPU Support
README.md
Added new "Supported NPUs" section with a comparison table covering RKNN, QNN, and Ascend NPUs; added three reference links (rknpu-doc, qnn-doc, ascend-doc) for NPU documentation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 Hop along, the NPUs align,
Three new friends in a table's design,
RKNN, QNN, and Ascend so bright,
Documentation grows, clarity takes flight! ✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6873c3b and eea86b0.

📒 Files selected for processing (1)
  • README.md (2 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Copy link
Copy Markdown

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 README file to include a new section on supported NPUs, listing Rockchip, Qualcomm, and Ascend NPUs. The change is straightforward and improves the documentation. I've suggested a minor formatting improvement to the new table for better readability in the raw markdown source.

Comment thread README.md
Comment on lines +50 to +52
| [1. Rockchip NPU (RKNN)][rknpu-doc] | [2. Qualcomm NPU (QNN)][qnn-doc] | [3. Ascend NPU][ascend-doc] |
|-------------------------------------|-----------------------------------|-----------------------------|
| ✔️ | ✔️ | ✔️ |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The formatting of this table is a bit inconsistent, making it harder to read in its raw markdown form. I suggest cleaning up the spacing, removing unnecessary spaces in the header, and adding alignment markers to improve readability and maintainability.

Suggested change
| [1. Rockchip NPU (RKNN)][rknpu-doc] | [2. Qualcomm NPU (QNN)][qnn-doc] | [3. Ascend NPU][ascend-doc] |
|-------------------------------------|-----------------------------------|-----------------------------|
| ✔️ | ✔️ | ✔️ |
| [1. Rockchip NPU (RKNN)][rknpu-doc] | [2. Qualcomm NPU (QNN)][qnn-doc] | [3. Ascend NPU][ascend-doc] |
|:-----------------------------------:|:--------------------------------:|:---------------------------:|
| ✔️ | ✔️ | ✔️ |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant