aclnnNorm

支持的产品型号

• Atlas 推理系列产品。
• Atlas 训练系列产品。
• Atlas A2训练系列产品/Atlas 800I A2推理产品。

接口原型

每个算子分为，必须先调用“aclnnNormGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnNorm”接口执行计算。

• aclnnStatus aclnnNormGetWorkspaceSize(const aclTensor* self, const aclScalar* pScalar, const aclIntArray* dim, bool keepdim, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
• aclStatus aclnnNorm(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

功能描述

• 算子功能：返回给定张量的矩阵范数或者向量范数。

• 计算公式： 支持1/2范数、无穷范数以及其他p为float类型的范数计算。

  • 1-范数：

    $$\Vert x \Vert = \sum_{i=1}^{N}{\vert x_i \vert}$$

  • 2-范数(默认值)：

    $$\Vert x \Vert_2 = (\sum_{i=1}^{N}{\vert x_i \vert^2})^{\frac{1}{2}}$$

  • 无穷范数：

    $$\Vert x \Vert_\infty = \max\limits_{i}{\vert x_i \vert}$$ $$\Vert x \Vert_{-\infty} = \min\limits_{i}{\vert x_i \vert}$$

  • p范数：

    $$\Vert x \Vert_p = (\sum_{i=1}^{N}{\vert x_i \vert^p})^{\frac{1}{p}}$$

aclnnNormGetWorkspaceSize

• 参数说明：

  • self（aclTensor*, 计算输入）：公式中的x，Device侧的aclTensor。shape支持0-8维，支持，支持ND。

    • Atlas 训练系列产品、Atlas 推理系列产品：数据类型支持FLOAT、FLOAT16。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT、FLOAT16、BFLOAT16。

  • pScalar（aclScalar*, 计算输入）：表示范数的类型，公式中的p。支持1/2范数、无穷范数以及其他为FLOAT类型的范数计算，数据类型支持FLOAT。

  • dim（aclIntArray*, 计算输入）：计算self范数的维度，支持[-N, N-1]，且dims中的元素不能重复，N为self的维度。，支持负数，数据类型支持INT。

  • keepdim（bool, 计算输入）：决定输出张量是否保留dim参数指定的轴，Host侧的bool常量。

  • relType（aclDataType, 计算输入）：预留参数，暂不支持使用。

  • out（aclTensor*, 计算输出）：Device侧的aclTensor。shape支持0-8维。若keepdim为true，除dim指定维度上的size为1以外，其余维度的shape需要与self保持一致；若keepdim为false，reduce轴的维度不保留，其余维度shape需要与self一致。支持，支持ND。

    • Atlas 训练系列产品、Atlas 推理系列产品：数据类型支持FLOAT、FLOAT16。
    • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持FLOAT、FLOAT16、BFLOAT16。

  • workspaceSize（uint64_t*, 出参）：返回需要在Device侧申请的workspace大小。

  • executor（aclOpExecutor**, 出参）：返回op执行器，包含了算子计算流程。

• 返回值：

  aclnnStatus：返回状态码，具体参见。

  [object Object]

aclnnNorm

• 参数说明：

  • workspace（void*, 入参）：在Device侧申请的workspace内存地址。

  • workspaceSize（uint64_t, 入参）：在Device侧申请的workspace大小，由第一段接口aclnnNormGetWorkspaceSize获取。

  • executor（aclOpExecutor*, 出参）：op执行器，包含了算子计算流程。

  • stream（aclrtStream, 入参）：指定执行任务的 AscendCL Stream流。

• 返回值：

  aclnnStatus：返回状态码，具体参见。

约束与限制

无。

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考。