Conversation
Summary of ChangesHello @addsubmuldiv, 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 introduces new documentation aimed at guiding users through the integration of the Twinkle framework with Huawei Ascend NPU hardware. The added guides cover the entire process from environment setup and installation to running specific training examples, understanding NPU-specific configurations, and reviewing feature compatibility. This significantly enhances the framework's usability for users leveraging Ascend NPUs for deep learning tasks, providing a clear path to get started and troubleshoot common issues. Highlights
🧠 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. Changelog
Activity
Using Gemini Code AssistThe 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
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 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
|
![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 adds comprehensive documentation for setting up and using the Twinkle framework on Ascend NPUs. The documentation is provided in both Chinese and English, covering environment requirements, installation, usage examples, and troubleshooting. The guides are well-structured and detailed. My review focuses on improving the clarity and accuracy of external links to ensure users have a smooth setup experience. I've suggested updates to several links that were either pointing to outdated versions, non-direct pages, or incorrect language versions.
| **问题**：CANN 版本与 torch_npu 不兼容。 | ||
|
|
||
| **解决方案**： | ||
| - 参考[昇腾社区版本配套表](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0015.html) |
There was a problem hiding this comment.
The link to the "昇腾社区版本配套表" (Ascend Community Version Compatibility Table) points to a documentation page for a specific and potentially outdated version of CANN (80RC1alpha002). This can be confusing for users, especially since the guide recommends CANN 8.3.RC1 or higher. It's better to link to a more general version mapping page that is kept up-to-date.
Consider using a link like https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/versionmmapping.html.
| - 参考[昇腾社区版本配套表](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0015.html) | |
| - 参考[昇腾社区版本配套表](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/versionmmapping.html) |
| ## 参考资源 | ||
|
|
||
| - [昇腾社区官网](https://www.hiascend.com/) | ||
| - [CANN 软件安装指南](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0001.html) |
There was a problem hiding this comment.
This link to the CANN Software Installation Guide is for a specific, outdated version (80RC1alpha002). This can mislead users. Please link to the main documentation portal where users can select the appropriate version for their setup.
A better link would be the main software installation page for the latest version: https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/latest/softwareinstall/instg/atlasdeploy_03_0001.html.
| - [CANN 软件安装指南](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0001.html) | |
| - [CANN 软件安装指南](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/latest/softwareinstall/instg/atlasdeploy_03_0001.html) |
| **Problem**: CANN version incompatible with torch_npu. | ||
|
|
||
| **Solution**: | ||
| - Refer to [Ascend Community version compatibility table](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0015.html) |
There was a problem hiding this comment.
The link to the "Ascend Community version compatibility table" points to a Chinese documentation page for a specific and outdated CANN version (80RC1alpha002). This is incorrect for an English document and can be confusing. Please use an up-to-date, English link.
Consider using the English version mapping table: https://www.hiascend.com/document/detail/en/CANNCommunityEdition/versionmmapping.html.
| - Refer to [Ascend Community version compatibility table](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0015.html) | |
| - Refer to [Ascend Community version compatibility table](https://www.hiascend.com/document/detail/en/CANNCommunityEdition/versionmmapping.html) |
| ## References | ||
|
|
||
| - [Ascend Community Official Website](https://www.hiascend.com/) | ||
| - [CANN Software Installation Guide](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0001.html) |
There was a problem hiding this comment.
This link to the CANN Software Installation Guide points to a Chinese page for an outdated version (80RC1alpha002). This should be corrected to point to the latest English documentation.
A better link would be: https://www.hiascend.com/document/detail/en/CANNCommunityEdition/latest/softwareinstall/instg/atlasdeploy_03_0001.html.
| - [CANN Software Installation Guide](https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/80RC1alpha002/softwareinstall/instg/atlasdeploy_03_0001.html) | |
| - [CANN Software Installation Guide](https://www.hiascend.com/document/detail/en/CANNCommunityEdition/latest/softwareinstall/instg/atlasdeploy_03_0001.html) |
|
|
||
| NPU 环境的安装包括昇腾驱动、CANN 工具包、PyTorch 和 torch_npu。 | ||
|
|
||
| **📖 完整安装教程**：[torch_npu 官方安装指南](https://gitcode.com/Ascend/pytorch/overview) |
There was a problem hiding this comment.
The link to the torch_npu installation guide points to the project's overview page. For a better user experience, it would be more helpful to link directly to the installation documentation. Also, for consistency with other links in this file (e.g., line 327), consider using the GitHub repository link instead of GitCode.
A more direct link would be: https://github.com/Ascend/pytorch/blob/master/docs/zh/install.md.
| **📖 完整安装教程**：[torch_npu 官方安装指南](https://gitcode.com/Ascend/pytorch/overview) | |
| **📖 完整安装教程**：[torch_npu 官方安装指南](https://github.com/Ascend/pytorch/blob/master/docs/zh/install.md) |
|
|
||
| NPU environment installation includes Ascend driver, CANN toolkit, PyTorch, and torch_npu. | ||
|
|
||
| **📖 Complete Installation Guide**: [torch_npu Official Installation Guide](https://gitcode.com/Ascend/pytorch/overview) |
There was a problem hiding this comment.
The link to the torch_npu installation guide points to the project's overview page on GitCode. For a better user experience and consistency with other links (e.g., line 327 which uses GitHub), it would be more helpful to link directly to the English installation documentation on GitHub.
A more direct link would be: https://github.com/Ascend/pytorch/blob/master/docs/en/install.md.
| **📖 Complete Installation Guide**: [torch_npu Official Installation Guide](https://gitcode.com/Ascend/pytorch/overview) | |
| **📖 Complete Installation Guide**: [torch_npu Official Installation Guide](https://github.com/Ascend/pytorch/blob/master/docs/en/install.md) |
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for NPU (Huawei Ascend) support in the Twinkle framework, providing both English and Chinese versions of the setup guide.
Changes:
- Added English NPU setup guide with installation instructions, requirements, examples, and troubleshooting
- Added Chinese NPU setup guide (translation of the English version)
- Documents supported hardware, parallelism strategies, and feature support matrix for NPU environments
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/source_en/GetStarted/NPU-setup.md | English documentation for NPU setup, including installation steps, verification, quick start examples, parallelism strategies, troubleshooting, and references |
| docs/source/GetStarted/NPU-setup.md | Chinese translation of the NPU setup guide with identical content structure and information |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - 📖 Read [Quick Start](Quick-start.md) for more training examples | ||
| - 📖 Read [Installation Guide](Installation.md) for other platform installations |
There was a problem hiding this comment.
The documentation references "Installation.md" and "Quick-start.md" files that do not exist in the docs/source_en/GetStarted/ directory. These links will be broken for readers of the English documentation. Consider either creating these files in the English documentation directory or updating the links to point to valid resources (such as the Chinese versions or external documentation).
| - 📖 Read [Quick Start](Quick-start.md) for more training examples | |
| - 📖 Read [Installation Guide](Installation.md) for other platform installations | |
| - 📖 Read the **Quick Start** section in [Twinkle Documentation](https://twinkle.readthedocs.io/) for more training examples | |
| - 📖 Read the **Installation Guide** in [Twinkle Documentation](https://twinkle.readthedocs.io/) for other platform installations |
No description provided.