已关闭
[Documentation|文档反馈]: index目录README.md格式异常 #1772
daishuangshuang创建于  3月27日关闭于  4月10日
daishuangshuang
3月27日 创建

Document Link(文档链接)

https://gitcode.com/cann/ops-nn/tree/master/index

Issues Section(问题文档片段)

文档: index/scatter_nd/README.md
位置: 调用说明
问题描述: 文档写"调用 ScatterAdd 算子",实际目录是 ScatterNd


文档: index/index_put_v2/README.md
位置: 调用说明
问题描述: 引用接口名称为 aclnnAbs,实际应为 aclnnIndexPutImpl


文档: index/embedding/docs/aclnnEmbedding.md
位置: 第3行源码链接
问题描述: 链接路径 embeddiing 拼写错误(多了一个 i)


文档: index/gather_v2/README.md
位置: 参数说明/batch_dims
问题描述: batch_dims 默认值写作 0.0,但该参数类型为 INT64


文档: index/top_k_top_p_sample/README.md
位置: 约束说明
问题描述: 条件 1024<topK[batch]<vocSize[batch] 逻辑错误,应为 topK[batch] > vocSize[batch] 才跳过 topK


文档: index/embedding_bag/README.md
位置: 参数说明/y
问题描述: 输出参数 y 的数据类型写作 INT32、INT64,但实际应为 FLOAT、FLOAT16、BFLOAT16


文档: index/linear_index/README.md
位置: 整个文档
问题描述: 缺少「调用说明」章节


文档: index/embedding_dense_grad/README.md
位置: 整个文档
问题描述: 缺少「调用说明」章节

Existing Issues(存在的问题)

index/scatter_nd/README.md: 改为"调用 ScatterNd 算子"
index/index_put_v2/README.md: 改为 aclnnIndexPutImpl
index/embedding/docs/aclnnEmbedding.md: 改为 embedding
index/gather_v2/README.md: 改为整数 0
index/top_k_top_p_sample/README.md: 修正条件逻辑
index/embedding_bag/README.md: 修正为与 weight 一致的数据类型
index/linear_index/README.md: 补充调用说明和示例代码
index/embedding_dense_grad/README.md: 补充调用说明和示例代码

likedislike
Ddaishuangshuang
3月27日 修改标题为 “[Documentation|文档反馈]: index目录README.md格式异常”,原标题为“[Documentation|文档反馈]: index/ 目录 (8个问题)”
jiangjiawei成员
3月31日 评论:

/assign @FelixTang7

likedislike
CANN-robotCANN-robot成员
3月31日 将 FelixTang7 设为负责人
Jjiangjiawei成员
3月31日 将 xiu_ling_wang 设为负责人
Xxiu_ling_wang成员
4月8日 关联了pull request:修改算子readme文档
Xxiu_ling_wang成员
4月8日 关联了pull request:修改算子readme文档
CANN-robotCANN-robot成员
4月10日 关闭了 issue
CANN-robotCANN-robot成员
4月10日 添加了label:resolved
Ddaishuangshuang
5月25日 issue状态由 进行中 改变为 已完成
CANN-robotCANN-robot成员
5月25日 添加了label:Accepted