aclnnRmsNorm

支持的产品型号

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

接口原型

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

• aclnnStatus aclnnRmsNormGetWorkspaceSize(const aclTensor *x, const aclTensor *gamma, double epsilon, const aclTensor *yOut, const aclTensor *rstdOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnRmsNorm( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：RmsNorm算子是大模型常用的归一化操作，相比LayerNorm算子，其去掉了减去均值的部分 。
• 计算公式：$$\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}$$

aclnnRmsNormGetWorkspaceSize

• 参数说明：

  • x(aclTensor*，计算输入)： 数据类型支持FLOAT、FLOAT16、BFLOAT16、shape支持1-8维度，数据格式支持ND。
  • gamma(aclTensor*，计算输入)： 数据类型支持FLOAT、FLOAT16、BFLOAT16、shape支持1-8维度，数据格式支持ND。shape需要满足gamma_shape = x_shape[n:], n < x_shape.dims()。
  • epsilon(double，计算输入)： 公式中的输入eps，用于防止除0错误。
  • yOut(aclTensor*，计算输出)： 数据类型支持FLOAT、FLOAT16、BFLOAT16、shape支持1-8维度，数据格式支持ND。shape与x保持一致。
  • rstdOut(aclTensor*，计算输出)： 数据类型支持FLOAT、shape支持1-8维度，数据格式支持ND。shape与x前几维保持一致，使其满足shape_rstd * shape_gamma = shape_x。例如:1. x:(4,1,4096), gamma(4096,) -> rstd:(4,1,1); 2. x:(1024,), gamma(1024,) -> rstd:(1,)。
  • workspaceSize(uint64_t*，出参)：返回用户需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**，出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  说明： 第一段接口完成入参校验，出现以下场景时报错：

  • 161001 (ACLNN_ERR_PARAM_NULLPTR)：如果传入参数是必选输入，输出或者必选属性，且是空指针，则返回161001。

aclnnRmsNorm

• 参数说明：

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

• 返回值：

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

调用示例

示例编译和执行请参考编译与运行样例。