aclnnRmsNormDynamicQuant

📄 查看源码

产品支持情况

Ascend 950PR/Ascend 950DT：不支持

Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持

Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持

Atlas 200I/500 A2 推理产品：不支持

Atlas 推理系列产品：不支持

Atlas 训练系列产品：不支持

功能说明

接口功能：RmsNorm算子是大模型常用的归一化操作，相比LayerNorm算子，其去掉了减去均值的部分。DynamicQuant算子则是为输入张量进行对称动态量化的算子。RmsNormDynamicQuant算子将RmsNorm归一化和DynamicQuant动态量化融合起来，减少搬入搬出操作。
计算公式：

$\operatorname{RmsNorm}(x)=\frac{x}{\operatorname{Rms}(\mathbf{x})}\cdot gamma + beta, \quad \text { where } \operatorname{Rms}(\mathbf{x})=\sqrt{\frac{1}{n} \sum_{i=1}^n x_i^2+epsilon}$
- 若smoothScalesOptional不输入，则直接对rmsnorm输出做量化：
$scaleOut=row\_max(abs(y))/max\_val$

$y O u t = r o u n d (y / s c a l e O u t)$
- 若输入smoothScalesOptional，则先做smooth缩放再量化：
$y\cdot smoothScalesOptional$

$scaleOut=row\_max(abs(input))/max\_val$

$y O u t = r o u n d (i n p u t / s c a l e O u t)$

其中row_max代表每行求最大值。max_val在INT8时为127。

函数原型

每个算子分为两段式接口，必须先调用aclnnRmsNormDynamicQuantGetWorkspaceSize接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用aclnnRmsNormDynamicQuant接口执行计算。

aclnnStatus aclnnRmsNormDynamicQuantGetWorkspaceSize(
  const aclTensor *x,
  const aclTensor *gamma,
  const aclTensor *smoothScalesOptional,
  const aclTensor *betaOptional,
  double           epsilon,
  int64_t          dstType,
  const aclTensor *yOut,
  const aclTensor *scaleOut,
  uint64_t        *workspaceSize,
  aclOpExecutor  **executor)

aclnnStatus aclnnRmsNormDynamicQuant(
  void          *workspace,
  uint64_t       workspaceSize,
  aclOpExecutor *executor,
  aclrtStream    stream)

aclnnRmsNormDynamicQuantGetWorkspaceSize

参数说明

参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
x（const aclTensor*）	输入	表示标准化过程中的源数据张量。对应公式中的x。	不支持空Tensor。	FLOAT16、BFLOAT16	ND	2-8	√
gamma（const aclTensor*）	输入	表示标准化过程中的权重张量。对应公式中的gamma。	不支持空Tensor。数据类型需要与x保持一致。 shape需要与x最后一维一致。	FLOAT16、BFLOAT16	ND	1	√
smoothScalesOptional（const aclTensor*）	输入	表示量化过程中使用的smoothScale张量。对应公式中的smoothScalesOptional。	不支持空Tensor。可选参数，支持传入空指针。 shape和数据类型需要与gamma保持一致。	FLOAT16、BFLOAT16	ND	1	√
betaOptional（const aclTensor*）	输入	表示标准化过程中的偏置项。对应公式中的beta。	不支持空Tensor。可选参数，支持传入空指针。 shape和数据类型需要与gamma保持一致。	FLOAT16、BFLOAT16	ND	1	√
epsilon（double）	输入	表示用于防止除0错误，对应公式中的epsilon。	建议传入较小正数。	-	-	-	-
dstType（int64_t）	输入	表示输出yOut的数据类型枚举值。	支持DT_INT8(2)。	-	-	-	-
yOut（aclTensor*）	输出	表示量化输出Tensor，对应公式中的yOut。	不支持空Tensor。 shape需要与输入x一致。	INT8	ND	2-8	√
scaleOut（aclTensor*）	输出	表示量化的scale输出，对应公式中的scaleOut。	不支持空Tensor。 shape需要与输入x除最后一维后的shape一致。	FLOAT32	ND	1-8	√
workspaceSize（uint64_t*）	输出	返回需要在Device侧申请的workspace大小。	-	-	-	-	-
executor（aclOpExecutor**）	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

