Star0
0
代码
代码
Issues
Pull Requests
Actions
项目讨论
Wiki
分析
Star0
0
cann-robotcann-robot修正英文文档导航链接指向中文页面
262dd62e创建于 1 天前历史提交
文件最后提交记录最后更新时间
en
修正英文文档导航链接指向中文页面 Co-authored-by: KaranocaVe<karanocave@qq.com> # message auto-generated for no-merge-commit merge: !124 merge fix/english-doc-navigation-links into master 修正英文文档导航链接指向中文页面 Created-by: KaranocaVe Commit-by: KaranocaVe Merged-by: cann-robot Description: # 修正英文文档导航链接指向中文页面 ## 描述 将英文 README、文档目录、快速开始和算子调用指南中的 18 个导航链接改为对应的英文页面，并修正两个英文章节锚点。链接目标均已存在，修复后英文导航会保持在英文内容中。 ## 测试 在固定提交上，链接错配扫描由 18 项降至 0；补丁正向应用、git diff --check 和反向应用检查均通过。 ## 文档更新 更新 README_en.md、docs/README_en.md、docs/QUICKSTART_en.md 和 docs/en/invocation/quick_op_invocation.md 中的相对链接。没有运行时或源码改动。 ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他 ## 关联的Issue 关联 Issue: https://gitcode.com/cann/ops-ras/issues/50 See merge request: cann/ops-ras!124
1 天前
zh
[L1] docs: 修复 op_debug_prof 中英文文档的 Simulator 链接失效（含中文锚点） Co-authored-by: eieiei<3901796952@qq.com> # message auto-generated for no-merge-commit merge: !112 merge fix-op-debug-prof-links into master [L1] docs: 修复 op_debug_prof 中英文文档的 Simulator 链接失效（含中文锚点） Created-by: wsnidie1 Commit-by: eieiei Merged-by: cann-robot Description: 关联 Issue: #42 ### Describe the current behavior / 问题描述 (Mandatory / 必填) docs/zh/debug/op_debug_prof.md 与 docs/en/debug/op_debug_prof.md 中指向 CANN Simulator 的 3 处链接失效： | # | 位置 | master 原文 | 问题 | |---|---|---|---| | 1 | docs/en/debug/op_debug_prof.md:170 | [CANN Simulator](./cann_simulator.md) | 文件名不存在（实际为 cann_sim.md） | | 2 | docs/en/debug/op_debug_prof.md:190 | ](./cann_simulator.md#simulation-result-analysis-instructions) | 同一文件名错（锚点本身正确） | | 3 | docs/zh/debug/op_debug_prof.md:187 | ](./cann_sim.md#仿真结果解析) | 锚点与标题 # 仿真结果解析说明 不匹配 | ### Steps to reproduce / 重现步骤 无需编译环境，静态可核对： 1. ls docs/en/debug/ docs/zh/debug/ —— 目录下只有 cann_sim.md，不存在 cann_simulator.md； 2. 点击文档中 3 处 Simulator 链接 → 404 / 锚点不跳转。 ### Describe the expected behavior / 预期结果 三处链接均可正常跳转：英文侧两处指向 ./cann_sim.md，中文侧锚点补全为 #仿真结果解析说明。 ### 根因原因 (Root Cause) 文档重命名（cann_simulator.md → cann_sim.md）与中文标题增补（「仿真结果解析」→「仿真结果解析说明」）时未同步更新引用处。 ### 修复方案 (Solution) - docs/en/debug/op_debug_prof.md L170/L190：./cann_simulator.md → ./cann_sim.md（锚点不变）； - docs/zh/debug/op_debug_prof.md L187：锚点 #仿真结果解析 → #仿真结果解析说明。 ### 影响范围 纯文档链接修正（+3/−3），不影响任何代码与功能。 See merge request: cann/ops-ras!112
1 天前
CONTRIBUTING_DOCS.md
修改仓上格式语法问题 Co-authored-by: caiwenwen<caiwenwen6@h-partners.com> # message auto-generated for no-merge-commit merge: !75 merge master into master 修改仓上格式语法问题 Created-by: caiwenwen Commit-by: caiwenwen Merged-by: cann-robot Description: ## 描述 开源修改仓上的语法问题、产品支持情况格式，中英文空格 ## 关联的Issue 关联Issue [#7](https://gitcode.com/cann/ops-ras/issues/7) ## 测试 <!--描述进行了哪些测试来验证你的改动。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-ras!75
2 个月前
CONTRIBUTING_DOCS_en.md
docs: add comprehensive English documentation set Co-authored-by: LiuZonggu<liuzonggu1@huawei.com> # message auto-generated for no-merge-commit merge: !76 merge docs/eng-ver into master docs: add comprehensive English documentation set Created-by: LiuZonggu Commit-by: LiuZonggu Merged-by: cann-robot Description: ## 描述 Add a comprehensive English documentation set for ops-ras: - Add root-level English project documentation, including the README, contribution guide, security statement, and changelog. - Add English entry points for the documentation center, quick start, and documentation contribution guidance. - Add English guides for installation, source builds, operator invocation, AI Core and AI CPU operator development, graph-mode adaptation, cross-platform migration, simulator usage, debugging, and performance tuning. - Add English references for operator concepts, data types, data formats, broadcasting, type conversion and promotion, quantization, sparsity, non-contiguous tensors, return codes, and two-stage APIs. - Add English operator and aclnn API lists. - Add the figures referenced by the new documentation. - Remove the placeholder docs/en/.gitignore now that the English documentation directory contains actual content. ## 关联的Issue [#8](https://gitcode.com/cann/ops-ras/issues/8) ## 测试 ## 文档更新 Added English project-level and detailed documentation covering the project overview, contribution process, security guidance, changelog, documentation navigation, quick start, installation, compilation, invocation, operator development, debugging, operator references, API references, basic concepts, quantization, sparsity, and supporting figures. ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-ras!76
2 个月前
QUICKSTART.md
docs: 修复 QUICKSTART 易用性问题并补充构建 FAQ 与 _tiling 命名约束 Co-authored-by: LiuZonggu<liuzonggu1@huawei.com> # message auto-generated for no-merge-commit merge: !107 merge docs/install-guide-usability into master docs: 修复 QUICKSTART 易用性问题并补充构建 FAQ 与 _tiling 命名约束 Created-by: LiuZonggu Commit-by: LiuZonggu Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 完善本仓文档易用性（中英文版本同步修改）： - **QUICKSTART.md / QUICKSTART_en.md**：运行样例命令统一补充 --soc 参数，并说明其取值须与编译算子包时一致，否则可能报 error 161001（如 aclnnXxxGetWorkspaceSize failed）；章节开头整合多场景编译指引（单算子/整库/离线编译），链接《build参数说明》与《源码构建指南》。 - **docs/zh/install/compile.md / docs/en/install/compile.md**：新增 FAQ 章节，说明安装自定义 run 包报错权限不足的两种处理方式（推荐 --install-path 安装到用户可写路径并加载 set_env.bash；或使用 sudo -E 安装到系统 CANN 目录）。 - **CONTRIBUTING.md / CONTRIBUTING_en.md**：算子最小交付件树补充可选的子场景 Tiling 文件（${op_name}_tiling_${sub_case}.cpp/.h），增加指向项目目录结构文档的链接，并补充 _tiling 命名约束说明。 - **docs/zh/install/dir_structure.md / docs/en/install/dir_structure.md**：op_host 目录树补充 Tiling 交付件说明及 _tiling 命名约束。 根因说明：cmake/func.cmake 通过 file(GLOB ... *_tiling*.cpp) 收集 Tiling 源文件参与编译，不含 _tiling 的文件不会被 glob 命中，因而静默不编译，该约束此前未在文档中披露。 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> https://gitcode.com/cann/ops-ras/issues/36 ## 测试 <!--描述进行了哪些测试来验证你的改动。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> - docs/QUICKSTART.md - docs/zh/install/compile.md - CONTRIBUTING.md - docs/zh/install/dir_structure.md - docs/QUICKSTART_en.md - docs/en/install/compile.md - CONTRIBUTING_en.md - docs/en/install/dir_structure.md ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-ras!107
26 天前
QUICKSTART_en.md
修正英文文档导航链接指向中文页面 Co-authored-by: KaranocaVe<karanocave@qq.com> # message auto-generated for no-merge-commit merge: !124 merge fix/english-doc-navigation-links into master 修正英文文档导航链接指向中文页面 Created-by: KaranocaVe Commit-by: KaranocaVe Merged-by: cann-robot Description: # 修正英文文档导航链接指向中文页面 ## 描述 将英文 README、文档目录、快速开始和算子调用指南中的 18 个导航链接改为对应的英文页面，并修正两个英文章节锚点。链接目标均已存在，修复后英文导航会保持在英文内容中。 ## 测试 在固定提交上，链接错配扫描由 18 项降至 0；补丁正向应用、git diff --check 和反向应用检查均通过。 ## 文档更新 更新 README_en.md、docs/README_en.md、docs/QUICKSTART_en.md 和 docs/en/invocation/quick_op_invocation.md 中的相对链接。没有运行时或源码改动。 ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他 ## 关联的Issue 关联 Issue: https://gitcode.com/cann/ops-ras/issues/50 See merge request: cann/ops-ras!124
1 天前
README.md
docs目录基本概念章节文件名中文改英文 Co-authored-by: chenjiao<chenjiao31@huawei.com> # message auto-generated for no-merge-commit merge: !73 merge master into master docs目录基本概念章节文件名中文改英文 Created-by: gitcode-chenjiao Commit-by: chenjiao Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> docs目录基本概念md文件名改为英文： 避免link中的中文字符引发的跳转异常，例如两段式接口.md变成%E4%B8%A4%E6%AE%B5%E5%BC%8F%E6%8E%A5%E5%8F%A3.md，不易于维护，可能导致其他平台跳转有问题。 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> NA ## 测试 <!--描述进行了哪些测试来验证你的改动。--> ok ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> docs/zh/context所有md和对应的link ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x ] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-ras!73
2 个月前
README_en.md
修正英文文档导航链接指向中文页面 Co-authored-by: KaranocaVe<karanocave@qq.com> # message auto-generated for no-merge-commit merge: !124 merge fix/english-doc-navigation-links into master 修正英文文档导航链接指向中文页面 Created-by: KaranocaVe Commit-by: KaranocaVe Merged-by: cann-robot Description: # 修正英文文档导航链接指向中文页面 ## 描述 将英文 README、文档目录、快速开始和算子调用指南中的 18 个导航链接改为对应的英文页面，并修正两个英文章节锚点。链接目标均已存在，修复后英文导航会保持在英文内容中。 ## 测试 在固定提交上，链接错配扫描由 18 项降至 0；补丁正向应用、git diff --check 和反向应用检查均通过。 ## 文档更新 更新 README_en.md、docs/README_en.md、docs/QUICKSTART_en.md 和 docs/en/invocation/quick_op_invocation.md 中的相对链接。没有运行时或源码改动。 ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他 ## 关联的Issue 关联 Issue: https://gitcode.com/cann/ops-ras/issues/50 See merge request: cann/ops-ras!124
1 天前
quant_mode_introduction.md
docs: add comprehensive English documentation set Co-authored-by: LiuZonggu<liuzonggu1@huawei.com> # message auto-generated for no-merge-commit merge: !76 merge docs/eng-ver into master docs: add comprehensive English documentation set Created-by: LiuZonggu Commit-by: LiuZonggu Merged-by: cann-robot Description: ## 描述 Add a comprehensive English documentation set for ops-ras: - Add root-level English project documentation, including the README, contribution guide, security statement, and changelog. - Add English entry points for the documentation center, quick start, and documentation contribution guidance. - Add English guides for installation, source builds, operator invocation, AI Core and AI CPU operator development, graph-mode adaptation, cross-platform migration, simulator usage, debugging, and performance tuning. - Add English references for operator concepts, data types, data formats, broadcasting, type conversion and promotion, quantization, sparsity, non-contiguous tensors, return codes, and two-stage APIs. - Add English operator and aclnn API lists. - Add the figures referenced by the new documentation. - Remove the placeholder docs/en/.gitignore now that the English documentation directory contains actual content. ## 关联的Issue [#8](https://gitcode.com/cann/ops-ras/issues/8) ## 测试 ## 文档更新 Added English project-level and detailed documentation covering the project overview, contribution process, security guidance, changelog, documentation navigation, quick start, installation, compilation, invocation, operator development, debugging, operator references, API references, basic concepts, quantization, sparsity, and supporting figures. ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-ras!76
2 个月前
README

