aclnnGemmaRmsNorm

产品支持情况

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

功能说明

• 算子功能：GemmaRmsNorm算子是大模型常用的归一化操作，相比RmsNorm算子，在计算时对gamma做了+1操作。
• 计算公式：$$\operatorname{GemmaRmsNorm}(x_i)=\frac{x_i}{\operatorname{Rms}(\mathbf{x})} (1 + g_i), \quad \text { where } \operatorname{Rms}(\mathbf{x})=\sqrt{\frac{1}{n} \sum_{i=1}^n x_i^2+eps}$$

函数原型

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

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

aclnnGemmaRmsNormGetWorkspaceSize

• 参数说明：

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

• 返回值：

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

  [object Object]

aclnnGemmaRmsNorm

• 参数说明：

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

• 返回值：

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

约束说明

• 支持类型说明

  • 是否支持空Tensor：支持空进空出。
  • 是否支持undefined：支持非连续Tensor。

• 功能维度

  • 数据类型支持
    • x、gamma、yOut支持FLOAT32、FLOAT16、BFLOAT16。
    • rstdOut支持：FLOAT32。
  • undefined支持：ND。

• 未支持类型说明

  DOUBLE：指令不支持DOUBLE。

• 边界值场景说明

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

• 各平台支持数据类型说明

  x数据类型	gamma数据类型	yOut数据类型	rstdOut数据类型
  FLOAT16	FLOAT16	FLOAT16	FLOAT32
  BFLOAT16	BFLOAT16	BFLOAT16	FLOAT32
  FLOAT32	FLOAT32	FLOAT32	FLOAT32

调用示例

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