aclnnAddRmsNorm

产品支持情况

产品	是否支持
[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]	×

功能说明

• 算子功能：RmsNorm算子是大模型常用的归一化操作，相比LayerNorm算子，其去掉了减去均值的部分。AddRmsNorm算子将RmsNorm前的Add算子融合起来，减少搬入搬出操作。
• 计算公式：$$x_i=x1_{i}+x2_{i}$$ $$\operatorname{RmsNorm}(x_i)=\frac{x_i}{\operatorname{Rms}(\mathbf{x})} g_i, \quad \text { where } \operatorname{Rms}(\mathbf{x})=\sqrt{\frac{1}{n} \sum_{i=1}^n x_i^2+eps}$$

函数原型

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

• aclnnStatus aclnnAddRmsNormGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *gamma, double epsilon, const aclTensor *yOut, const aclTensor *rstdOut, const aclTensor *xOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnAddRmsNorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnAddRmsNormGetWorkspaceSize

• 参数说明：

  • x1（aclTensor*，计算输入）：用于Add计算的第一个输入。Device侧的aclTensor，对应公式中的x1，shape支持1-8维度，undefined支持ND。支持undefined，不支持空Tensor。
    • [object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
  • x2（aclTensor*，计算输入）：用于Add计算的第二个输入。Device侧的aclTensor，对应公式中的x2，shape支持1-8维度，undefined支持ND。shape和数据类型需要与x1的shape和数据类型保持一致。支持undefined，不支持空Tensor。
    • [object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
  • gamma（aclTensor*，计算输入）：表示RmsNorm的缩放因子（权重），Device侧的aclTensor，对应公式中的g，shape支持1-8维度，undefined支持ND。shape需要与x1后几维保持一致，数据类型与x1的数据类型保持一致。支持undefined，不支持空Tensor。
    • [object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
  • epsilon（double，计算输入）：Host侧的aclTensor，公式中的输入eps，用于防止除0错误，建议值为1e-6。
  • yOut（aclTensor*，计算输出）：表示最后的输出，Device侧的aclTensor，对应公式中的RmsNorm(x)，支持1-8维度，shape、数据类型与输入x1的shape、数据类型保持一致，undefined支持ND。支持undefined，不支持空Tensor。
    • [object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
  • rstdOut（aclTensor*，计算输出）：表示归一化后的标准差，Device侧的aclTensor，对应公式中的Rms(x)，数据类型支持FLOAT32，undefined支持ND，支持undefined，不支持空Tensor。shape支持1-8维度，shape与x1前几维保持一致，前几维表示不需要norm的维度。rstdOutshape与x1shape，gammashape关系举例：若x1shape:(2，3，4，8)，gammashape:(8)，rstdOutshape(2，3，4，1)；若x1shape:(2，3，4，8)，gammashape:(4，8)，rstdOutshape(2，3，1，1)。
    • [object Object]Atlas 推理系列产品[object Object]：该场景下输出无效。
  • xOut（aclTensor*，计算输出）：表示Add计算的结果，Device侧的aclTensor，对应公式中的x，shape支持1-8维度，shape、数据类型与输入x1的shape、数据类型保持一致，undefined支持ND。支持undefined，不支持空Tensor。
    • [object Object]Atlas 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT32、FLOAT16、BFLOAT16。
  • workspaceSize（uint64_t*，出参）：返回用户需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnAddRmsNorm

• 参数说明：

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

• 返回值：

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

约束说明

边界值场景说明

• 当输入是inf时，输出为inf。
• 当输入是nan时，输出为nan。

调用示例

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