Closed
[Documentation|文档反馈]: 修正 RotaryStride README 的参数标注 #5998
KaranocaVeAdd on  Oct 12Closed at  19 days ago
KaranocaVe
KaranocaVe
Oct 12 Create

[Documentation|文档反馈]: 修正 RotaryStride README 的参数标注

Document Link(文档链接)

https://gitcode.com/cann/ops-transformer/blob/master/experimental/posembedding/rotary_stride/README.md

Issues Section(问题文档片段)

sin: FLOAT
cos: FLOAT
out: 输入
x/y仅支持BFLOAT16/HAFL类型。

Existing Issues(存在的问题)

README 将 sin、cos 标为 FLOAT,但调用入口只接受 BF16 或 FP16;out 被标为输入,约束说明还将 HALF 拼成 HAFL。照文档传入 FLOAT 的正弦或余弦张量会触发 dtype 校验错误,参数方向和拼写也与实现不一致。

请将 sin、cos 的类型改为 BF16/FP16,将 out 标为输出,并修正 HALF 拼写。该修改只更新文档,不改变算子行为。

Validation

验证记录

  • 固定源码:0f1cf7d13da8f8be942b746759dd317d1ebb83ec。
  • 静态核对 rotary_stride.cpp:sin、cos 的入口检查仅接受 at::kBFloat16 或 at::kHalf;out 同样只接受这两种类型。
  • 静态核对 tests/test_rotary_stride.py:sin、cos 与 input/output 使用同一 BF16/FP16 dtype。
  • 对照 README 参数表:原文将 sin/cos 写为 FLOAT、将 out 写为输入,并将 HALF 拼成 HAFL。修复 patch 将其改为 BFLOAT16/HALF、输出及正确拼写。
  • 运行 Python 文本断言检查修复后 README 文本与入口约束一致,检查 patch 可反向应用;未运行设备算子测试,因为本 case 只修作文档且验证目标是接口声明。

关联 PR: https://gitcode.com/cann/ops-transformer/merge_requests/13677

likedislike
KaranocaVeKaranocaVe
Oct 12 Associated pull request
KaranocaVeKaranocaVe
Oct 12 Modify description of issue
游震Collaborators
Oct 12 Comments:

/assign @KaranocaVe

likedislike
CANN-robotCANN-robotCollaborators
Oct 12 Assign KaranocaVe as responsible person
周云飞
周云飞Collaborators
Oct 17 Comments:

感谢反馈,也感谢提供固定版本和验证记录。按您提供的入口检查结果,README 将 sin、cos 标为 FLOAT 会误导调用者传入不受支持的类型,进而触发类型校验错误;out 的参数方向和 HALF 的拼写也需要修正。

本次文档调整的范围可以明确为:

  • 将 sin、cos 的类型由 FLOAT 改为 BFLOAT16/HALF,分别对应 BF16/FP16。
  • 将 out 的参数方向由“输入”改为“输出”,保留其 BF16/FP16 类型约束。
  • 将约束说明中的 HAFL 更正为 HALF。

这些调整旨在使文档与现有接口约束一致,不涉及修改算子行为,也不意味着新增 FLOAT 支持。您提供的文本断言验证适用于本次文档修改范围,但不代表设备执行验证。已注意到关联 PR #13677;其具体改动和合入状态仍待确认。

likedislike
CANN-robotCANN-robotCollaborators
19 days ago Close issue
CANN-robotCANN-robotCollaborators
19 days ago Added label: resolved
周云飞
周云飞Collaborators
8 days ago Comments:

PR #13677 修正了 RotaryStride README 中 sin、cos 的数据类型标注,将 FLOAT 改为 BFLOAT16/HALF,并将 cos 的描述从输入张量 x 更正为 cos。本次为文档修改,不改变算子行为。

关联 PR:PR #13677

likedislike