已关闭
[Bug-Report|缺陷反馈]: experimental/math/trace_v2/README.md 中 test_trace 链接指向不存在的路径 #2455
gcw_93rlw6ed创建于 8月1日关闭于 8月1日
songkai111
8月1日 评论:
8月1日 评论:
确实存在问题,已安排相关责任人修复


8月1日 关联了pull request:fix: 修复多个文档中的失效链接(#2455/#2456/#2457/#2458/#2459)
8月1日 关闭了 issue
8月1日 添加了label:resolved
一、问题描述 (必填)
文件
experimental/math/trace_v2/README.md第 35 行存在一处失效链接,链接文本为test_trace,target 为../../../math/trace/examples/test_aclnn_trace.cpp。该链接存在两个问题:
问题 1:链接 target 指向的目录不存在
math/trace/examples/目录不存在。math/trace/目录下只有arch35/子目录和test_geir_trace.cpp文件,并没有examples/子目录。问题 2:trace_v2 算子的真实测试文件位于算子自身目录
trace_v2 算子的真实测试文件是
experimental/math/trace_v2/examples/test_aclnn_trace_v2.cpp,即位于算子自身的examples/子目录下,且文件名带_v2后缀。README 中的链接既指向了错误的外部路径math/trace/,又使用了错误的文件名test_aclnn_trace.cpp(缺少_v2后缀)。二、环境信息 (可选)
experimental/math/trace_v2/README.mdls和find验证三、重现步骤 (可选)
git clone -b master https://gitcode.com/cann/ops-math.git && cd ops-mathsed -n '35p' experimental/math/trace_v2/README.md输出:
| aclnn接口 | [test_trace](../../../math/trace/examples/test_aclnn_trace.cpp) | 通过[aclnnTrace]接口方式调用trace算子。 |ls math/trace/examples/→ No such file or directoryls math/trace/→ 只有arch35/和test_geir_trace.cppfind experimental/math/trace_v2 -name "test_aclnn*"→experimental/math/trace_v2/examples/test_aclnn_trace_v2.cppexperimental/math/trace_v2/README.md,点击第 35 行test_trace链接,跳转 404四、预期结果 (可选)
修复
experimental/math/trace_v2/README.md第 35 行链接 target,指向 trace_v2 算子自身 examples 目录下的真实测试文件:[test_trace](../../../math/trace/examples/test_aclnn_trace.cpp)[test_trace](../examples/test_aclnn_trace_v2.cpp)说明:
experimental/math/trace_v2/README.md到experimental/math/trace_v2/examples/test_aclnn_trace_v2.cpp的相对路径是../examples/test_aclnn_trace_v2.cpp(README 所在目录是trace_v2/,向上一级到trace_v2/自身再进examples/,实际就是同目录的examples/子目录,可直接用./examples/test_aclnn_trace_v2.cpp或examples/test_aclnn_trace_v2.cpp)。经核对,正确的相对路径写法为:
[test_trace](./examples/test_aclnn_trace_v2.cpp),与同仓其他算子 README 的链接风格保持一致。五、修复建议 (可选)
该问题根因疑似 trace_v2 算子的 README 从 trace(v1)算子复制而来,未将链接 target 从
math/trace/examples/test_aclnn_trace.cpp更新为 trace_v2 自身的examples/test_aclnn_trace_v2.cpp。建议:./examples/test_aclnn_trace_v2.cpp。experimental/**/README.md中所有指向../../../math/或../../math/的相对链接,校验 target 文件是否真实存在。💡 备注(选填)
本 issue 与 issue #2454(right_shift 算子文档失效链接)属同类问题,建议统一在 CI 中增加相对链接存在性校验。