aclnnDynamicDualLevelMxQuant

产品支持情况

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

功能说明

接口功能：目的数据类型为FLOAT4类的MX量化。只对尾轴进行量化，前面所有的轴都合轴处理，通过给定的level0BlockSize将输入划分成多个数据块，对每个数据块进行一级量化，输出量化尺度level0ScaleOut；然后将一级量化的结果作为新的输入，并通过给定的level1BlockSize将其划分成多个数据块，对每个数据块进行二级量化，输出量化尺度level1ScaleOut，根据round_mode进行数据类型的转换，得到量化结果yOut，具体参见图示。
- 可选功能：融合smooth scale运算，在对数据输入x进行量化前先进行x=x*smooth_scale（广播逐元素乘法）。
计算公式：
- 将输入x在尾轴上按 $k_0$ = level0BlockSize个数分组，一组 $k_0$ 个数 ${\{x_i\}_{i=1}^{k_0}\}$ 动态量化为 ${level0Scale, \{temp_i\}_{i=1}^{k_0}\}$ , $k_0$ = level0BlockSize，然后将temp在尾轴上按 $k_1$ = level1BlockSize个数分组，一组 $k_1$ 个数 ${\{temp_i\}_{i=1}^{k_1}\}$ 动态量化为 ${level1Scale, \{y_i\}_{i=1}^{k_1}\}$ , $k_1$ = level1BlockSize
$input\_max_i = max_i(abs(x_i))$

$level0Scale = input\_max_i / (FP4\_E2M1\_MAX)$

$tempi=cast_to_x_type(xi/level0Scale), i from 1 to level0BlockSizetemp_i = cast\_to\_x\_type(x_i / level0Scale), \space i\space from\space 1\space to\space level0BlockSize$

$shared\_exp = floor(log_2(max_i(|temp_i|))) - emax$

$level1Scale = 2^{shared\_exp}$

$yi=cast_to_FP4_E2M1(tempi/level1Scale,round_mode), i from 1 to level1BlockSizey_i = cast\_to\_FP4\_E2M1(temp_i/level1Scale, round\_mode), \space i\space from\space 1\space to\space level1BlockSize$
- 量化后的 $y_{i}$ 按对应的 $x_{i}$ 的位置组成输出yOut，level0Scale按尾轴对应的分组组成输出level0ScaleOut，level1Scale按尾轴对应的分组组成输出level1ScaleOut。
- max_i代表求第i个分组中的最大值
- emax: 对应数据类型的最大正则数的指数位。
  
  DataType emax
  
  FLOAT4_E2M1 2

DataType	emax
FLOAT4_E2M1	2

函数原型

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

aclnnStatus aclnnDynamicDualLevelMxQuantGetWorkspaceSize(
  const aclTensor *x, 
  const aclTensor *smoothScaleOptional, 
  char            *roundModeOptional, 
  int64_t          level0BlockSize, 
  int64_t          level1BlockSize, 
  const aclTensor *yOut, 
  const aclTensor *level0ScaleOut, 
  const aclTensor *level1ScaleOut, 
  uint64_t        *workspaceSize, 
  aclOpExecutor   **executor)

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

aclnnDynamicDualLevelMxQuantGetWorkspaceSize

参数说明：

参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
x (aclTensor*)	输入	表示输入x，对应公式中x_i。	x的最后一维必须是偶数；不支持空Tensor。	FLOAT16、BFLOAT16	ND	1-7	√
smoothScalesOptional (aclTensor*)	输入	表示可选输入smoothScaleOptional。	当不需要融合smooth scale运算时，smooth_scale应传入nullptr；当smooth_scale不为nullptr时，smooth_scale的dtype需与x一致，且shape为1维，长度等于x最后一维。	FLOAT16、BFLOAT16（且与输入x一致）	ND	1	√
roundModeOptional (char*)	输入	表示数据转换的模式，对应公式中的round_mode。	支持{"rint", "round", "floor"}；默认值为"rint"。	STRING	-	-	-
level0BlockSize (int64_t)	输入	表示第一级量化的block_size，对应公式中的level0BlockSize。	输入范围为{512}。	INT64	-	-	-
level1BlockSize (int64_t)	输入	表示第二级量化的block_size，对应公式中的level1BlockSize。	输入范围为{32}。	INT64	-	-	-
yOut (aclTensor*)	输出	表示输入x量化后的对应结果，对应公式中的y_i。	shape和输入x一致；不支持空Tensor。	FLOAT4_E2M1	ND	1-7	√
level0ScaleOut (aclTensor*)	输出	表示第一级量化的scale，对应公式中的level0Scale。	shape在尾轴上的值，为x尾轴的值除以level0BlockSize向上取整；不支持空Tensor。	FLOAT32	ND	1-7	√
level1ScaleOut (aclTensor*)	输出	表示第二级量化的scale，对应公式中的level1Scale。	shape的大小为x的dim + 1； shape在最后两轴的值为((ceil(x.shape[-1] / level1Blocksize) + 2 - 1) / 2, 2)，并对其进行偶数pad，pad填充值为0；不支持空Tensor。	FLOAT8_E8M0	ND	1-8	√
workspaceSize	输出	返回需要在Device侧申请的workspace大小。	-	-	-	-	-
executor	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

