已合并
Docs: data_type_utils相关接口资料更新 #680
ren-botao创建于 22 天前
Docs: data_type_utils相关接口资料更新 #680
已合并
ren-botao创建于 22 天前
ren-botao成员
22 天前

描述

资料问题修改:

  1. op_common/data_type_utils.h 头文件后续版本将废弃,相关接口挪到opdev/data_type_utils.h中,新增接口废弃说明,和新头文件中新增接口说明。
  2. 修正 float 数据类型文档中 infinity() / signaling_NaN() 等函数返回值描述
  3. 改写 small_vector 的 reserve() / ExpandCap() 接口描述

关联的Issue

#290 data_type_utils相关接口资料更新
#255 代码和文档不一致:ToString接口缺少文档

测试

文档更新

data_type_utils目录下相关文档;
float8/6/4相关文档
small_vector.md

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 ren-botao 的贡献)
Rren-botao成员
22 天前 创建了 pull request,commit 1f37fbb8
atomgit-bot
atomgit-bot
22 天前 评论:

变更摘要

本次 PR 是纯粹的文档更新,聚焦于 data_type_utils 相关接口资料的补充与完善。共涉及 31 个文件,新增约 368 行、删除约 29 行,不包含任何代码逻辑或功能变更。

主要改动

  • data_type_utils 接口文档补充:针对 data_type_utils 相关模块的接口说明进行了内容增补与格式调整,提升了文档的完整性和可读性。
  • 文档细节修正:对原有文档中少量不准确或过时的描述进行了修正(体现为 29 行删除),确保接口文档与实际行为一致。
  • 多文件文档同步更新:31 个变更文件表明此次更新覆盖了 data_type_utils 相关的多个文档入口,可能涉及不同模块或不同层级的接口说明页面。
likedislike
atomgit-bot
atomgit-bot
22 天前 评论:

代码审查

审查总结

已审查全部 31 个变更文件,结果如下:

优先级 数量
P0 0
P1 0
P2 0
P3 1

各文件审查结论:

  • .gitignore — 无问题(添加 .claude/.opencode/ 开发工具目录到忽略列表)
  • docs/zh/api/nnopbase/opdev/0_opdev_api_list.md — 无问题(API 列表新增 8 个接口条目,旧 op_common 章节标记为废弃)
  • docs/zh/api/nnopbase/opdev/1_opdev_api_introduction.md — 无问题(data_type_utils 条目增加废弃提示)
  • docs/zh/api/nnopbase/opdev/data_type_utils/CanCast.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/CheckType.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/IsComplexType.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/IsFloatingType.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/IsIntegralType.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/IsIntegralType_bool.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/PromoteType.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/ToString.md — 无问题(新增文档,内容正确)
  • docs/zh/api/nnopbase/opdev/data_type_utils/data_type_utils.md — 无问题(索引页新增 8 个接口链接)
  • docs/zh/api/nnopbase/opdev/data_type_utils/reserved_interface_data_type_utils.md — 无问题(移除已升级为正式接口的 CheckType)
  • docs/zh/api/nnopbase/opdev/float4_e1m2/float4_e1m2.md — 无问题(infinity/NaN 描述修正)
  • docs/zh/api/nnopbase/opdev/float4_e2m1/float4_e2m1.md — 无问题
  • docs/zh/api/nnopbase/opdev/float6_e2m3/float6_e2m3.md — 无问题
  • docs/zh/api/nnopbase/opdev/float6_e3m2/float6_e3m2.md — 无问题
  • docs/zh/api/nnopbase/opdev/float8_e4m3fn/float8_e4m3fn.md — 无问题
  • docs/zh/api/nnopbase/opdev/float8_e5m2/float8_e5m2.md — 无问题
  • docs/zh/api/nnopbase/opdev/float8_e8m0/float8_e8m0.mdP3:max()="最大值" 与 infinity()="最大有限值" 描述不一致
  • docs/zh/api/nnopbase/opdev/hifloat4/hifloat4.md — 无问题
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/CanCast.md — 无问题(添加废弃提示)
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/IsComplexType.md — 无问题
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/IsFloatingType.md — 无问题
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/IsIntegralType.md — 无问题
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/IsIntegralType_bool.md — 无问题
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/PromoteType.md — 无问题
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/data_type_utils-6.md — 无问题
  • docs/zh/api/nnopbase/opdev/op_common_related_interface/op_common_related_interface.md — 无问题
  • docs/zh/api/nnopbase/opdev/opbase_frame_interface.md — 无问题(标记 op_common 为废弃)
  • docs/zh/api/nnopbase/opdev/small_vector/small_vector.md — 无问题(reserve/ExpandCap 描述改进)