返回值

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

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

返回值	错误码	描述
ACLNN_ERR_PARAM_NULLPTR	161001	x, gamma, yOut, scaleOut存在空指针。
ACLNN_ERR_INNER_TILING_ERROR	561002	调用tiling时发生异常。

aclnnRmsNormDynamicQuant

参数说明

参数名	输入/输出	描述
workspace	输入	在Device侧申请的workspace内存地址。
workspaceSize	输入	在Device侧申请的workspace大小，由第一段接口aclnnRmsNormDynamicQuantGetWorkspaceSize获取。
executor	输入	op执行器，包含了算子计算流程。
stream	输入	指定执行任务的Stream。

返回值

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

约束说明

确定性计算：aclnnRmsNormDynamicQuant默认确定性实现。
输入shape限制：输入x的最后一维必须小于等于8192，否则可能出现精度问题。
输入值域限制：x不支持全0输入。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_rms_norm_dynamic_quant.h"

#define CHECK_RET(cond, return_expr) \
    do {                             \
        if (!(cond)) {               \
            return_expr;             \
        }                            \
    } while (0)

#define LOG_PRINT(message, ...)         \
    do {                                \
        printf(message, ##__VA_ARGS__); \
    } while (0)

int64_t GetShapeSize(const std::vector<int64_t>& shape)
{
    int64_t shape_size = 1;
    for (auto i : shape) {
        shape_size *= i;
    }
    return shape_size;
}

int Init(int32_t deviceId, aclrtStream* stream)
{
    // 固定写法，资源初始化
    auto ret = aclInit(nullptr);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret);
    ret = aclrtSetDevice(deviceId);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret);
    ret = aclrtCreateStream(stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret);

    return 0;
}

template <typename T>
int CreateAclTensor(
    const std::vector<T>& hostData, const std::vector<int64_t>& shape, void** deviceAddr, aclDataType dataType,
    aclTensor** tensor)
{
    auto size = GetShapeSize(shape) * sizeof(T);
    // 调用aclrtMalloc申请device侧内存
    auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret);

    // 调用aclrtMemcpy将host侧数据拷贝到device侧内存上
    ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret);

    // 计算连续tensor的strides
    std::vector<int64_t> strides(shape.size(), 1);
    for (int64_t i = shape.size() - 2; i >= 0; i--) {
        strides[i] = shape[i + 1] * strides[i + 1];
    }

    // 调用aclCreateTensor接口创建aclTensor
    *tensor = aclCreateTensor(
        shape.data(), shape.size(), dataType, strides.data(), 0, aclFormat::ACL_FORMAT_ND, shape.data(), shape.size(),
        *deviceAddr);
    return 0;
}

