aclnnLayerNorm&aclnnLayerNormWithImplMode

支持的产品型号

• Atlas 训练系列产品。
• Atlas A2训练系列产品。

接口原型

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

• aclnnStatus aclnnLayerNormGetWorkspaceSize(const aclTensor *input, const aclIntArray *normalizedShape, const aclTensor *weightOptional, const aclTensor *biasOptional, double eps, aclTensor *out, aclTensor *meanOutOptional, aclTensor *rstdOutOptional, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnLayerNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
• aclnnStatus aclnnLayerNormWithImplModeGetWorkspaceSize(const aclTensor *input, const aclIntArray *normalizedShape, const aclTensor *weightOptional, const aclTensor *biasOptional, double eps, aclTensor *out, aclTensor *meanOutOptional, aclTensor *rstdOutOptional, int32_t implMode, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnLayerNormWithImplMode(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：对指定层进行均值为0、标准差为1的归一化计算。
• 计算公式：

$$out = \frac{x - \mathrm{E}[x]}{ \sqrt{\mathrm{Var}[x] + eps}} * w + b$$

其中，E[input]表示输入的均值，Var[input]表示输入的方差。

aclnnLayerNormGetWorkspaceSize

• 参数说明：

  • input(aclTensor*，计算输入)：公式中的输入x，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape长度需要大于等于normalizedShape的长度，且与normalizedShape右对齐时对应维度shape相等。支持，支持ND。

  • normalizedShape(aclIntArray*，计算输入)：数据类型支持INT64，表示需要进行norm计算的shape，长度小于等于input的shape长度，与input的shape右对齐时对应维度shape相等。

  • weightOptional(aclTensor*，计算输入)：公式中的输入w，可选参数。weightOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与normalizedShape相等。支持，支持ND。weightOptional为空时，需要构造一个shape与normalizedShape相等，数据全为1的tensor。

  • biasOptional(aclTensor*，计算输入)：公式中的输入b，可选参数。biasOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与normalizedShape相等。支持，支持ND。biasOptional为空时，需要构造一个shape与normalizedShape相等，数据全为0的tensor。

  • eps(double，计算输入)：公式中的输入eps，用于规避除零计算，数据类型支持DOUBLE, 且需要可转换成与input相同的数据类型。

  • out(aclTensor*，计算输出)：公式中的输出out，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape需要与input的shape相等。支持，支持ND。

  • meanOutOptional(aclTensor*，计算输出)：可选参数，meanOutOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与rstdOutOptional的shape相等。支持，支持ND。

  • rstdOutOptional(aclTensor*，计算输出)：可选参数，rstdOutOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与meanOutOptional的shape相等。支持，支持ND。

  • workspaceSize(uint64_t*, 出参)：返回用户需要在Device侧申请的workspace大小。

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

• 返回值：

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

aclnnLayerNorm

• 参数说明：

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

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

  • executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。

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

• 返回值：

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

aclnnLayerNormWithImplModeGetWorkspaceSize

• 参数说明：

  • input(aclTensor*，计算输入)：公式中的输入x，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape长度需要大于等于normalizedShape的长度，且与normalizedShape右对齐时对应维度shape相等。支持，支持ND。

  • normalizedShape(aclIntArray*，计算输入)：数据类型支持INT64，表示需要进行norm计算的shape，长度小于等于input的shape长度，与input的shape右对齐时对应维度shape相等。

  • weightOptional(aclTensor*，计算输入)：公式中的输入w，可选参数。weightOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与normalizedShape相等。支持，支持ND。weightOptional为空时，需要构造一个shape与normalizedShape相等，数据全为1的tensor。

  • biasOptional(aclTensor*，计算输入)：公式中的输入b，可选参数。biasOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与normalizedShape相等。支持，支持ND。biasOptional为空时，需要构造一个shape与normalizedShape相等，数据全为0的tensor。

  • eps(double，计算输入)：公式中的输入eps，用于规避除零计算，数据类型支持DOUBLE, 且需要可转换成与input相同的数据类型。

  • out(aclTensor*，计算输出)：公式中的输出out，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape需要与input的shape相等。支持，支持ND。

  • meanOutOptional(aclTensor*，计算输出)：可选参数，meanOutOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与rstdOutOptional的shape相等。支持，支持ND。

  • rstdOutOptional(aclTensor*，计算输出)：可选参数，rstdOutOptional非空时，数据类型支持FLOAT、FLOAT16、BFLOAT16（仅Atlas A2训练系列产品支持）。shape与meanOutOptional的shape相等。支持，支持ND。

  • implMode(int32_t, 计算输入)：精度模式，用于指定kernel选择对应的计算模式，其中0表示为高精度，1表示为高性能，2表示为保持FLOAT16计算。

  • workspaceSize(uint64_t*, 出参)：返回用户需要在Device侧申请的workspace大小。

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

• 返回值：

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

aclnnLayerNormWithImplMode

• 参数说明：

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

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

  • executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。

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

• 返回值：

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

约束与限制

无。

调用示例1

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

调用示例2

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