整体风险判断:低风险。 本 PR 为纯文档更新,新增 data_type_utils 接口文档并标记旧 op_common 接口为废弃,同时改进了多种浮点类型和 small_vector 的描述文字。除 Float8E8M0 一处 max()/infinity() 措辞不一致外,未发现安全风险、误导性指令或内容错误。

⚠️ 已识别出整体风险,但无法提取行内评论,请参考整体评估。

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
22 天前 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here
You can get sig-info at here


PR Approval Progress

Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/opbase 宋恺, 张磊 (2/2) 宋恺, 张磊 (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

ren-botao, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robot成员
22 天前 将zhou-qilong,wangrui_,rxtfeng,loov1,jia0liang,zl_hw,songkai111,llimwang,gubaocheng设为评审人
CANN-robotCANN-robot成员
22 天前 将zhou-qilong,wangrui_,rxtfeng,loov1,jia0liang,zl_hw,songkai111,llimwang,gubaocheng设为审查人
Rren-botao成员
22 天前 update merge request[project id: 7649482, iid: 680, commit_id: b6933bf962bcba880aa973bab3260c331dd1ec65] virtual merging success
Rren-botao成员
22 天前 强制推送  1 个提交:d1f59497-Docs: data_type_utils相关接口资料更新
Rren-botao成员
22 天前 update merge request[project id: 7649482, iid: 680, commit_id: 5755627149f017f0aba9c5d75a05dba4be71c546] virtual merging success
chenjiao成员
22 天前 评论:

/approve

likedislike
CANN-robot
CANN-robot成员
22 天前 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
陈娇

likedislike
Rren-botao成员
22 天前 修改了pull request 的描述
Rren-botao成员
21 天前 修改了pull request 的描述
ren-botao成员
21 天前 评论:

compile

likedislike
Rren-botao成员
21 天前 update merge request[project id: 7649482, iid: 680, commit_id: b47920af8a975b2aa443c1e7af5afc9b699b523c] virtual merging success
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
21 天前 评论:

流水线任务触发成功
任务链接 [5ea8b338bfc4489aaa08948a59b8aafd][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
Check_Pr ✅ SUCCESS >>>>>
Compile_Ascend_X86_ubuntu24 ✅ SUCCESS >>>>> >>>>>
UT_Test ✅ SUCCESS
Compile_Ascend_ARM_ubuntu24 ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
StaticCheck_codespell ⚠️ WARNING >>>>>
StaticCheck_link_validity ✅ SUCCESS
StaticCheck_resource_existence ✅ SUCCESS
StaticCheck_tag_closed ✅ SUCCESS
StaticCheck_markdownlint ✅ SUCCESS
codecheck_style ✅ SUCCESS >>>>>
precommit ✅ SUCCESS >>>>>
API_Check ✅ SUCCESS >>>>>

[2026-07-29 16:22:57]    CI执行结束

likedislike
CANN-robotCANN-robot成员
21 天前 添加了label:api-check-pass
CANN-robotCANN-robot成员
21 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
21 天前 评论:
流水线 PR-pipeline_cann_opbase#1571 [ commitID:d1f59497 ] 已完成
likedislike
songkai111成员
21 天前 评论:

/approve

likedislike
CANN-robot
CANN-robot成员
21 天前 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
陈娇

likedislike
CANN-robotCANN-robot成员
21 天前 添加了label:approved
zl_hw成员
21 天前 评论:

/lgtm
/approve

likedislike
CANN-robot
CANN-robot成员
21 天前 评论:

The following users do not have permission to comment /lgtm or /approve on any module in this PR:
陈娇

likedislike
CANN-robotCANN-robot成员
21 天前 添加了label:lgtm
CANN-robotCANN-robot成员
21 天前 关闭了关联的issue
CANN-robotCANN-robot成员
21 天前 合入了pull request