Skip to content

Update README to include Ascend NPU - #2698

Merged
csukuangfj merged 1 commit into
k2-fsa:masterfrom
csukuangfj:update-readme
Oct 18, 2025
Merged

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

Conversation

@csukuangfj

@csukuangfj csukuangfj commented Oct 18, 2025 •

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Updated platform support documentation to include Ascend NPU as a supported platform.
    • Improved formatting and alignment of platform architecture information in the Supported platforms table.

@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Oct 18, 2025
@coderabbitai

coderabbitai Bot commented Oct 18, 2025 •

Copy link
Copy Markdown

Walkthrough

The pull request updates the README.md documentation to include Ascend NPU as a newly supported platform in the Supported platforms table. Table formatting is adjusted for alignment and content consistency across architecture rows.

Changes

Cohort / File(s) Summary
Documentation
README.md
Updates Supported platforms table to include Ascend NPU as a supported platform; applies formatting adjustments for table alignment

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

size:XS

Poem

🐰 Ascend, ascend to heights so new,
A platform added to our crew,
The table gleams with formats bright,
Documentation shining right! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "Update README to include Ascend NPU" is fully related to the main change in the changeset. The actual modification adds Ascend NPU to the Supported platforms table in README.md, and the title accurately and specifically describes this action. The title is concise, clear, and uses descriptive language that directly conveys the primary change without vagueness or misleading information. A teammate scanning the pull request history would immediately understand that this PR adds Ascend NPU platform support to the documentation.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 027871d and 360392d.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

69-69: Unordered list indentation
Expected: 0; Actual: 2

(MD007, ul-indent)

🔇 Additional comments (1)
README.md (1)

24-28: Supported platforms table formatting looks good.

The alignment adjustments to the Supported platforms table are consistent and maintain the tabular structure properly.

Comment thread README.md
on the following platforms and operating systems:

- x86, ``x86_64``, 32-bit ARM, 64-bit ARM (arm64, aarch64), RISC-V (riscv64), **RK NPU**
- x86, ``x86_64``, 32-bit ARM, 64-bit ARM (arm64, aarch64), RISC-V (riscv64), **RK NPU**, **Ascend NPU**

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix markdown list indentation per markdownlint MD007.

Line 69 has a 2-space indentation, but the markdownlint MD007 rule expects unordered list items to start at column 0. Remove the leading 2 spaces to align with markdown style conventions.

-  - x86, ``x86_64``, 32-bit ARM, 64-bit ARM (arm64, aarch64), RISC-V (riscv64), **RK NPU**, **Ascend NPU**
+- x86, ``x86_64``, 32-bit ARM, 64-bit ARM (arm64, aarch64), RISC-V (riscv64), **RK NPU**, **Ascend NPU**
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- x86, ``x86_64``, 32-bit ARM, 64-bit ARM (arm64, aarch64), RISC-V (riscv64), **RK NPU**, **Ascend NPU**
- x86, ``x86_64``, 32-bit ARM, 64-bit ARM (arm64, aarch64), RISC-V (riscv64), **RK NPU**, **Ascend NPU**
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

69-69: Unordered list indentation
Expected: 0; Actual: 2

(MD007, ul-indent)

🤖 Prompt for AI Agents
In README.md around line 69, the unordered list item has a 2-space indentation
which violates markdownlint MD007; remove the two leading spaces so the list
item starts at column 0 (aligning it with other list items) to fix the
indentation and satisfy MD007.

@csukuangfj
csukuangfj merged commit ab95463 into k2-fsa:master Oct 18, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant