aclnnAddRmsNormCast

产品支持情况

产品	是否支持
[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算子是大模型常用的归一化操作，AddRmsNormCast算子将AddRmsNorm后的Cast算子融合起来，减少搬入搬出操作。
• 计算公式：$$x_i=x1_{i}+x2_{i}$$ $$y_2=\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}$$ $$y_1=float(y_2)$$

函数原型

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

• aclnnStatus aclnnAddRmsNormCastGetWorkspaceSize(const aclTensor *x1, const aclTensor *x2, const aclTensor *gamma, double epsilon, const aclTensor *y1Out, const aclTensor *y2Out, const aclTensor *rstdOut, const aclTensor *xOut, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnAddRmsNormCast(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnAddRmsNormCastGetWorkspaceSize

• 参数说明：

  • x1（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入x1，需要归一化的原始数据输入。shape支持1-8维。数据类型支持BFLOAT16、FLOAT16，undefined支持ND。
  • x2（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入x2，需要归一化的原始数据输入。shape支持1-8维，undefined支持ND，数据类型支持BFLOAT16、FLOAT16。shape、数据格式、数据类型均需要与入参x1保持一致。
  • gamma(aclTensor*，计算输入)：Device侧的aclTensor，公式中的输入g，数据缩放因子。shape支持1-8维，undefined支持ND，数据类型支持FLOAT16、BFLOAT16。shape需要满足gamma_shape = x_shape[n:], n < x_shape.dims()。数据类型、数据格式需要与入参x1保持一致。
  • epsilon（double，计算输入）：Host侧的DOUBLE型，公式中的输入eps，用于防止除0错误，数据类型为DOUBLE，建议值为1e-6。
  • y1Out（aclTensor*，计算输出）：Device侧的aclTensor，公式中的输出y1，归一化后经过类型转换的输出数据。shape支持1-8维，undefined支持ND，数据类型支持FLOAT32。shape、数据格式需要与入参x1保持一致。
  • y2Out（aclTensor*，计算输出）：Device侧的aclTensor，公式中的输出y2，归一化后的输出数据。shape支持1-8维，undefined支持ND，数据类型支持BFLOAT16、FLOAT16。shape、数据格式、数据类型均需要与入参x1保持一致。
  • rstdOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的输出Rms(x)，x的标准差。数据类型支持FLOAT32，shape支持1-8维。shape与入参x1的shape前几维保持一致，前几维指x1的维度减去gamma的维度，表示不需要norm的维度。undefined支持ND，需要与入参x1的数据格式保持一致。
  • xOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的输出x，归一化的数据和。shape支持1-8维，undefined支持ND，数据类型支持BFLOAT16、FLOAT16。shape、数据格式、数据类型均需要与入参x1保持一致。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnAddRmsNormCast

• 参数说明：

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

• 返回值：

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

约束说明

• 维度的边界说明： 参数x1、x2、gamma、y1Out、y2Out、rstdOut、xOut的shape中每一维大小都不大于INT32的最大值2147483647。

• 支持类型说明：

  是否支持空Tensor：支持空进空出。

• 未支持类型说明：

  是否支持undefined：不支持非连续Tensor。

• 边界值场景说明：

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

调用示例

示例编译和执行请参考undefined。