已关闭
[Documentation|文档反馈]: data_type_utils相关接口资料更新 #290
ren-botao创建于  7月29日关闭于  7月29日
ren-botao成员
7月29日 创建

Document Link(文档链接)

涉及 docs/zh/api/nnopbase/opdev/ 下文档(路径相对仓库根),完整变更见关联 PR:

data_type_utils 接口(新增文档)

  • data_type_utils/IsComplexType.mddata_type_utils/IsFloatingType.mddata_type_utils/IsIntegralType.mddata_type_utils/IsIntegralType_bool.md(IsIntegralType 含 bool)
  • data_type_utils/CanCast.mddata_type_utils/PromoteType.mddata_type_utils/CheckType.mddata_type_utils/ToString.md

data_type_utils 总览/预留接口(修订)

  • data_type_utils/data_type_utils.mddata_type_utils/reserved_interface_data_type_utils.md

API 列表与介绍(修订)

  • 0_opdev_api_list.md1_opdev_api_introduction.md

op_common 相关接口(标记废弃)

  • op_common_related_interface/op_common_related_interface.mdop_common_related_interface/data_type_utils-6.md
  • op_common_related_interface/{CanCast,IsComplexType,IsFloatingType,IsIntegralType,IsIntegralType_bool,PromoteType}.md

float 数据类型文档(描述修订)

  • float4_e1m2/float4_e2m1/float6_e2m3/float6_e3m2/float8_e4m3fn/float8_e5m2/float8_e8m0/hifloat4/

其他(描述修订)

  • small_vector/small_vector.mdopbase_frame_interface.md

Issues Section(问题文档片段)

  1. 新增 8 个 data_type_utils 接口的标准说明文档,每个包含:功能说明、函数原型、参数说明、返回值说明、约束说明、调用示例。
    示例(CanCast):

    bool CanCast(const ge::DataType from, const ge::DataType to)
    

    判断源数据类型是否可以 cast 到目的数据类型,成功返回 true,否则返回 false。

  2. data_type_utils 总览(data_type_utils.md)新增上述 8 个接口的索引;原列于预留接口表的 CheckType 拆分为独立接口文档(从 reserved_interface_data_type_utils.md 移除)。

  3. op_common 相关接口统一标注废弃提示,例如:

    须知:该接口后续版本会废弃,请使用最新 CanCast 接口

    API 介绍页为 op_common/data_type_utils.h 新增废弃提示,引导使用 aclnn/opdev/data_type_utils.h 替换;API 列表页将 op_common 相关接口及其下 data_type_utils 标记为"(废弃)"。

  4. 修正 float 数据类型文档中 infinity() / signaling_NaN() 等函数返回值描述。例如 Float8E4M3FN:

    • infinity():返回最大有限值(该数据类型无无穷大值)
    • signaling_NaN():返回 quiet NaN 值(该数据类型无 signaling NaN 值)
  5. 改写 small_vector 的 reserve() / ExpandCap() 接口描述,明确"仅改变容量、不影响已有元素个数"及扩容策略。

Existing Issues(存在的问题)

  • data_type_utils 模块此前缺少 IsComplexType/IsFloatingType/IsIntegralType/IsIntegralType(含bool)/CanCast/PromoteType/CheckType/ToString 共 8 个接口的独立说明文档,开发者仅能依赖头文件或预留接口表,缺少函数原型、参数、返回值、约束与调用示例。
  • op_common/data_type_utils.h 头文件后续版本将废弃,但 API 介绍/列表页此前未给出替换路径(应使用 aclnn/opdev/data_type_utils.h),也未标注废弃状态,存在迁移指引缺失。
  • float4/float6/float8/hifloat4 数据类型中,部分类型(如 Float8E4M3FN)不存在无穷大值或 signaling NaN 值,原文档将 infinity() 描述为"返回最大值"、signaling_NaN() 描述为"返回 signaling NaN 值",描述不准确、易误导。
  • small_vector 的 reserve()/ExpandCap() 接口描述冗长且不清晰,未准确说明扩容行为与对元素个数的影响。

关联 PR:https://gitcode.com/cann/opbase/pull/680

likedislike
Rren-botao成员
7月29日 添加了label:documentation
ren-botao成员
7月29日 评论:

/assign @ren-botao

likedislike
CANN-robotCANN-robot成员
7月29日 将 ren-botao 设为负责人
CANN-robotCANN-robot成员
7月29日 关闭了 issue
CANN-robotCANN-robot成员
7月29日 添加了label:resolved