返回值：

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

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

返回码	错误码	描述
ACLNN_ERR_PARAM_NULLPTR	161001	x存在空指针。
ACLNN_ERR_PARAM_INVALID	161002	x、smoothScaleOptional、yOut、level0ScaleOut、level1ScaleOut的数据类型和数据格式不在支持的范围之内。
		x、smoothScaleOptional、yOut、level0ScaleOut或level1ScaleOut的shape不满足校验条件。
		roundModeOptional、level0BlockSize、level1BlockSize不符合当前支持的值。
ACLNN_ERR_RUNTIME_ERROR	361001	当前平台不在支持的平台范围内。

aclnnDynamicDualLevelMxQuant

参数说明：

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

返回值：

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

约束说明

关于x、level0ScaleOut、level1ScaleOut的shape约束说明如下：
- rank(level1ScaleOut) = rank(x) + 1。
- level0ScaleOut.shape[-1] = ceil(x.shape[-1] / level0Blocksize)。
- level1ScaleOut.shape[-2] = (ceil(x.shape[-1] / level1Blocksize) + 2 - 1) / 2。
- level1ScaleOut.shape[-1] = 2。
- 其他维度与输入x一致。
确定性说明：aclnnDynamicDualLevelMxQuant默认确定性实现。

调用示例

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

#include <iostream>
#include <memory>
#include <vector>

#include "acl/acl.h"
#include "aclnnop/aclnn_dynamic_dual_level_mx_quant.h"

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

