master

cann-robot自动选取可用网卡

0e6fffaa创建于 19 小时前历史提交

文件	最后提交记录	最后更新时间
def.rst	文档结构调整 Co-authored-by: zhangyunqi<zhangyunqi5@huawei.com> # message auto-generated for no-merge-commit merge: !156 merge dox_fix into master 文档结构调整 Created-by: zhangyunqi Commit-by: zhangyunqi Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 日志文档调整 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #123--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> https://gitcode.com/cann/shmem/issues/127 ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 结构调整 ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/shmem!156	2 个月前
device_api.rst	docs: register UDMA device header so its API docs render (#227) Co-authored-by: suqwe<sujianjia@huawei.com> # message auto-generated for no-merge-commit merge: !339 merge fix/issue-227-udma-doc into master docs: register UDMA device header so its API docs render (#227) Created-by: suqwe Commit-by: suqwe Merged-by: cann-robot Description: ### 关联 Issue Fix #227 — 文档站点缺失 UDMA 接口（aclshmemx_udma_put_nbi、aclshmemx_udma_put_signal_nbi、aclshmemx_udma_quiet 等）的描述。 ### 根因分析 文档站点 https://shmem-doc.pages.dev/ 由 scripts/build.sh::fn_gen_doc 自动生成，流水线为 **Doxygen → XML → Sphinx + Breathe**： - Doxygen 已经扫描 include/device/gm2gm/engine/shmem_device_udma.h（其位于 INPUT 根 include/device 之下，见 scripts/build.sh:278），UDMA 接口的 @brief/@param 注释也已经齐全。 - 但 Sphinx 仅渲染 docs/api/*.rst 中通过 .. doxygenfile:: 显式注册的头文件。 - gm2gm/engine/ 目录下其他兄弟头 (shmem_device_mte.h、shmem_device_rdma.h、shmem_device_sdma.h) 都已在 device_api.rst 注册，唯独 UDMA 头被遗漏 → Doxygen 已生成的 UDMA XML 节点最终未被 Breathe 渲染，所以 Pages 上看不到这些接口。 也就是说 issue 描述里"资料是通过注释自动生成的"是对的，但仅有源码注释还不够，必须把头文件登记到 device_api.rst 才能流转到最终 HTML。 ### 修改内容 docs/api/device_api.rst 在 shmem_device_rma.h 章节追加： ```rst .. doxygenfile:: gm2gm/engine/shmem_device_udma.h :project: ACLSHMEM_CPP_API ``` 形式与同级 RDMA/SDMA/MTE 完全一致。源码注释已具备，无需新增。 ### 验证 - 指令形式与既有兄弟条目完全一致。 - 相对路径 gm2gm/engine/shmem_device_udma.h 在 Doxygen INPUT 根 $PROJECT_ROOT/include/device 下可正确解析。 - 下次执行 bash scripts/build.sh -doc 即可重新生成包含 UDMA 章节的 HTML。 ### 测试计划 - [x] 触发 docs 流水线，确认生成的 HTML 中出现 aclshmemx_udma_* 接口 - [x] 检查所有 UDMA 接口的 @param 说明被正确渲染 See merge request: cann/shmem!339	14 天前
env_vars_intro.md	自动选取可用网卡 Co-authored-by: zhangyunqi<zhangyunqi5@huawei.com> # message auto-generated for no-merge-commit merge: !368 merge fix/auto-select-network-interface into master 自动选取可用网卡 Created-by: zhangyunqi Commit-by: zhangyunqi Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 自动选取可用网卡 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #123--> https://gitcode.com/cann/shmem/issues/268 ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> 不指定环境变量自动搜索   指定环境变量  无可用网卡  ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [x] 新特性 - [ ] 性能优化 - [ ] 文档更新 - [ ] 其他，请描述： See merge request: cann/shmem!368	19 小时前
host_api.rst	文档结构调整 Co-authored-by: zhangyunqi<zhangyunqi5@huawei.com> # message auto-generated for no-merge-commit merge: !156 merge dox_fix into master 文档结构调整 Created-by: zhangyunqi Commit-by: zhangyunqi Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 日志文档调整 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #123--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> https://gitcode.com/cann/shmem/issues/127 ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 结构调整 ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/shmem!156	2 个月前
pythonAPI.md	fix: add quiet API, fix put_signal/signal_wait bugs, enhance RMA tests Co-authored-by: Victor<wangsheng325@huawei.com> # message auto-generated for no-merge-commit merge: !340 merge br_fix_api into master fix: add quiet API, fix put_signal/signal_wait bugs, enhance RMA tests Created-by: victor7wang Commit-by: wangsheng;Victor Merged-by: cann-robot Description: ## 描述 fix: add quiet API, fix put_signal/signal_wait bugs, enhance RMA tests ## 关联的Issue [#247](https://gitcode.com/cann/shmem/issues/247) ## 测试  ## 文档更新 docs/api/pythonAPI.md ## 类型标签 <!-- [x] 表示选中 --> - [x] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/shmem!340	7 天前
stream_api_usage.md	增加stream接口的使用说明 Co-authored-by: vector5<caobingjie@huawei.com> # message auto-generated for no-merge-commit merge: !189 merge fix into master 增加stream接口的使用说明 Created-by: vector5 Commit-by: vector5 Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 增加stream接口的使用说明 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #123--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> 不涉及 ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 新增了docs\api\stream_api_usage.md ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： See merge request: cann/shmem!189	2 个月前