update doc#9650
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the NPU support documentation in both Chinese and English to include a hardware compatibility table and instructions for using the newly released official NPU images on Quay. The review feedback suggests several improvements: replacing non-standard <term> HTML tags with standard Markdown bold syntax in the compatibility tables, restoring the missing WORKSPACE environment variable in the self-built image instructions to prevent Docker volume mount failures, and updating the CANN installation guide links in the English documentation to point to their English versions instead of the Chinese ones.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
The <term> tag is not a standard HTML or Markdown tag. Using non-standard tags can cause rendering issues across different Markdown parsers (such as GitHub, PyPI, or static site generators). It is recommended to use standard Markdown bold syntax (**) instead.
| |<term>Ascend 950 系列产品</term>|√| | |
| |<term>Atlas A3 训练系列产品</term>|√| | |
| |<term>Atlas A3 推理系列产品</term>|x| | |
| |<term>Atlas A2 训练系列产品</term>|√| | |
| |<term>Atlas A2 推理系列产品</term>|x| | |
| |<term>Atlas 200I/500 A2 推理产品</term>|x| | |
| |<term>Atlas 推理系列产品</term>|x| | |
| |<term>Atlas 训练系列产品</term>|x| | |
| |**Ascend 950 系列产品**|√| | |
| |**Atlas A3 训练系列产品**|√| | |
| |**Atlas A3 推理系列产品**|x| | |
| |**Atlas A2 训练系列产品**|√| | |
| |**Atlas A2 推理系列产品**|x| | |
| |**Atlas 200I/500 A2 推理产品**|x| | |
| |**Atlas 推理系列产品**|x| | |
| |**Atlas 训练系列产品**|x| |
| 当前 `build_image.py` 生成的 Ascend 镜像名格式为 `{DOCKER_REGISTRY}:{swift_branch}-{atlas_hardware}-{python_tag}-{arch}`。以上命令以 ARM 架构的 Atlas 900 A2 PODc 为例，通常会生成 `ms-swift:main-A2-py311-arm`。如果使用自行构建的镜像，请按构建日志中的镜像名替换上面的 `IMAGE_NAME`： | ||
|
|
||
| ```shell | ||
| export IMAGE_NAME=ms-swift:main-A2-py311-arm |
There was a problem hiding this comment.
If a user chooses to build the image themselves, they will skip the first code block (which defines WORKSPACE). This will leave the WORKSPACE environment variable undefined, causing the subsequent docker run command to fail with an invalid volume mount error (e.g., -v :/workspace). Adding export WORKSPACE=/path/to/workspace here ensures the variable is always defined.
| export IMAGE_NAME=ms-swift:main-A2-py311-arm | |
| export IMAGE_NAME=ms-swift:main-A2-py311-arm | |
| export WORKSPACE=/path/to/workspace |
| | <term>Ascend 950 series products</term> | √ | | ||
| | <term>Atlas A3 training series products</term> | √ | | ||
| | <term>Atlas A3 inference series products</term> | x | | ||
| | <term>Atlas A2 training series products</term> | √ | | ||
| | <term>Atlas A2 inference series products</term> | x | | ||
| | <term>Atlas 200I/500 A2 inference products</term> | x | | ||
| | <term>Atlas inference series products</term> | x | | ||
| | <term>Atlas training series products</term> | x | |
There was a problem hiding this comment.
The <term> tag is not a standard HTML or Markdown tag. Using non-standard tags can cause rendering issues across different Markdown parsers. It is recommended to use standard Markdown bold syntax (**) instead.
| | <term>Ascend 950 series products</term> | √ | | |
| | <term>Atlas A3 training series products</term> | √ | | |
| | <term>Atlas A3 inference series products</term> | x | | |
| | <term>Atlas A2 training series products</term> | √ | | |
| | <term>Atlas A2 inference series products</term> | x | | |
| | <term>Atlas 200I/500 A2 inference products</term> | x | | |
| | <term>Atlas inference series products</term> | x | | |
| | <term>Atlas training series products</term> | x | | |
| | **Ascend 950 series products** | √ | | |
| | **Atlas A3 training series products** | √ | | |
| | **Atlas A3 inference series products** | x | | |
| | **Atlas A2 training series products** | √ | | |
| | **Atlas A2 inference series products** | x | | |
| | **Atlas 200I/500 A2 inference products** | x | | |
| | **Atlas inference series products** | x | | |
| | **Atlas training series products** | x | |
| > In this section, "√" indicates supported and "x" indicates not supported. | ||
|
|
||
| - For operating systems supported by each hardware product in physical-machine deployment scenarios, see the [Compatibility Query Assistant](https://www.hiascend.com/hardware/compatibility). | ||
| - For operating systems supported by each hardware product in VM and container deployment scenarios, see "Operating System Compatibility" in CANN Software Installation for the [commercial edition](https://www.hiascend.com/document/detail/zh/canncommercial/900/softwareinst/instg/instg_0101.html?OS=openEuler&InstallType=netyum) or [community edition](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/900/softwareinst/instg/instg_0101.html?OS=openEuler&InstallType=netyum). |
There was a problem hiding this comment.
In the English documentation, the links for the commercial and community editions of the CANN Software Installation guide point to the Chinese version (/zh/). It is recommended to update these links to point to the English version (/en/) to improve the user experience for English-speaking users.
| - For operating systems supported by each hardware product in VM and container deployment scenarios, see "Operating System Compatibility" in CANN Software Installation for the [commercial edition](https://www.hiascend.com/document/detail/zh/canncommercial/900/softwareinst/instg/instg_0101.html?OS=openEuler&InstallType=netyum) or [community edition](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/900/softwareinst/instg/instg_0101.html?OS=openEuler&InstallType=netyum). | |
| - For operating systems supported by each hardware product in VM and container deployment scenarios, see "Operating System Compatibility" in CANN Software Installation for the [commercial edition](https://www.hiascend.com/document/detail/en/canncommercial/900/softwareinst/instg/instg_0101.html?OS=openEuler&InstallType=netyum) or [community edition](https://www.hiascend.com/document/detail/en/CANNCommunityEdition/900/softwareinst/instg/instg_0101.html?OS=openEuler&InstallType=netyum). |
| The current `build_image.py` generates Ascend image names in the format `{DOCKER_REGISTRY}:{swift_branch}-{atlas_hardware}-{python_tag}-{arch}`. The command above uses the ARM-based Atlas 900 A2 PODc as an example and usually generates `ms-swift:main-A2-py311-arm`. If you use a self-built image, replace `IMAGE_NAME` above with the actual image name from your build log. | ||
|
|
||
| ```shell | ||
| export IMAGE_NAME=ms-swift:main-A2-py311-arm |
There was a problem hiding this comment.
If a user chooses to build the image themselves, they will skip the first code block (which defines WORKSPACE). This will leave the WORKSPACE environment variable undefined, causing the subsequent docker run command to fail with an invalid volume mount error (e.g., -v :/workspace). Adding export WORKSPACE=/path/to/workspace here ensures the variable is always defined.
| export IMAGE_NAME=ms-swift:main-A2-py311-arm | |
| export IMAGE_NAME=ms-swift:main-A2-py311-arm | |
| export WORKSPACE=/path/to/workspace |
There was a problem hiding this comment.
Pull request overview
Updates the NPU support best-practices documentation (CN/EN) by adding a hardware/OS compatibility section and refreshing the container installation guidance now that an official Ascend ms-swift image is available on Quay.
Changes:
- Add a “hardware and supported OS” section with a product support table and OS compatibility references.
- Update the container installation section to prefer pulling official
quay.io/ascend/ms-swiftimages and provide a concrete pull example. - Clarify guidance for switching between official images and self-built images.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/source/BestPractices/NPU-support.md | Adds hardware/OS compatibility info and updates container image guidance for the Chinese doc. |
| docs/source_en/BestPractices/NPU-support.md | Mirrors the same hardware/OS and container image documentation updates in English. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| |<term>Ascend 950 系列产品</term>|√| | ||
| |<term>Atlas A3 训练系列产品</term>|√| | ||
| |<term>Atlas A3 推理系列产品</term>|x| | ||
| |<term>Atlas A2 训练系列产品</term>|√| | ||
| |<term>Atlas A2 推理系列产品</term>|x| |
| |<term>Atlas 200I/500 A2 推理产品</term>|x| | ||
| |<term>Atlas 推理系列产品</term>|x| | ||
| |<term>Atlas 训练系列产品</term>|x| |
| > [!NOTE] | ||
| > | ||
| > 本节表格中“√”代表支持，“x”代表不支持。 |
| | <term>Ascend 950 series products</term> | √ | | ||
| | <term>Atlas A3 training series products</term> | √ | | ||
| | <term>Atlas A3 inference series products</term> | x | | ||
| | <term>Atlas A2 training series products</term> | √ | | ||
| | <term>Atlas A2 inference series products</term> | x | |
| | <term>Atlas 200I/500 A2 inference products</term> | x | | ||
| | <term>Atlas inference series products</term> | x | | ||
| | <term>Atlas training series products</term> | x | |
PR type
PR information
Write the detail information belongs to this PR.
Experiment results
Paste your experiment result here(if needed).