已关闭
[Documentation|文档反馈]: 多个算子文档与示例代码存在描述与数据错误 #814
sunhao_hw创建于  8月25日关闭于  8月25日
sunhao_hw成员
8月25日 创建

Document Link(文档链接)

  • image/col2im/docs/aclnnIm2colBackward.md
  • image/three_interpolate_backward/docs/aclnnThreeInterpolateBackward.md
  • objdetect/background_replace/docs/aclnnBackgroundReplace.md
  • objdetect/blend_images_custom/docs/aclnnBlendImagesCustom.md
  • objdetect/roi_align_grad/docs/aclnnRoiAlignV2Backward.md
  • objdetect/roi_pooling_grad_with_arg_max/docs/aclnnRoiPoolingGradWithArgMax.md
  • 上述算子对应 examples/ 目录下的示例代码

Issues Section(问题文档片段)

  1. aclnnIm2colBackward.md:inputSize 参数描述为“输入张量的形状”,表述不准确,实际应为输入张量的空间尺寸 [H, W]。
  2. aclnnThreeInterpolateBackward.md:示例中 gradYHostData = {0} 仅初始化 1 个元素,与输入 shape 不一致。
  3. background_replace(docs + example):示例 tensor shape 为 {4,2},但 host 数据长度 9 与 8 元素不匹配。
  4. blend_images_custom(docs + example):示例 host 数据用 float 类型,但张量类型为 ACL_UINT8,数据类型不一致。
  5. aclnnRoiAlignV2Backward.md:输出参数名写为 out,实际应为 gradInput。
  6. roi_pooling_grad_with_arg_max(docs + arch35 example):示例存在打印文案 mean result 错误、元素数注释 2048 与 128 不符、误用 API 名 aclnnAddExample、步骤编号 5/7/8/9 与 7/8/9/10 不一致等问题。

Existing Issues(存在的问题)

上述文档描述与示例代码存在表述不准确、数据/类型与 shape 不一致、注释与 API 名称错误等问题,会导致用户按文档/示例运行时产生疑惑或出错,建议修正使文档与示例保持一致、示例可正确运行。

likedislike
Ssunhao_hw成员
8月25日 添加了label:documentation
sunhao_hw成员
8月25日 评论:

负责人:@sunhao_hw,已通过 PR #1385 修复该文档问题。

likedislike
CANN-robotCANN-robot成员
8月25日 关闭了 issue
CANN-robotCANN-robot成员
8月25日 添加了label:resolved
Ssunhao_hw成员
13 天前 issue状态由 进行中 改变为 已完成