涉及 docs/zh/api/nnopbase/opdev/ 下文档(路径相对仓库根),完整变更见关联 PR:
docs/zh/api/nnopbase/opdev/
data_type_utils 接口(新增文档):
data_type_utils/IsComplexType.md
data_type_utils/IsFloatingType.md
data_type_utils/IsIntegralType.md
data_type_utils/IsIntegralType_bool.md
data_type_utils/CanCast.md
data_type_utils/PromoteType.md
data_type_utils/CheckType.md
data_type_utils/ToString.md
data_type_utils 总览/预留接口(修订):
data_type_utils/data_type_utils.md
data_type_utils/reserved_interface_data_type_utils.md
API 列表与介绍(修订):
0_opdev_api_list.md
1_opdev_api_introduction.md
op_common 相关接口(标记废弃):
op_common_related_interface/op_common_related_interface.md
op_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.md
opbase_frame_interface.md
新增 8 个 data_type_utils 接口的标准说明文档,每个包含:功能说明、函数原型、参数说明、返回值说明、约束说明、调用示例。 示例(CanCast):
bool CanCast(const ge::DataType from, const ge::DataType to)
判断源数据类型是否可以 cast 到目的数据类型,成功返回 true,否则返回 false。
data_type_utils 总览(data_type_utils.md)新增上述 8 个接口的索引;原列于预留接口表的 CheckType 拆分为独立接口文档(从 reserved_interface_data_type_utils.md 移除)。
data_type_utils.md
reserved_interface_data_type_utils.md
op_common 相关接口统一标注废弃提示,例如:
须知:该接口后续版本会废弃,请使用最新 CanCast 接口
API 介绍页为 op_common/data_type_utils.h 新增废弃提示,引导使用 aclnn/opdev/data_type_utils.h 替换;API 列表页将 op_common 相关接口及其下 data_type_utils 标记为"(废弃)"。
op_common/data_type_utils.h
aclnn/opdev/data_type_utils.h
修正 float 数据类型文档中 infinity() / signaling_NaN() 等函数返回值描述。例如 Float8E4M3FN:
infinity()
signaling_NaN()
改写 small_vector 的 reserve() / ExpandCap() 接口描述,明确"仅改变容量、不影响已有元素个数"及扩容策略。
关联 PR:https://gitcode.com/cann/opbase/pull/680
/assign @ren-botao
Document Link(文档链接)
涉及
docs/zh/api/nnopbase/opdev/下文档(路径相对仓库根),完整变更见关联 PR:data_type_utils 接口(新增文档):
data_type_utils/IsComplexType.md、data_type_utils/IsFloatingType.md、data_type_utils/IsIntegralType.md、data_type_utils/IsIntegralType_bool.md(IsIntegralType 含 bool)data_type_utils/CanCast.md、data_type_utils/PromoteType.md、data_type_utils/CheckType.md、data_type_utils/ToString.mddata_type_utils 总览/预留接口(修订):
data_type_utils/data_type_utils.md、data_type_utils/reserved_interface_data_type_utils.mdAPI 列表与介绍(修订):
0_opdev_api_list.md、1_opdev_api_introduction.mdop_common 相关接口(标记废弃):
op_common_related_interface/op_common_related_interface.md、op_common_related_interface/data_type_utils-6.mdop_common_related_interface/{CanCast,IsComplexType,IsFloatingType,IsIntegralType,IsIntegralType_bool,PromoteType}.mdfloat 数据类型文档(描述修订):
float4_e1m2/、float4_e2m1/、float6_e2m3/、float6_e3m2/、float8_e4m3fn/、float8_e5m2/、float8_e8m0/、hifloat4/其他(描述修订):
small_vector/small_vector.md、opbase_frame_interface.mdIssues Section(问题文档片段)
新增 8 个 data_type_utils 接口的标准说明文档,每个包含:功能说明、函数原型、参数说明、返回值说明、约束说明、调用示例。
示例(CanCast):
bool CanCast(const ge::DataType from, const ge::DataType to)判断源数据类型是否可以 cast 到目的数据类型,成功返回 true,否则返回 false。
data_type_utils 总览(
data_type_utils.md)新增上述 8 个接口的索引;原列于预留接口表的 CheckType 拆分为独立接口文档(从reserved_interface_data_type_utils.md移除)。op_common 相关接口统一标注废弃提示,例如:
API 介绍页为
op_common/data_type_utils.h新增废弃提示,引导使用aclnn/opdev/data_type_utils.h替换;API 列表页将 op_common 相关接口及其下 data_type_utils 标记为"(废弃)"。修正 float 数据类型文档中 infinity() / signaling_NaN() 等函数返回值描述。例如 Float8E4M3FN:
infinity():返回最大有限值(该数据类型无无穷大值)signaling_NaN():返回 quiet NaN 值(该数据类型无 signaling NaN 值)改写 small_vector 的 reserve() / ExpandCap() 接口描述,明确"仅改变容量、不影响已有元素个数"及扩容策略。
Existing Issues(存在的问题)
op_common/data_type_utils.h头文件后续版本将废弃,但 API 介绍/列表页此前未给出替换路径(应使用aclnn/opdev/data_type_utils.h),也未标注废弃状态,存在迁移指引缺失。关联 PR:https://gitcode.com/cann/opbase/pull/680