aclnnAdaLayerNorm

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	√
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]	√
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列产品 [object Object]	×
[object Object]Atlas 训练系列产品[object Object]	×

功能说明

• 算子功能：AdaLayerNorm算子将LayerNorm和下游的Add、Mul融合起来，通过自适应参数scale和shift来调整归一化过程。

• 计算公式：

  $$out = LayerNorm(x) * (1 + scale) + shift$$

  LayerNorm计算公式：

  $$LayerNorm(x) = {{x-E(x)}\over\sqrt {Var(x)+epsilon}} * weight + bias$$

  其中，E(x)表示输入的均值，Var(x)表示输入的方差。

函数原型

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

• aclnnStatus aclnnAdaLayerNormGetWorkspaceSize(const aclTensor* x, const aclTensor* scale, const aclTensor* shift, const aclTensor* weightOptional, const aclTensor* biasOptional, double epsilon, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
• aclnnStatus aclnnAdaLayerNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnAdaLayerNormGetWorkspaceSize

• 参数说明：

  • x（aclTensor*，计算输入）：输入数据，公式中的输入x，Device侧的aclTensor。shape为[B, S, H]，其中B支持0到6维。支持undefined，不支持空Tensor，undefined支持ND，数据类型支持FLOAT32、FLOAT16、BFLOAT16。
  • scale（aclTensor*，计算输入）：自适应缩放参数，公式中的输入scale，Device侧的aclTensor。shape为[B, H]或[B,1,H]，其中B支持0到6维，维度数量和大小与x中的B保持一致，H与x中H维一致。支持undefined，不支持空Tensor，undefined支持ND，数据类型支持FLOAT32、FLOAT16、BFLOAT16，数据类型与入参x的数据类型一致。
  • shift（aclTensor*，计算输入）：自适应偏移参数，公式中的输入shift，Device侧的aclTensor。shape为[B, H]或[B,1,H]，其中B支持0到6维，维度数量和大小与x中的B保持一致，H与x中H维一致。支持undefined，不支持空Tensor，undefined支持ND，数据类型支持FLOAT32、FLOAT16、BFLOAT16，数据类型与入参x的数据类型一致。
  • weightOptional（aclTensor*，计算输入）：归一化缩放参数，公式中的输入weight，可选参数，Device侧的aclTensor。shape为[H]，H与x中H维一致。支持undefined，不支持空Tensor，undefined支持ND，数据类型支持FLOAT32、FLOAT16、BFLOAT16，数据类型与入参x的数据类型一致。
  • biasOptional（aclTensor*，计算输入）：归一化偏移参数，公式中的输入bias，可选参数，Device侧的aclTensor。shape为[H]，H与x中H维一致。支持undefined，不支持空Tensor，undefined支持ND，数据类型支持FLOAT32、FLOAT16、BFLOAT16，数据类型与入参x的数据类型一致。
  • epsilon（double, 计算输入）：公式中的输入epsilon，用于规避除零计算，Host侧的double型参数。
  • out（aclTensor*，计算输出）：输出数据，公式中的输出out，Device侧的aclTensor，shape与x保持一致。支持undefined，不支持空Tensor，undefined支持ND，数据类型支持FLOAT32、FLOAT16、BFLOAT16，数据类型与入参x的数据类型一致。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnAdaLayerNorm

• 参数说明：

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

• 返回值：

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

  [object Object]

约束说明

无。

调用示例

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