Skip to content

[Doc] Improved README.md content and English grammar and integrated the DeepWiki badge for Ask AI#345

Merged
RuixuanZhang06 merged 3 commits intosgl-project:mainfrom
Agent-Skill-007:main
Jan 26, 2026
Merged

[Doc] Improved README.md content and English grammar and integrated the DeepWiki badge for Ask AI#345
RuixuanZhang06 merged 3 commits intosgl-project:mainfrom
Agent-Skill-007:main

Conversation

@Agent-Skill-007
Copy link
Contributor

What this PR does / why we need it?

[Doc] Improved README.md content and English grammar and integrated the DeepWiki badge for Ask AI

Does this PR introduce any user-facing change?

None

How was this patch tested?

None

…he DeepWiki badge for Ask AI

Signed-off-by: Mitchell-xiyunfeng <3617237115@qq.com>
…he DeepWiki badge for Ask AI

Signed-off-by: Mitchell-xiyunfeng <3617237115@qq.com>
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Mitchell-xiyunfeng, 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 significantly enhances the project's documentation by revamping the README.md. The update provides a much clearer and more detailed introduction to the SGLang-Kernel-NPU library, outlines its core components and extensive features, and integrates a DeepWiki badge for AI-powered assistance. These changes aim to improve user understanding and project accessibility without altering any functional code.

Highlights

  • README Content Enhancement: The README.md has been significantly expanded with a new "Introduction" and a detailed "Features" section, providing a comprehensive overview of the SGLang-Kernel-NPU library and its components.
  • DeepWiki Badge Integration: A DeepWiki badge has been added to the README.md to facilitate "Ask AI" functionality for the project.
  • English Grammar and Clarity Improvements: Minor English grammar corrections and improvements in clarity have been applied throughout the README.md, particularly in the performance sections.
  • Detailed Feature Breakdown: New sections detail the capabilities of DeepEP-Ascend (communication modes, key capabilities) and SGLang-Kernel-NPU (various optimized inference kernels like attention, normalization, LoRA, etc.).

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 significantly improves the README.md file by adding a detailed introduction, a comprehensive list of features, and improving the overall structure and grammar. The new content is much more informative for users and provides a great overview of the project's capabilities. I have one minor suggestion to ensure the project name is used consistently throughout the document. Overall, this is an excellent documentation update.

…he DeepWiki badge for Ask AI

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@RuixuanZhang06 RuixuanZhang06 merged commit 4b6b059 into sgl-project:main Jan 26, 2026
1 check passed
Yael-X added a commit to Yael-X/sgl-kernel-npu that referenced this pull request Jan 26, 2026
* 'main' of https://github.com/sgl-project/sgl-kernel-npu: (24 commits)
  [Doc] Improved README.md content and English grammar and integrated the DeepWiki badge for Ask AI (sgl-project#345)
  (test) add solve_tril from upstream (sgl-project#339)
  Add AscendC triangular inverse (sgl-project#332)
  support the situation that topk maybe -1 on machine A3 (sgl-project#313)
  chunk_gated_delta_rule_npu output final state (sgl-project#341)
  The environment variable DEEPEP_HCCL_BUFFSIZE is added, and the priority of DEEPEP_HCCL_BUFFSIZE is higher than that of HCCL_BUFFSIZE. (sgl-project#329)
  Added the low_latency operator API documentation. (sgl-project#337)
  Added the verification of num_max_dispatch_tokens_per_rank to the decode operator adaptation layer. (sgl-project#330)
  Document get_dispatch_layout API (sgl-project#338)
  【Doc】add fused deep moe doc (sgl-project#335)
  add deepep normal api doc (sgl-project#336)
  remove the limit that A2 internode only support topk 8 (sgl-project#323)
  Optimize the performance of the Combine Ant Moving function and the use of HCCL buffer (sgl-project#314)
  deepep adapt custom cann installation path (sgl-project#327)
  [Chore] CANN version bump to 8.5.0 (sgl-project#326)
  add dfx for operator FusedDeepMoe (sgl-project#317)
  Integrate ccache for faster compilation (sgl-project#318)
  Modify contribution guide (sgl-project#315)
  fix bmm transpose in cann 8.5 (sgl-project#316)
  fix little batchsize and int8 quant on ci (sgl-project#302)
  ...
zhuyutong332 added a commit to zhuyutong332/sgl-kernel-npu that referenced this pull request Jan 27, 2026
* upstream/main:
  add function for deep-ep tests (sgl-project#301)
  [Doc] Improved README.md content and English grammar and integrated the DeepWiki badge for Ask AI (sgl-project#345)
  (test) add solve_tril from upstream (sgl-project#339)
  Add AscendC triangular inverse (sgl-project#332)
  support the situation that topk maybe -1 on machine A3 (sgl-project#313)
  chunk_gated_delta_rule_npu output final state (sgl-project#341)
  The environment variable DEEPEP_HCCL_BUFFSIZE is added, and the priority of DEEPEP_HCCL_BUFFSIZE is higher than that of HCCL_BUFFSIZE. (sgl-project#329)
  Added the low_latency operator API documentation. (sgl-project#337)
  Added the verification of num_max_dispatch_tokens_per_rank to the decode operator adaptation layer. (sgl-project#330)
  Document get_dispatch_layout API (sgl-project#338)
  【Doc】add fused deep moe doc (sgl-project#335)
  add deepep normal api doc (sgl-project#336)
  remove the limit that A2 internode only support topk 8 (sgl-project#323)
  Optimize the performance of the Combine Ant Moving function and the use of HCCL buffer (sgl-project#314)
  deepep adapt custom cann installation path (sgl-project#327)
  [Chore] CANN version bump to 8.5.0 (sgl-project#326)
  add dfx for operator FusedDeepMoe (sgl-project#317)
  Integrate ccache for faster compilation (sgl-project#318)
1329009851 added a commit to 1329009851/sgl-kernel-npu that referenced this pull request Feb 11, 2026
…-npu into sgl-cmake2

* 'sgl-cmake2' of https://github.com/1329009851/sgl-kernel-npu:
  CI execution requirements for separating a2 and a3 (sgl-project#367)
  Fix the bug that total expert num greater than 256 or local expert num is less than 8 (sgl-project#364)
  adapt ant moving to A2 single machine (sgl-project#362)
  reset ci -- run test mixed running for experts on a2. (sgl-project#365)
  Revert "Build the deepep package with the chip model included. (sgl-project#274)" (sgl-project#363)
  fix:buffer control (sgl-project#361)
  Build the deepep package with the chip model included. (sgl-project#274)
  bugfix wrong packages build dir (sgl-project#360)
  bump version to 2026.02.01 (sgl-project#359)
  Cover the workflows cases on a3 (sgl-project#321)
  release follows naming convention (sgl-project#356)
  Modify notifydispatch to support DEEPEP_NORMAL_LONG_SEQ_ROUND up to 128. (sgl-project#352)
  fix the hanging bug (sgl-project#355)
  [Bugfix] Fix build script working with cann 8.5.0 (sgl-project#354)
  Modify the description of DeepEP in the README file. (sgl-project#348)
  Revert "Add scripts for building CMake files (sgl-project#344)" (sgl-project#353)
  Add scripts for building CMake files (sgl-project#344)
  Support x86_64 and aarch64 binary release (sgl-project#325)
  add function for deep-ep tests (sgl-project#301)
  [Doc] Improved README.md content and English grammar and integrated the DeepWiki badge for Ask AI (sgl-project#345)
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