int main()
{
    // 1. （固定写法）device/stream初始化，参考acl API手册
    // 根据自己的实际device填写deviceId
    int32_t deviceId = 0;
    aclrtStream stream;
    auto ret = Init(deviceId, &stream);
    // check根据自己的需要处理
    CHECK_RET(ret == 0, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
    // 2. 构造输入与输出，需要根据API的接口自定义构造
    std::vector<int64_t> xShape = {2, 8};
    std::vector<int64_t> gammaShape = {8};
    std::vector<int64_t> scaleShape = {2};

    void* xDeviceAddr = nullptr;
    void* gammaDeviceAddr = nullptr;
    void* smoothDeviceAddr = nullptr;
    void* betaDeviceAddr = nullptr;
    void* yDeviceAddr = nullptr;
    void* scaleDeviceAddr = nullptr;

    aclTensor* x = nullptr;
    aclTensor* gamma = nullptr;
    aclTensor* smooth = nullptr;
    aclTensor* beta = nullptr;
    aclTensor* y = nullptr;
    aclTensor* scale = nullptr;

    int64_t xShapeSize = GetShapeSize(xShape);
    int64_t gammaShapeSize = GetShapeSize(gammaShape);
    int64_t scaleShapeSize = GetShapeSize(scaleShape);

    // FP16 bit patterns: 0x3800=0.5, 0x3e00=1.5
    std::vector<short> xHostData(xShapeSize, 0x3800);
    std::vector<short> gammaHostData(gammaShapeSize, 0x3e00);
    std::vector<short> smoothHostData(gammaShapeSize, 0x3e00);
    std::vector<short> betaHostData(gammaShapeSize, 0);

    std::vector<short> yHostData(xShapeSize, 0);
    std::vector<float> scaleHostData(scaleShapeSize, 0);

    float epsilon = 1e-6;
    int64_t dstType = 2; // DT_INT8

    // 输入
    ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_FLOAT16, &x);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(gammaHostData, gammaShape, &gammaDeviceAddr, aclDataType::ACL_FLOAT16, &gamma);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(smoothHostData, gammaShape, &smoothDeviceAddr, aclDataType::ACL_FLOAT16, &smooth);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(betaHostData, gammaShape, &betaDeviceAddr, aclDataType::ACL_FLOAT16, &beta);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 输出
    ret = CreateAclTensor(yHostData, xShape, &yDeviceAddr, aclDataType::ACL_INT8, &y);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(scaleHostData, scaleShape, &scaleDeviceAddr, aclDataType::ACL_FLOAT, &scale);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 3. 调用CANN算子库API，需要修改为具体的API
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;
    // 调用aclnnRmsNormDynamicQuant第一段接口
    ret = aclnnRmsNormDynamicQuantGetWorkspaceSize(
        x, gamma, smooth, beta, epsilon, dstType, y, scale, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("GetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
    // 根据第一段接口计算出的workspaceSize申请device内存
    void* workspaceAddr = nullptr;
    if (workspaceSize > 0) {
        ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
        CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret;);
    }
    ret = aclnnRmsNormDynamicQuant(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRmsNormDynamicQuant failed. ERROR: %d\n", ret); return ret);

    // 4. （固定写法）同步等待任务执行结束
    ret = aclrtSynchronizeStream(stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);

    // 5. 获取输出的值，将device侧内存上的结果拷贝至host侧，需要根据具体API的接口定义修改
    // 打印 y (INT8)
    std::vector<int8_t> yRet(xShapeSize, 0);
    ret = aclrtMemcpy(yRet.data(), xShapeSize, yDeviceAddr, xShapeSize, ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy y failed. ERROR: %d\n", ret); return ret);
    LOG_PRINT("=== y (INT8, {2,8}) ===\n");
    for (int64_t i = 0; i < xShapeSize; i++) {
        LOG_PRINT("y[%ld]: %d\n", i, yRet[i]);
    }

    // 打印 scale (FLOAT32)
    std::vector<float> sRet(scaleShapeSize, 0);
    ret = aclrtMemcpy(sRet.data(), scaleShapeSize * sizeof(float), scaleDeviceAddr, scaleShapeSize * sizeof(float), ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy scale failed. ERROR: %d\n", ret); return ret);
    LOG_PRINT("=== scale (FLOAT32, {2}) ===\n");
    for (int64_t i = 0; i < scaleShapeSize; i++) {
        LOG_PRINT("scale[%ld]: %f\n", i, sRet[i]);
    }

    // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改
    aclDestroyTensor(x);
    aclDestroyTensor(gamma);
    aclDestroyTensor(smooth);
    aclDestroyTensor(beta);
    aclDestroyTensor(y);
    aclDestroyTensor(scale);

    // 7. 释放device资源，需要根据具体API的接口定义修改
    aclrtFree(xDeviceAddr);
    aclrtFree(gammaDeviceAddr);
    aclrtFree(smoothDeviceAddr);
    aclrtFree(betaDeviceAddr);
    aclrtFree(yDeviceAddr);
    aclrtFree(scaleDeviceAddr);
    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();
    return 0;
}