cann-robotmodified md files(for readability improvement)

aclnnLayerNormQuant

产品支持情况

产品	是否支持
Ascend 950PR/Ascend 950DT	√
Atlas A3 训练系列产品/Atlas A3 推理系列产品	√
Atlas A2 训练系列产品/Atlas A2 推理系列产品	√
Atlas 200I/500 A2 推理产品	×
Atlas 推理系列产品	√
Atlas 训练系列产品	×

功能说明

接口功能：LayerNorm算子是大模型常用的归一化操作。LayerNormQuant算子将LayerNorm归一化输出和下游的量化算子融合起来，减少搬入搬出操作。
计算公式：
- LayerNorm操作：
  ${{x-E(x)}\over\sqrt {Var(x)+epsilon}} * gamma + beta$ ${\frac{1}{n} \sum_{i=1}^{n} x_i }$ ${\frac{1}{n} \sum_{i=1}^{n} (x_i-E(x))^2 }$
- quantMode为0时，量化模式为静态量化，输出scaleOut无实际意义：
  $r e s = y / s c a l e + z e r o P o i n t s O p t i o n a l$
- quantMode为1时，量化模式为动态量化：
  $t m p = y * s c a l e$ $scaleOut = row\_max(abs(tmp))/dtypeMax$ $r e s = r o u n d (y / s c a l e O u t)$

函数原型

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

aclnnStatus aclnnLayerNormQuantGetWorkspaceSize(
  const aclTensor *x,
  const aclTensor *gamma,
  const aclTensor *beta,
  const aclTensor *scale,
  const aclTensor *zeroPointsOptional,
  int              quantMode,
  double           epsilon,
  aclTensor       *res,
  aclTensor       *scaleOut,
  uint64_t        *workspaceSize,
  aclOpExecutor  **executor)

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

aclnnLayerNormQuantGetWorkspaceSize

参数说明

参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
x（aclTensor*）	输入	表示层归一化中的x参数。对应公式中的`x`。	支持空Tensor。	FLOAT32、FLOAT16、BFLOAT16	ND	1-8	√
gamma（aclTensor*）	输入	表示层归一化中的gamma参数。对应公式中的`gamma`。	支持空Tensor。 quantMode为0时，shape支持2维，且第一维为1。 quantMode为1时，shape需要与x维度一致，除最后一维外，其他维度为1。最后一维需要和`x`的最后一维相同。数据类型需要与`x`保持一致。	FLOAT32、FLOAT16、BFLOAT16	ND	1-8	√
beta（aclTensor*）	输入	对应LayerNorm计算公式中的beta，表示层归一化中的beta参数。对应公式中的`beta`。	支持空Tensor。 shape和`gamma`一致。数据类型需要与`x`保持一致。	FLOAT32、FLOAT16、BFLOAT16	ND	1-8	√
scale（aclTensor*）	输入	表示被融合的量化计算中的scale输入。对应公式中的`scale`。	支持空Tensor。 shape为[1]，维度为1。数据类型需要与`x`保持一致。	FLOAT32、FLOAT16、BFLOAT16	ND	1	√
zeroPointsOptional（aclTensor*）	输入	可选输入。表示被融合的量化计算中的zeroPointsOptional输入。仅在quantMode为0时有效，对应公式中的`zeroPointsOptional`。	支持空Tensor。 shape需要与`scale`保持一致。	INT8	ND	1	√
quantMode（int）	输入	量化模式，用于确定融合算子融合的时静态还是动态量化算子。对应公式中的`quantMode`。取值为0（静态量化）或1（动态量化）。	当前仅支持取值为0。	-	-	-	-
epsilon（double）	输入	表示对应LayerNorm中的epsilon，添加到分母中的值，以确保数值稳定。对应公式中的`epsilon`。	默认值为1e-5。	-	-	-	-
res（aclTensor*）	输出	表示LayerNorm的结果输出y被量化后的结果。对应公式中的`res`。	shape需要与输入x一致。	INT8	ND	1-8	√
scaleOut（aclTensor*）	输出	表示动态量化计算的scaleOut结果输出，对应公式中的`scaleOut`，仅在quantMode等于1时有效。	shape为x的shape剔除掉最后一维。	FLOAT32	ND	0-7	√
workspaceSize（uint64_t*）	输出	返回需要在Device侧申请的workspace大小。	-	-	-	-	-
executor（aclOpExecutor**）	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

Atlas A3 训练系列产品/Atlas A3 推理系列产品、Atlas A2 训练系列产品/Atlas A2 推理系列产品：

入参x、gamma、beta、scale的数据类型不支持FLOAT32。
Atlas 推理系列产品：
- 入参x、gamma、beta、scale的数据类型仅支持FLOAT16。
- 入参x、gamma、beta的尾轴长度必须大于等于32Bytes。

返回值

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

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

返回码	错误码	描述
ACLNN_ERR_PARAM_NULLPTR	161001	如果传入参数是必选输入，输出或者必选属性，且是空指针。
ACLNN_ERR_PARAM_INVALID	161002	硬件平台不在支持的产品范围内。
		输入数据类型不满足约束。
		gamma的最后一维和x最后一维不一致。
		x、res的shape不相同。
		gamma、beta的shape不相同。
		zeroPointsOptional、scale的shape不相同。
		quantMode的取值不为0。

