aclnnAddLayerNorm

支持的产品型号

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

接口原型

每个算子分为undefined，必须先调用aclnnAddLayerNormGetWorkspaceSize接口获取入参并根据计算流程所需workspace大小，再调用aclnnAddLayerNorm接口执行计算。

• aclnnStatus aclnnAddLayerNormGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *gamma, const aclTensor *beta, const aclTensor *bias, double epsilon, bool additionalOut, const aclTensor *yOut, const aclTensor *meanOut, const aclTensor *rstdOut, const aclTensor *xOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnAddLayerNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：实现AddLayerNorm功能。
• 计算公式：

$$x = x1 + x2 + bias$$ $$y = {{x-\bar{x}}\over\sqrt {Var(x)+e}} * \gamma + \beta$$

aclnnAddLayerNormGetWorkspaceSize

• 参数说明：

  • x1（aclTensor *，计算输入）：表示AddLayerNorm中加法计算的输入，将会在算子内做 x1 + x2 + bias 的计算并对计算结果做层归一化；是Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持），shape支持2-8维度，undefined支持ND。
  • x2（aclTensor *，计算输入）：表示AddLayerNorm中加法计算的输入，将会在算子内做 x1 + x2 + bias 的计算并对计算结果做层归一化；是Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持），shape支持2-8维度，undefined支持ND。
  • beta（aclTensor *，计算输入）：对应LayerNorm计算公式中的 beta ，表示层归一化中的 beta 参数；是Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持），shape支持2-8维度，undefined支持ND，数据维度和x1/x2的尾轴相同。
  • gamma（aclTensor *，计算输入）：对应LayerNorm计算公式中的 gamma，表示层归一化中的 gamma 参数；是Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持），shape支持2-8维度，undefined支持ND，数据维度和x1/x2的尾轴相同。
  • bias（aclTensor *，计算输入）：可选输入参数，表示AddLayerNorm中加法计算的输入，将会在算子内做 x1 + x2 + bias 的计算并对计算结果做层归一化；shape可以和gamma/beta或是和x1/x2一致，是Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持），shape支持2-8维度，undefined支持ND。
  • epsilon（double *，计算输入）：表对应LayerNorm中的epsilon，添加到分母中的值，以确保数值稳定；host侧的aclScalar，数据类型为double，默认值为1e-5。
  • additionalOut（bool *，计算输入）：表示是否开启x=x1+x2的输出，host侧的aclScalar，数据类型为bool。
  • meanOut（aclTensor *，计算输出）：输出 LayerNorm 计算过程中 (x1 + x2) 的结果的均值，Device 侧的aclTensor，数据类型为FLOAT，shape需要与输入x1/x2一致，最后一轴的size为1，undefined支持ND，该输出在Atlas 推理系列产品上无效。计算逻辑：$$mean = np.mean(x1 + x2)$$
  • rstdOut（aclTensor *，计算输出）：输出 LayerNorm 计算过程中 rstd 的结果，Device 侧的aclTensor，数据类型为FLOAT，shape需要与输入x1/x2一致，最后一轴的size为1，undefined支持ND，该输出在Atlas 推理系列产品上无效。计算逻辑：$$rstd = np.power((np.var(x1 + x2) + epsilon), (-0.5))$$
  • yOut（aclTensor *，计算输出）：表示LayerNorm的结果输出y，Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持），需要与输入x1/x2一致，shape需要与输入x1/x2一致，undefined支持ND。
  • xOut（aclTensor *，计算输出）：表示LayerNorm的结果输出x，Device 侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持），需要与输入x1/x2一致，shape需要与输入x1/x2一致，undefined支持ND。
  • workspaceSize（uint64_t *，出参）：返回用户需要在Device 侧申请的workspace大小。
  • executor（aclOpExecutor **，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

  aclnnStatus：返回状态码。（参见undefined）

  [object Object]

aclnnAddLayerNorm

• 参数说明：

  • workspace（void *，入参）：在Device侧申请的workspace内存地址。
  • workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnAddLayerNormGetWorkspaceSize获取。
  • executor（aclOpExecutor *，入参）：op执行器，包含了算子计算流程。
  • stream（aclrtStream，入参）：指定执行任务的AscendCL stream流。

• 返回值：

  aclnnStatus：返回状态码。（具体参见undefined）

约束与限制

• 功能维度
  • 数据类型支持
    • x1、x2、beta、gamma、bias支持：FLOAT32、FLOAT16、BFLOAT16（Atlas 推理系列产品不支持）。
    • rstd、mean支持：FLOAT32。
  • 数据格式支持：ND。
• 未支持类型说明
  • DOUBLE：指令不支持DOUBLE。
  • 是否支持空tensor：不支持空进空出。
  • 是否非连续tensor：不支持输入非连续，不支持数据非连续。
• 边界值场景说明
  • 当输入是inf时，输出为inf。
  • 当输入是nan时，输出为nan。

调用示例

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