#define CHECK_FREE_RET(cond, return_expr) \
    do {                                  \
        if (!(cond)) {                    \
            Finalize(deviceId, stream);   \
            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;
}

void Finalize(int32_t deviceId, aclrtStream stream)
{
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();
}

int aclnnDynamicDualLevelMxQuantTest(int32_t deviceId, aclrtStream& stream)
{
    auto ret = Init(deviceId, &stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

    // 2. 构造输入与输出，需要根据API的接口自定义构造
    std::vector<int64_t> xShape = {1, 512};
    std::vector<int64_t> smoothScaleOptionalShape = {1};
    std::vector<int64_t> yOutShape = {1, 512};
    std::vector<int64_t> level0ScaleOutShape = {1, 1};
    std::vector<int64_t> level1ScaleOutShape = {1, 8, 2};
    void* xDeviceAddr = nullptr;
    void* smoothScaleOptionalDeviceAddr = nullptr;
    void* yOutDeviceAddr = nullptr;
    void* level0ScaleOutDeviceAddr = nullptr;
    void* level1ScaleOutDeviceAddr = nullptr;
    aclTensor* x = nullptr;
    aclTensor* smoothScaleOptional = nullptr;
    aclTensor* yOut = nullptr;
    aclTensor* level0ScaleOut = nullptr;
    aclTensor* level1ScaleOut = nullptr;

    // 对应 BF16 的值 (0->0, 16640->8, 17024->64, 17408->512)
    std::vector<uint16_t> xHostData(512, 16640);
    std::vector<uint16_t> smoothScaleOptionalHostData = {0};
    // 对应 float4_e2m1 的值 (0->0, 72->4, 96->32, 120->256)
    std::vector<uint8_t> yOutHostData(512, 0);
    // 对应 float32 的值 (0->0)
    std::vector<float> level0ScaleOutHostData = {{0}};
    //对应float8_e8m0的值(128->2)
    std::vector<std::vector<std::vector<uint8_t>>> level1ScaleOutHostData(1, std::vector<std::vector<uint8_t>>(8, std::vector<uint8_t>(2, 0)));
    const char* roundModeOptional = "rint";
    int64_t level0Blocksize = 512;
    int64_t level1Blocksize = 32;

    // 创建x aclTensor
    ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_BF16, &x);
    std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> xTensorPtr(x, aclDestroyTensor);
    std::unique_ptr<void, aclError (*)(void*)> xDeviceAddrPtr(xDeviceAddr, aclrtFree);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建smoothScaleOptional aclTensor
    ret = CreateAclTensor(smoothScaleOptionalHostData, smoothScaleOptionalShape, &smoothScaleOptionalDeviceAddr, aclDataType::ACL_BF16, &smoothScaleOptional);
    std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> smoothScaleOptionalTensorPtr(smoothScaleOptional, aclDestroyTensor);
    std::unique_ptr<void, aclError (*)(void*)> smoothScaleOptionalDeviceAddrPtr(smoothScaleOptionalDeviceAddr, aclrtFree);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建yOut aclTensor
    ret = CreateAclTensor(yOutHostData, yOutShape, &yOutDeviceAddr, aclDataType::ACL_FLOAT4_E2M1, &yOut);
    std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> yOutTensorPtr(yOut, aclDestroyTensor);
    std::unique_ptr<void, aclError (*)(void*)> yOutDeviceAddrPtr(yOutDeviceAddr, aclrtFree);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建level0ScaleOut aclTensor
    ret = CreateAclTensor(level0ScaleOutHostData, level0ScaleOutShape, &level0ScaleOutDeviceAddr, aclDataType::ACL_FLOAT, &level0ScaleOut);
    std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> level0ScaleOutTensorPtr(level0ScaleOut, aclDestroyTensor);
    std::unique_ptr<void, aclError (*)(void*)> level0ScaleOutDeviceAddrPtr(level0ScaleOutDeviceAddr, aclrtFree);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建level1ScaleOut aclTensor
    ret = CreateAclTensor(level1ScaleOutHostData, level1ScaleOutShape, &level1ScaleOutDeviceAddr, aclDataType::ACL_FLOAT8_E8M0, &level1ScaleOut);
    std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> level1ScaleOutTensorPtr(level1ScaleOut, aclDestroyTensor);
    std::unique_ptr<void, aclError (*)(void*)> level1ScaleOutDeviceAddrPtr(level1ScaleOutDeviceAddr, aclrtFree);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
   
    // 调用CANN算子库API，需要修改为具体的Api名称
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;
 
    // 调用aclnnDynamicDualLevelMxQuant第一段接口
    ret = aclnnDynamicDualLevelMxQuantGetWorkspaceSize(x, smoothScaleOptional, (char*)roundModeOptional, level0Blocksize, level1Blocksize, yOut, level0ScaleOut, level1ScaleOut, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDynamicDualLevelMxQuantGetWorkspaceSize failed. ERROR: %d\n", ret);
              return ret);
    // 根据第一段接口计算出的workspaceSize申请device内存
    void* workspaceAddr = nullptr;
    std::unique_ptr<void, aclError (*)(void*)> workspaceAddrPtr(nullptr, aclrtFree);
    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);
        workspaceAddrPtr.reset(workspaceAddr);
    }
    // 调用aclnnDynamicDualLevelMxQuant第二段接口
    ret = aclnnDynamicDualLevelMxQuant(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDynamicDualLevelMxQuant failed. ERROR: %d\n", ret); return ret);

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

    // 获取输出的值，将device侧内存上的结果拷贝至host侧，需要根据具体API的接口定义修改
    auto size = GetShapeSize(yOutShape) / 2;
    std::vector<uint8_t> yOutData(
        size, 0);  // C语言中无法直接打印fp4的数据，需要用uint8读出来，自行通过二进制转成fp4
    ret = aclrtMemcpy(yOutData.data(), yOutData.size() * sizeof(yOutData[0]), yOutDeviceAddr,
                      size * sizeof(yOutData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy yOut from device to host failed. ERROR: %d\n", ret);
              return ret);
    for (int64_t i = 0; i < size; i++) {
        LOG_PRINT("yOut[%ld] is: %d\n", i, yOutData[i]);
    }
    size = GetShapeSize(level0ScaleOutShape);
    std::vector<float> level0ScaleOutData(
        size, 0);
    ret = aclrtMemcpy(level0ScaleOutData.data(), level0ScaleOutData.size() * sizeof(level0ScaleOutData[0]), level0ScaleOutDeviceAddr,
                      size * sizeof(level0ScaleOutData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy level0ScaleOut from device to host failed. ERROR: %d\n", ret);
              return ret);
    for (int64_t i = 0; i < size; i++) {
        LOG_PRINT("level0ScaleOut[%ld] is: %f\n", i, level0ScaleOutData[i]);
    }
    size = GetShapeSize(level1ScaleOutShape);
    std::vector<uint8_t> level1ScaleOutData(
        size, 0);  // C语言中无法直接打印fp8的数据，需要用uint8读出来，自行通过二进制转成fp8
    ret = aclrtMemcpy(level1ScaleOutData.data(), level1ScaleOutData.size() * sizeof(level1ScaleOutData[0]), level1ScaleOutDeviceAddr,
                      size * sizeof(level1ScaleOutData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy level1ScaleOut from device to host failed. ERROR: %d\n", ret);
              return ret);
    for (int64_t i = 0; i < size; i++) {
        LOG_PRINT("level1ScaleOut[%ld] is: %d\n", i, level1ScaleOutData[i]);
    }
    return ACL_SUCCESS;
}

int main()
{
    // 1. （固定写法）device/stream初始化，参考acl API手册
    // 根据自己的实际device填写deviceId
    int32_t deviceId = 0;
    aclrtStream stream;
    auto ret = aclnnDynamicDualLevelMxQuantTest(deviceId, stream);
    CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDynamicDualLevelMxQuantTest failed. ERROR: %d\n", ret); return ret);

    Finalize(deviceId, stream);
    return 0;
}