aclnnLayerNormQuant

参数说明

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

返回值

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

约束说明

确定性计算：
- aclnnLayerNormQuant默认确定性实现。

调用示例

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

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_layer_norm_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 shapeSize = 1;
    for (auto i : shape) {
        shapeSize *= i;
    }
    return shapeSize;
}

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 == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

    // 2. 构造输入与输出，需要根据API的接口自定义构造
    float eps = 1e-6;
    int quantMode = 0;

    std::vector<int64_t> xShape = {1, 1, 32};
    std::vector<int64_t> gammaShape = {1, 32};
    std::vector<int64_t> betaShape = {1, 32};
    std::vector<int64_t> scaleOptionalShape = {1};
    std::vector<int64_t> zeroPointOptionalShape = {1};

    std::vector<int64_t> outputYShape = {1, 1, 32};
    std::vector<int64_t> outputScaleShape = {1, 1};

    void* xDeviceAddr = nullptr;
    void* gammaDeviceAddr = nullptr;
    void* betaDeviceAddr = nullptr;
    void* scaleOptionalDeviceAddr = nullptr;
    void* zeroPointOptionalDeviceAddr = nullptr;

    void* outputYDeviceAddr = nullptr;
    void* outputScaleDeviceAddr = nullptr;

    aclTensor* x = nullptr;
    aclTensor* gamma = nullptr;
    aclTensor* beta = nullptr;
    aclTensor* scaleOptional = nullptr;
    aclTensor* zeroPointOptional = nullptr;

    aclTensor* outputY = nullptr;
    aclTensor* outputScale = nullptr;

    std::vector<float> xHostData = {1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2, 2, 2};
    std::vector<float> gammaHostData = {2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2};
    std::vector<float> betaHostData = {1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1};
    std::vector<float> scaleOptionalHostData = {1};
    std::vector<int8_t> zeroPointOptionalHostData = {1};

    std::vector<int8_t> outputYHostData(1 * 1 * 32);
    std::vector<float> outputScaleHostData(1);

    // 创建self aclTensor
    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(betaHostData, betaShape, &betaDeviceAddr, aclDataType::ACL_FLOAT16, &beta);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(scaleOptionalHostData, scaleOptionalShape, &scaleOptionalDeviceAddr, aclDataType::ACL_FLOAT16, &scaleOptional);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(
        zeroPointOptionalHostData, zeroPointOptionalShape, &zeroPointOptionalDeviceAddr, aclDataType::ACL_INT8, &zeroPointOptional);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    ret = CreateAclTensor(outputYHostData, outputYShape, &outputYDeviceAddr, aclDataType::ACL_INT8, &outputY);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    ret = CreateAclTensor(
        outputScaleHostData, outputScaleShape, &outputScaleDeviceAddr, aclDataType::ACL_FLOAT, &outputScale);
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // aclnnLayerNormQuant接口调用示例
    // 3. 调用CANN算子库API，需要修改为具体的API名称

    // 调用aclnnLayerNormQuant第一段接口
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;
    LOG_PRINT("\nUse aclnnLayerNormQuant Port.");
    ret = aclnnLayerNormQuantGetWorkspaceSize(
        x, gamma, beta, scaleOptional, zeroPointOptional, quantMode, eps, outputY, outputScale, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnLayerNormQuantGetWorkspaceSize 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;);
    }
    // 调用aclnnLayerNormQuant第二段接口
    ret = aclnnLayerNormQuant(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnLayerNormQuant 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的接口定义修改
    auto outputYSize = GetShapeSize(outputYShape);
    std::vector<int8_t> resultDataY(outputYSize, 0);
    ret = aclrtMemcpy(
        resultDataY.data(), resultDataY.size() * sizeof(resultDataY[0]), outputYDeviceAddr,
        outputYSize * sizeof(resultDataY[0]), ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret);
    for (int64_t i = 0; i < outputYSize; i++) {
        LOG_PRINT("result[%ld] is: %d\n", i, resultDataY[i]);
    }

    if (quantMode == 1){
        auto outputScaleSize = GetShapeSize(outputScaleShape);
        std::vector<float> resultDataScale(outputScaleSize, 0);
        ret = aclrtMemcpy(
            resultDataScale.data(), resultDataScale.size() * sizeof(resultDataScale[0]), outputScaleDeviceAddr,
            outputScaleSize * sizeof(resultDataScale[0]), ACL_MEMCPY_DEVICE_TO_HOST);
        CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret);
        for (int64_t i = 0; i < outputScaleSize; i++) {
            LOG_PRINT("result[%ld] is: %f\n", i, resultDataScale[i]);
        }
    }

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

    aclDestroyTensor(outputY);
    aclDestroyTensor(outputScale);

    // 7. 释放device资源，需要根据具体API的接口定义修改
    aclrtFree(xDeviceAddr);
    aclrtFree(gammaDeviceAddr);
    aclrtFree(betaDeviceAddr);
    aclrtFree(scaleOptionalDeviceAddr);
    aclrtFree(zeroPointOptionalDeviceAddr);

    aclrtFree(outputYDeviceAddr);
    aclrtFree(outputScaleDeviceAddr);

    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }

    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();
    return 0;
}