Open
[Requirement|需求建议]: 补充 SIMT API 实测输入输出示例 #1856
ruoshuisixueAdd on  Oct 9
ruoshuisixueCollaborators
Oct 9 Create

Thanks for sending an requirement! Please fill in the following template to help quickly solve your problem.

Background(背景信息)

现有文档包含功能说明、原型、参数说明、返回值和调用示例,但缺少真实运行得到的输入输出数据。用户在感知学习阶段只能通过语义描述和代码示例理解接口行为,难以直接确认:

  • 普通数值、负零、inf、-inf、nan 等特殊值的实际返回结果
  • 不同舍入模式在临界值上的差异

Origin(信息来源)

无

Benefit / Necessity (价值/作用)

  1. 提升开发资料可验证性
    每个接口文档都附带真实 NPU 运行结果,用户可以直接对照输入输出理解 API 行为。
  2. 降低学习与调试成本
    特殊值、舍入边界、类型转换和 mask 输出都能通过示例直观展示,减少用户自行编写测试程序验证语义的成本。
  3. . 提高文档质量一致性
    接口统一补充输入输出块,覆盖真实运行场景,形成可追溯、可复核的文档样例。
  4. 支持后续维护
    示例数据均来自device验证数据

Design(设计方案)

  1. 覆盖范围
    处理 docs/zh/api/SIMT-API/ 下全部 API 文档,每个接口默认覆盖文档中的 SIMT 与 SIMD/SIMT hybrid 两个编程场景。
  2. 用例生成
    • 按接口类型选择 4~8 个确定性输入
    • 覆盖普通值、边界值、特殊值和不同符号
    • 多参数 API 按下标配对输入
  3. 运行验证
    • 每个接口生成独立 .asc 工程、CMake 进行上板验证
  4. 文档回填规则
    • 只回填真实成功场景,不使用 CPU 参考值或手算值
  5. 交付结果
    • 全量API验证 全部补充输入输出示例
likedislike
RruoshuisixueCollaborators
Oct 9 Added label: requirement
RruoshuisixueCollaborators
Oct 9 Assign ruoshuisixue as responsible person
RruoshuisixueCollaborators
Oct 9 Change title to "[Requirement|需求建议]: 补充 SIMT API 实测输入输出示例", originally titled "[Experience Request|体验需求]: 补充 half_type API 实测输入输出示例".
RruoshuisixueCollaborators
Oct 9 Modify description of issue
RruoshuisixueCollaborators
Oct 9 Modify description of issue
RruoshuisixueCollaborators
Oct 9 Associated pull request
RruoshuisixueCollaborators
Oct 9 Associated pull request
RruoshuisixueCollaborators
Oct 9 Associated pull request
RruoshuisixueCollaborators
29 days ago Associated pull request
RruoshuisixueCollaborators
17 days ago Associated pull request
RruoshuisixueCollaborators
9 days ago Associated pull request