已合并
修正英文文档导航链接指向中文页面 #124
KaranocaVe创建于 9月26日
修正英文文档导航链接指向中文页面 #124
已合并
共 4 个文件变更+16-16
| @@ -31,7 +31,7 @@ Note that to ensure smooth custom development of your source code, select the ma | |||
| 31 | 31 | ||
| 32 | ## 🛠️Environment Setup | 32 | ## 🛠️Environment Setup |
| 33 | 33 | ||
| 34 | -[Environment Deployment](docs/zh/install/quick_install.md) is the prerequisite for experiencing the capabilities of this project. Please complete the NPU driver installation, CANN package installation, and so on to ensure the environment is normal. | 34 | +[Environment Deployment](docs/en/install/quick_install.md) is the prerequisite for experiencing the capabilities of this project. Please complete the NPU driver installation, CANN package installation, and so on to ensure the environment is normal. |
| 35 | 35 | ||
| 36 | ## ⬇️Source Code Download | 36 | ## ⬇️Source Code Download |
| 37 | 37 | ||
| @@ -46,12 +46,12 @@ git clone -b 9.0.0 https://gitcode.com/cann/ops-ras.git | |||
| 46 | 46 | ||
| 47 | ## 📖Learning Tutorials | 47 | ## 📖Learning Tutorials |
| 48 | 48 | ||
| 49 | -- [Quick Start](docs/QUICKSTART.md): Quickly experience the core basic capabilities of the project from scratch, covering source code compilation, operator invocation, development, debugging, and other operations. | 49 | +- [Quick Start](docs/QUICKSTART_en.md): Quickly experience the core basic capabilities of the project from scratch, covering source code compilation, operator invocation, development, debugging, and other operations. |
| 50 | -- [Advanced Tutorials](docs/README.md): If you need a deeper understanding of the project's compilation and deployment, operator invocation, development, debugging and tuning, and other capabilities, please refer to the documentation center for detailed guidance. | 50 | +- [Advanced Tutorials](docs/README_en.md): If you need a deeper understanding of the project's compilation and deployment, operator invocation, development, debugging and tuning, and other capabilities, please refer to the documentation center for detailed guidance. |
| 51 | 51 | ||
| 52 | ## 💬Related Information | 52 | ## 💬Related Information |
| 53 | 53 | ||
| 54 | -- [Directory Structure](docs/zh/install/dir_structure.md) | 54 | +- [Directory Structure](docs/en/install/dir_structure.md) |
| 55 | - [Contribution Guide](CONTRIBUTING.md) | 55 | - [Contribution Guide](CONTRIBUTING.md) |
| 56 | - [Security Statement](SECURITY.md) | 56 | - [Security Statement](SECURITY.md) |
| 57 | - [License](LICENSE) | 57 | - [License](LICENSE) |
| @@ -4,7 +4,7 @@ | |||
| 4 | 4 | ||
| 5 | This guide aims to help you quickly get started with CANN and the `ops-ras` operator repository. To help you quickly understand the entire process of operator development, we will use the **AddExample** operator as a practical object. Its source code is located in `ops-ras/examples/add_example`. The operation process is as follows: | 5 | This guide aims to help you quickly get started with CANN and the `ops-ras` operator repository. To help you quickly understand the entire process of operator development, we will use the **AddExample** operator as a practical object. Its source code is located in `ops-ras/examples/add_example`. The operation process is as follows: |
| 6 | 6 | ||
| 7 | -1. **[Prerequisites](../README.md)**: Complete the environment setup and source code download by referring to the project README. The process is not repeated here. For the quick start scenario, **CANNLab or Docker deployment is recommended** for simple operation. | 7 | +1. **[Prerequisites](../README_en.md)**: Complete the environment setup and source code download by referring to the project README. The process is not repeated here. For the quick start scenario, **CANNLab or Docker deployment is recommended** for simple operation. |
| 8 | 8 | ||
| 9 | > **Note**: The CANNLab or Docker environment provides the latest version of the CANN package by default. If you need to experience the latest capabilities of the master branch, you can manually set up the environment. | 9 | > **Note**: The CANNLab or Docker environment provides the latest version of the CANN package by default. If you need to experience the latest capabilities of the master branch, you can manually set up the environment. |
| 10 | 10 | ||
| @@ -272,4 +272,4 @@ int main() { | |||
| 272 | 272 | ||
| 273 | ## Conclusion | 273 | ## Conclusion |
| 274 | 274 | ||
| 275 | -After experiencing the above processes, you have basically completed the operator development process. If you want to further contribute new operators or learn more advanced development, debugging, and other skills, please visit the project README to learn about [Advanced Tutorials](../README.md#学习教程) and [Contribution Guide](../README.md#相关信息), and so on. | 275 | +After experiencing the above processes, you have basically completed the operator development process. If you want to further contribute new operators or learn more advanced development, debugging, and other skills, please visit the project README to learn about [Advanced Tutorials](../README_en.md#learning-tutorials) and [Contribution Guide](../README_en.md#related-information), and so on. |
| @@ -41,24 +41,24 @@ The Docs directory structure is described as follows: | |||
| 41 | 41 | ||
| 42 | | Document | Description | | 42 | | Document | Description | |
| 43 | | ------------------------------------------------------------ | ------------------------------------------------------------ | | 43 | | ------------------------------------------------------------ | ------------------------------------------------------------ | |
| 44 | -| [Source Code Build Guide](zh/install/compile.md) | Introduces different source code build methods and verification methods in online and offline scenarios. | | 44 | +| [Source Code Build Guide](en/install/compile.md) | Introduces different source code build methods and verification methods in online and offline scenarios. | |
| 45 | -| [Operator Invocation Guide](zh/invocation/quick_op_invocation.md) | Introduces the method of invoking operator samples and different operator invocation methods (such as aclnn/graph, and so on). | | 45 | +| [Operator Invocation Guide](en/invocation/quick_op_invocation.md) | Introduces the method of invoking operator samples and different operator invocation methods (such as aclnn/graph, and so on). | |
| 46 | -| [Standard Operator Development Guide](zh/develop/aicore_develop_guide.md) | Introduces how to define operator prototypes and implement Tiling and Kernel based on standard engineering. Such operators are called "standard operators".<br>Standard operators support aclnn and graph mode invocation. | | 46 | +| [Standard Operator Development Guide](en/develop/aicore_develop_guide.md) | Introduces how to define operator prototypes and implement Tiling and Kernel based on standard engineering. Such operators are called "standard operators".<br>Standard operators support aclnn and graph mode invocation. | |
| 47 | | [Simple Operator Development Guide](../examples/fast_kernel_launch_example/README.md) | Introduces how to implement fast_kernel_launch based on simple engineering, that is, the `<<<>>>` method. Such operators are called "simple operators".<br>Simple operators only support PyTorch invocation. | | 47 | | [Simple Operator Development Guide](../examples/fast_kernel_launch_example/README.md) | Introduces how to implement fast_kernel_launch based on simple engineering, that is, the `<<<>>>` method. Such operators are called "simple operators".<br>Simple operators only support PyTorch invocation. | |
| 48 | -| [Operator Debugging and Tuning](zh/debug/op_debug_prof.md) | Introduces common operator function debugging and performance tuning methods (such as data collection and simulation pipeline, and so on). | | 48 | +| [Operator Debugging and Tuning](en/debug/op_debug_prof.md) | Introduces common operator function debugging and performance tuning methods (such as data collection and simulation pipeline, and so on). | |
| 49 | 49 | ||
| 50 | ### API Documents | 50 | ### API Documents |
| 51 | 51 | ||
| 52 | | Document | Description | | 52 | | Document | Description | |
| 53 | | ----------------------- | ---------------------- | | 53 | | ----------------------- | ---------------------- | |
| 54 | -| [Operator List](zh/op_list.md) | Introduces the list of all operators included in the project. | | 54 | +| [Operator List](en/op_list.md) | Introduces the list of all operators included in the project. | |
| 55 | -| [aclnn List](zh/op_api_list.md) | Introduces the list of all operator aclnn APIs included in the project. To facilitate users to invoke operators on the Host side, C language APIs are provided, that is, APIs with the aclnn prefix. | | 55 | +| [aclnn List](en/op_api_list.md) | Introduces the list of all operator aclnn APIs included in the project. To facilitate users to invoke operators on the Host side, C language APIs are provided, that is, APIs with the aclnn prefix. | |
| 56 | 56 | ||
| 57 | ### Tool Documents | 57 | ### Tool Documents |
| 58 | 58 | ||
| 59 | | Document | Description | | 59 | | Document | Description | |
| 60 | | ----------------------- | ---------------------- | | 60 | | ----------------------- | ---------------------- | |
| 61 | -| [Simulator Tool](zh/debug/cann_sim.md) | A SoC-level simulation tool for operator development scenarios, used to analyze the precision and performance data of AI tasks running on the AI simulator at each stage. | | 61 | +| [Simulator Tool](en/debug/cann_sim.md) | A SoC-level simulation tool for operator development scenarios, used to analyze the precision and performance data of AI tasks running on the AI simulator at each stage. | |
| 62 | 62 | ||
| 63 | ### More Documents | 63 | ### More Documents |
| 64 | 64 | ||
| @@ -68,5 +68,5 @@ The Docs directory structure is described as follows: | |||
| 68 | 68 | ||
| 69 | | Document | Description | | 69 | | Document | Description | |
| 70 | | ----------------------------------- | ------------------------------------------------------------ | | 70 | | ----------------------------------- | ------------------------------------------------------------ | |
| 71 | -| [Operator Basic Concepts](zh/context/basic_concept.md) | Introduces basic concepts and terminology in the operator domain, such as quantization/sparse, data types, data formats, and so on. | | 71 | +| [Operator Basic Concepts](en/context/basic_concept.md) | Introduces basic concepts and terminology in the operator domain, such as quantization/sparse, data types, data formats, and so on. | |
| 72 | -| [build Parameter Description](zh/install/build.md) | Introduces the functions and parameter values of the build.sh script in this project, including source code compilation, operator invocation, debugging, and so on. | | 72 | +| [build Parameter Description](en/install/build.md) | Introduces the functions and parameter values of the build.sh script in this project, including source code compilation, operator invocation, debugging, and so on. | |
| @@ -3,7 +3,7 @@ | |||
| 3 | ## Prerequisites | 3 | ## Prerequisites |
| 4 | 4 | ||
| 5 | - Environment deployment: Before invoking an operator, complete the basic environment setup by following [Environment Deployment](../install/quick_install.md). | 5 | - Environment deployment: Before invoking an operator, complete the basic environment setup by following [Environment Deployment](../install/quick_install.md). |
| 6 | -- Operator invocation list: The operators available for invocation in the project are listed in [Operator List](../../zh/op_list.md), and the corresponding aclnn interfaces are listed in [aclnn List](../../zh/op_api_list.md). | 6 | +- Operator invocation list: The operators available for invocation in the project are listed in [Operator List](../../en/op_list.md), and the corresponding aclnn interfaces are listed in [aclnn List](../../en/op_api_list.md). |
| 7 | - build.sh: Operator invocation depends on the build.sh script in the root directory. You can view the functions through the `bash build.sh --help` command. For parameter descriptions, refer to [build Parameter Description](../install/build.md). | 7 | - build.sh: Operator invocation depends on the build.sh script in the root directory. You can view the functions through the `bash build.sh --help` command. For parameter descriptions, refer to [build Parameter Description](../install/build.md). |
| 8 | 8 | ||
| 9 | ## Source Code Compilation | 9 | ## Source Code Compilation |