文档中心

目录结构

Docs目录结构说明如下：

├── zh
  ├── context                            # 公共文档，如术语、基础概念等
  ├── debug                              # 算子调试指导文档
  │   ├── cann_sim.md
  │   ├── op_debug_prof.md
  │   └── ...
  ├── develop                            # 算子开发指导文档
  │   ├── aicore_develop_guide.md
  │   ├── aicpu_develop_guide.md
  │   ├── cross_platform_migration_guide.md
  │   ├── graph_develop_guide.md
  │   └── ...
  ├── figures                            # 图片目录
  ├── install                            # 环境安装和编译指导文档
  │   ├── build.md
  │   ├── compile.md
  │   ├── dir_structure.md
  │   ├── quick_install.md
  │   └── ...
  ├── invocation                         # 算子调用指导文档（包括aclnn调用、图模式调用等）
  │   ├── quick_op_invocation.md
  │   ├── op_invocation.md
  │   └── ...
  ├── op_api_list.md                     # 全量算子接口列表（aclnn）
  ├── op_list.md                         # 全量算子列表
├── CONTRIBUTING_DOCS.md                 # 文档贡献说明
├── QUICKSTART.md                        # 快速入门
└── README.md

进阶教程

指南类文档

文档 说明
源码构建指南 介绍联网/未联网场景下不同的源码构建方式和验证方法。
算子调用指南 介绍调用算子样例方法和不同算子调用方式（如aclnn/图等）。
标准算子开发指南 介绍如何基于标准工程定义算子原型、实现Tiling和Kernel，此类算子称为"标准算子"。
标准算子支持aclnn和图模式调用。
简易算子开发指南 介绍如何基于简易工程实现fast_kernel_launch，即<<<>>>方式，此类算子称为"简易算子"。
简易算子仅支持PyTorch调用。
算子调试调优 介绍常见的算子功能调试和性能调优方法（如数据采集和仿真流水等）。

API类文档

文档 说明
算子列表 介绍项目包含的所有算子清单。
aclnn列表 介绍项目包含的所有算子aclnn API清单。为方便用户在Host侧调用算子，提供了C语言API，即aclnn前缀的API。

工具类文档

文档 说明
Simulator仿真工具 面向算子开发场景的SoC级仿真工具，用于分析运行在AI仿真器上AI任务在各阶段精度和性能数据。

更多文档

附录

文档 说明
算子基本概念 介绍算子领域相关的基础概念和术语，如量化/稀疏、数据类型、数据格式等。
build参数说明 介绍本项目build.sh参数功能和取值，包括源码编译、算子调用、调试等。