Closed
[Documentation|文档反馈] 根 README.md/README_en.md 引用已改名的 SIMT 样例目录 #147
gao_dafaAdd on  10 days agoClosed at  9 days ago
gao_dafaCollaborators
10 days ago Create

Document Link(文档链接)

Issues Section(问题文档片段)

README.md:28
- 提供SIMT URMA `WriteNbi`、...,以及`simt_urma`功能样例和`simt_urma_perftest`性能样例。

README.md:60
| SIMT URMA样例 | 提供`simt_urma`功能样例,覆盖全部五个接口的单接口、连续提交和batch-last提交;提供`simt_urma_perftest`性能样例,统计下发时延与完成带宽。 |

README_en.md:28 / :55 / :58 / :60(同内容的英文描述)

Existing Issues(存在的问题)

commit 94c5e6b 将 SIMT 样例目录改名:04_simt_urma → 04_simt_hcomm_urma、05_simt_urma_perftest → 05_simt_hcomm_urma_perftest。根 README(中英两版)仍用旧目录名指代样例,读者按名字在 examples/aicore/hcomm/ 下查找会找不到 04_simt_urma(实际存在的是 04_simt_hcomm_urma)。

说明:两个样例的可执行文件名仍是 simt_urma/simt_urma_perftest(CMakeLists.txt:24 add_executable(simt_urma)),因此文中的二进制名本身没错;需要修正的是把它们描述为"样例目录名"时的指代,或统一补上实际目录名,避免读者按图索骥失败。

修复建议(Fix Suggestion)

README.md:28 与 README_en.md:28(保持二进制名,同时补出真实目录名):

-- 提供SIMT URMA `WriteNbi`、`WriteValueNbi`、`ReadNbi`、`WriteWithNotifyNbi`、`AtomicFAA`、`AtomicCAS`和`Drain`,以及`simt_urma`功能样例和`simt_urma_perftest`性能样例。
+- 提供SIMT URMA `WriteNbi`、`WriteValueNbi`、`ReadNbi`、`WriteWithNotifyNbi`、`AtomicFAA`、`AtomicCAS`和`Drain`,以及`simt_urma`功能样例(`examples/aicore/hcomm/04_simt_hcomm_urma`)和`simt_urma_perftest`性能样例(`examples/aicore/hcomm/05_simt_hcomm_urma_perftest`)。

README.md:60 与 README_en.md:60 表格行同步补目录名:

-| SIMT URMA样例 | 提供`simt_urma`功能样例,覆盖全部五个接口的单接口、连续提交和batch-last提交;提供`simt_urma_perftest`性能样例,统计下发时延与完成带宽。 |
+| SIMT URMA样例 | 提供`simt_urma`功能样例(`examples/aicore/hcomm/04_simt_hcomm_urma`),覆盖全部五个接口的单接口、连续提交和batch-last提交;提供`simt_urma_perftest`性能样例(`examples/aicore/hcomm/05_simt_hcomm_urma_perftest`),统计下发时延与完成带宽。 |

验证方式:ls examples/aicore/hcomm/ 确认 04_simt_hcomm_urma、05_simt_hcomm_urma_perftest 存在;ls examples/aicore/hcomm/04_simt_hcomm_urma/build 确认可执行文件名为 simt_urma。

likedislike
Ggao_dafaCollaborators
10 days ago Added label: documentation
Wwx369Collaborators
9 days ago Associated pull request
Wwx369Collaborators
9 days ago Assign wx369 as responsible person
wx369Collaborators
9 days ago Comments:

您好,感谢您的反馈,相关修改已在进行,近期回合入master

likedislike
Wwx369Collaborators
9 days ago changed custom state from 进行中 to 已完成
Wwx369Collaborators
9 days ago Close issue
CANN-robotCANN-robotCollaborators
9 days ago Added label: resolved