--- title: aclnnDynamicMxQuantV2 description: "[? 查看源码](https://gitcode.com/cann/ops-nn/tree/master/quant/dynamic_mx_quant)" url: https://www.hiascend.com/document/detail/zh/CANNCommunityEdition/latest/API/aolapi/context/ops-nn/aclnnDynamicMxQuantV2.md sourcePath: /source/zh/CANNCommunityEdition/920beta2/API/aolapi/context/ops-nn/aclnnDynamicMxQuantV2.md indexId: 6fb7b86bae9ad88e59debcabff7e19eaa2047395b50f1cc4a93e4c6a319fcbcf91 --- # aclnnDynamicMxQuantV2 [? 查看源码](https://gitcode.com/cann/ops-nn/tree/master/quant/dynamic_mx_quant) ## 产品支持情况 - Ascend 950PR/Ascend 950DT：支持 - Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持 - Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持 - Atlas 200I/500 A2 推理产品：不支持 - Atlas 推理系列产品：不支持 - Atlas 训练系列产品：不支持 ## 功能说明 - 接口功能：目的数据类型为FLOAT4类、FLOAT8类的MX量化。在给定的轴axis上，根据每blocksize个数，计算出这组数对应的量化尺度mxscale作为输出mxscaleOut的对应部分，然后对这组数每一个除以mxscale，根据round_mode转换到对应的dstType，得到量化结果y作为输出yOut的对应部分。在dstType为FLOAT8_E4M3FN、FLOAT8_E5M2时，根据scaleAlg的取值来指定计算mxscale的不同算法。相较于aclnnDynamicMxQuant，本接口新增dstTypeMax参数，可以根据dstTypeMax设置目标数据类型的最大值。 - 计算公式： - 场景1，当scaleAlg为0时： - 将输入x在axis维度上按k = blocksize个数分组，一组k个数${{V_i}_{i=1}^{k}}$动态量化为${mxscale1, {P_i}_{i=1}^{k}}$, k = blocksize $$ shared_exp = floor(log_2(max_i(|V_i|))) - emax \ mxscale = 2^{shared_exp}\ P_i = cast_to_dst_type(V_i/mxscale, round_mode), \space i\space from\space 1\space to\space blocksize\ $$ - ​量化后的$P_{i}$按对应的$V_{i}$的位置组成输出yOut，mxscale按对应的axis维度上的分组组成输出mxscaleOut。 - emax: 对应数据类型的最大正则数的指数位。 | DataType | emax | | :-----------: | :--: | | FLOAT4_E2M1 | 2 | | FLOAT4_E1M2 | 0 | | FLOAT8_E4M3FN | 8 | | FLOAT8_E5M2 | 15 | - 场景2，当scaleAlg为1时，只涉及FP8类型： - 将长向量按块分，每块长度为k，对每块单独计算一个块缩放因子$S_{fp32}^b$，再把块内所有元素用同一个$S_{fp32}^b$映射到目标低精度类型FP8。如果最后一块不足k个元素，把缺失值视为0，按照完整块处理。 - 找到该块中数值的最大绝对值: $$ Amax(D_{fp32}^b)=max({|d_{i}|}_{i=1}^{k}) $$ - 将FP32映射到目标数据类型FP8可表示的范围内，其中$Amax(DType)$是目标精度能表示的最大值 $$ S_{fp32}^b = \frac{Amax(D_{fp32}^b)}{Amax(DType)} $$ - 将块缩放因子$S_{fp32}^b$转换为FP8格式下可表示的缩放值$S_{ue8m0}^b$ - 从块的浮点缩放因子$S_{fp32}^b$中提取无偏指数$E_{int}^b$和尾数$M_{fixp}^b$ - 为保证量化时不溢出，对指数进行向上取整，且在FP8可表示的范围内： $$ E_{int}^b = \begin{cases} E_{int}^b + 1, & \text{如果} S_{fp32}^b \text{为正规数，且} E_{int}^b < 254 \text{且} M_{fixp}^b > 0 \ E_{int}^b + 1, & \text{如果} S_{fp32}^b \text{为非正规数，且} M_{fixp}^b > 0.5 \ E_{int}^b, & \text{否则} \end{cases} $$ - 计算块缩放因子：$S_{ue8m0}^b=2^{E_{int}^b}$ - 计算块转换因子：$R_{fp32}^b=\frac{1}{fp32(S_{ue8m0}^b)}$ - 应用到量化的最终步骤，对于每个块内元素，$d^i = DType(d_{fp32}^i \cdot R_{fp32}^n)$，最终输出的量化结果是$\left(S^b, [d^i]_{i=1}^k\right)$，其中$S^b$代表块的缩放因子，这里指$S_{ue8m0}^b$，$[d^i]_{i=1}^k$代表块内量化后的数据。 - 场景3，当scaleAlg为2时，只涉及FP4_E2M1类型： - 当dstTypeMax = 0.0/6.0/7.0时： - 将输入x在axis维度上按k = blocksize个数分组，一组k个数 ${{V_i}_{i=1}^{k}}$ 动态量化为 ${mxscale1, {P_i}_{i=1}^{k}}$, k = blocksize： $$ shared_exp = \begin{cases} ceil(log_2(max_i(|V_i|))) - emax, & \text{如果} 尾数位的高比特前一/两位 \text{为1，且尾数不全为0} \ floor(log_2(max_i(|V_i|))) - emax, & \text{其它} \end{cases} \ $$ $$ P_i = cast_to_dst_type(V_i/mxscale, round_mode), \space i\space from\space 1\space to\space blocksize\ $$ - ​量化后的$P_{i}$按对应的$V_{i}$的位置组成输出yOut，mxscale按对应的axis维度上的分组组成输出mxscaleOut。 - 当dstTypeMax != 0.0/6.0/7.0时： - 将长向量按块分，每块长度为k，对每块单独计算一个块缩放因子$S_{fp32}^b$，再把块内所有元素用同一个$S_{fp32}^b$映射到目标低精度类型。如果最后一块不足k个元素，把缺失值视为0，按照完整块处理。 - 找到该块中数值的最大绝对值: $$ Amax(D_{fp32}^b)=max({|d_{i}|}_{i=1}^{k}) $$ - 将FP32映射到目标数据类型可表示的范围内，其中当dst_max_value=0时，$Amax(DType)$是目标精度能表示的最大值；当dst_max_value!=0时，$Amax(DType)$是dst_max_value传入值。 $$ S_{fp32}^b = \frac{Amax(D_{fp32}^b)}{Amax(DType)} $$ - 将块缩放因子$S_{fp32}^b$转换为FP8格式下可表示的缩放值$S_{ue8m0}^b$。 - 从块的浮点缩放因子$S_{fp32}^b$中提取无偏指数$E_{int}^b$和尾数$M_{fixp}^b$。 - 为保证量化时不溢出，对指数进行向上取整，且在FP8可表示的范围内： $$ E_{int}^b = \begin{cases} E_{int}^b + 1, & \text{如果} S_{fp32}^b \text{为正规数，且} E_{int}^b < 254 \text{且} M_{fixp}^b > 0 \ E_{int}^b, & \text{否则} \end{cases} $$ - 计算块缩放因子：$S_{ue8m0}^b=2^{E_{int}^b}$ - 计算块转换因子：$R_{fp32}^b=\frac{1}{fp32(S_{ue8m0}^b)}$ - 应用到量化的最终步骤，对于每个块内元素，$d^i = DType(d_{fp32}^i \cdot R_{fp32}^n)$，最终输出的量化结果是$\left(S^b, [d^i]_{i=1}^k\right)$，其中$S^b$代表块的缩放因子，这里指$S_{ue8m0}^b$，$[d^i]_{i=1}^k$代表块内量化后的数据。 - ​量化后的$P_{i}$按对应的$V_{i}$的位置组成输出yOut，mxscale按对应的axis维度上的分组组成输出mxscaleOut。 ## 函数原型 每个算子分为两段式接口，必须先调用“aclnnDynamicMxQuantV2GetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnDynamicMxQuantV2”接口执行计算。 ```cpp aclnnStatus aclnnDynamicMxQuantV2GetWorkspaceSize( const aclTensor *x, int64_t axis, char *roundModeOptional, int64_t dstType, int64_t blocksize, int64_t scaleAlg, double dstTypeMax, const aclTensor *yOut, const aclTensor *mxscaleOut, uint64_t *workspaceSize, aclOpExecutor **executor) ``` ```cpp aclnnStatus aclnnDynamicMxQuantV2( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream) ``` ## aclnnDynamicMxQuantV2GetWorkspaceSize - **参数说明** | 参数名 | 输入/输出 | 描述 | 使用说明 | 数据类型 | 数据格式 | 维度(shape) | 非连续Tensor | | --- | --- | --- | --- | --- | --- | --- | --- | | x（aclTensor*） | 输入 | 表示输入x，对应公式中Vi和di。 | 目的类型为FLOAT4_E2M1、FLOAT4_E1M2时，x的最后一维必须是偶数。 x的类型为FLOAT时，仅支持blocksize=32，且量化轴的维度不能小于32。 | FLOAT16、BFLOAT16、FLOAT | ND | 1-7 | √ | | axis（int64_t） | 输入 | 表示量化发生的轴，对应公式中的axis。 | 取值范围为[-D, D-1]，D为x的shape的维数。 | INT64 | ND | - | - | | roundModeOptional（char*） | 输入 | 表示数据转换的模式，对应公式中的round_mode。 | 当dstType为40/41时，支持{"rint", "floor", "round"}。 当dstType为36/35时，仅支持{"rint"}。 传入空指针时，采用"rint"模式。 | STRING | ND | - | - | | dstType（int64_t） | 输入 | 表示指定数据转换后yOut的类型，对应公式中的DType。 | 输入范围为{35, 36, 40, 41}，分别对应输出yOut的数据类型为{35:FLOAT8_E5M2, 36:FLOAT8_E4M3FN, 40:FLOAT4_E2M1, 41:FLOAT4_E1M2}。 | INT64 | ND | - | - | | blocksize（int64_t） | 输入 | 表示指定每次量化的元素个数，对应公式中的blocksize。 | 仅支持32的倍数，不能为0，且不能超过1024。 当scaleAlg为2时，blocksize必须为32。 当x的类型为FLOAT时，blocksize必须为32。 | INT64 | ND | - | - | | scaleAlg（int64_t） | 输入 | 表示mxscaleOut的计算方法，对应公式中的scaleAlg。 | 支持取值0、1和2，取值为0代表场景1，为1代表场景2，为2代表场景3。 当dstType为FLOAT4_E1M2时仅支持取值为0；当dstType为FLOAT4_E2M1时仅支持取值为0和2；当dstType为FLOAT8时仅支持取值为0和1。 | INT64 | ND | - | - | | dstTypeMax（double） | 输入 | 表示maxType的取值，对应公式中的Amax(DType)。 | 支持取值0.0和6.0-12.0，取值为0.0代表Amax(DType)为量化结果数据类型的最大值；取值为6.0-12.0代表Amax(DType)为传入值。仅支持在FP4E2M1和blocksize取32时设置该值 | DOUBLE | ND | - | - | | yOut（aclTensor*） | 输出 | 表示输入x量化后的对应结果，对应公式中的Pi和di。 | shape和输入x一致。 | FLOAT4_E2M1、FLOAT4_E1M2、FLOAT8_E4M3FN、FLOAT8_E5M2 | ND | 1-7 | × | | mxscaleOut（aclTensor*） | 输出 | 表示每个分组对应的量化尺度，对应公式中的mxscale和Sb。 | shape在axis轴上为x对应轴的值除以blocksize向上取整，并对其进行偶数pad，pad填充值为0。 当axis为非尾轴时，mxscaleOut输出需要对每两行数据进行交织处理。 | FLOAT8_E8M0 | ND | 1-8 | × | | workspaceSize（uint64_t） | 输出 | 返回需要在Device侧申请的workspace大小。 | - | - | - | - | - | | executor（aclOpExecutor**） | 输出 | 返回op执行器，包含了算子计算流程。 | - | - | - | - | - | - **返回值** aclnnStatus：返回状态码，具体参见aclnn返回码。 第一段接口完成入参校验，出现以下场景时报错： | 返回码 | 错误码 | 描述 | | --- | --- | --- | | ACLNN_ERR_PARAM_NULLPTR | 161001 | x存在空指针。 | | ACLNN_ERR_PARAM_INVALID | 161002 | x、axis、roundModeOptional、dstType、blocksize、scaleAlg、dstTypeMax、yOut、mxscaleOut的数据类型和数据格式不在支持的范围之内。 | | x、yOut或mxscaleOut的shape不满足校验条件。 | - | - | | axis、roundModeOptional、dstType、blocksize、scaleAlg、dstTypeMax不符合当前支持的值。 | - | - | | ACLNN_ERR_RUNTIME_ERROR | 361001 | 当前平台不在支持的平台范围内。 | ## aclnnDynamicMxQuantV2 - **参数说明** | 参数名 | 输入/输出 | 描述 | | --- | --- | --- | | workspace | 输入 | 在Device侧申请的workspace内存地址。 | | workspaceSize | 输入 | 在Device侧申请的workspace大小，由第一段接口aclnnDynamicMxQuantV2GetWorkspaceSize获取。 | | executor | 输入 | op执行器，包含了算子计算流程。 | | stream | 输入 | 指定执行任务的Stream。 | - **返回值** aclnnStatus：返回状态码，具体参见aclnn返回码。 ## 约束说明 - 确定性计算： - aclnnDynamicMxQuantV2默认确定性实现。 - 关于x、mxscaleOut的shape约束说明如下： - rank(mxscaleOut) = rank(x) + 1。 - axis_change = axis if axis >= 0 else axis + rank(x)。 - mxscaleOut.shape[axis_change] = (ceil(x.shape[axis] / blocksize) + 2 - 1) / 2。 - mxscaleOut.shape[-1] = 2。 - 其他维度与输入x一致。 - 当x的数据类型为FLOAT时： - blocksize必须为32。 - 量化轴的维度不能小于32。 ## 调用示例 示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。 ```Cpp #include #include #include #include "acl/acl.h" #include "aclnnop/aclnn_dynamic_mx_quant_v2.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& 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 int CreateAclTensor(const std::vector& hostData, const std::vector& 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 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 aclnnDynamicMxQuantV2Test(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 xShape = {1, 4}; std::vector yOutShape = {1, 4}; std::vector mxscaleOutShape = {1, 1, 2}; void* xDeviceAddr = nullptr; void* yOutDeviceAddr = nullptr; void* mxscaleOutDeviceAddr = nullptr; aclTensor* x = nullptr; aclTensor* yOut = nullptr; aclTensor* mxscaleOut = nullptr; //对应BF16的值(0, 8, 64, 512) std::vector xHostData = {0, 16640, 17024, 17408}; //对应float8_e4m3的值(0, 4, 32, 256) std::vector yOutHostData = {0, 72, 96, 120}; //对应float8_e8m0的值(2) std::vector mxscaleOutHostData = {{128, 0}}; int64_t axis = -1; char* roundModeOptional = const_cast("rint"); int64_t dstType = 36; int64_t blocksize = 32; int64_t scaleAlg = 0; double dstTypeMax = 0.0; // 创建x aclTensor ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_BF16, &x); std::unique_ptr xTensorPtr(x, aclDestroyTensor); std::unique_ptr xDeviceAddrPtr(xDeviceAddr, aclrtFree); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建yOut aclTensor ret = CreateAclTensor(yOutHostData, yOutShape, &yOutDeviceAddr, aclDataType::ACL_FLOAT8_E4M3FN, &yOut); std::unique_ptr yOutTensorPtr(yOut, aclDestroyTensor); std::unique_ptr yOutDeviceAddrPtr(yOutDeviceAddr, aclrtFree); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建mxscaleOut aclTensor ret = CreateAclTensor(mxscaleOutHostData, mxscaleOutShape, &mxscaleOutDeviceAddr, aclDataType::ACL_FLOAT8_E8M0, &mxscaleOut); std::unique_ptr mxscaleOutTensorPtr(mxscaleOut, aclDestroyTensor); std::unique_ptr mxscaleOutDeviceAddrPtr(mxscaleOutDeviceAddr, aclrtFree); CHECK_RET(ret == ACL_SUCCESS, return ret); // 调用CANN算子库API，需要修改为具体的Api名称 uint64_t workspaceSize = 0; aclOpExecutor* executor; // 调用aclnnDynamicMxQuantV2第一段接口 ret = aclnnDynamicMxQuantV2GetWorkspaceSize(x, axis, roundModeOptional, dstType, blocksize, scaleAlg, dstTypeMax, yOut, mxscaleOut, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDynamicMxQuantV2GetWorkspaceSize failed. ERROR: %d\n", ret); return ret); // 根据第一段接口计算出的workspaceSize申请device内存 void* workspaceAddr = nullptr; std::unique_ptr 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); } // 调用aclnnDynamicMxQuantV2第二段接口 ret = aclnnDynamicMxQuantV2(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDynamicMxQuantV2 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); std::vector 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(mxscaleOutShape); std::vector mxscaleOutData( size, 0); // C语言中无法直接打印fp8的数据，需要用uint8读出来，自行通过二进制转成fp8 ret = aclrtMemcpy(mxscaleOutData.data(), mxscaleOutData.size() * sizeof(mxscaleOutData[0]), mxscaleOutDeviceAddr, size * sizeof(mxscaleOutData[0]), ACL_MEMCPY_DEVICE_TO_HOST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy mxscaleOut from device to host failed. ERROR: %d\n", ret); return ret); for (int64_t i = 0; i < size; i++) { LOG_PRINT("mxscaleOut[%ld] is: %d\n", i, mxscaleOutData[i]); } return ACL_SUCCESS; } int main() { // 1. （固定写法）device/stream初始化，参考acl API手册 // 根据自己的实际device填写deviceId int32_t deviceId = 0; aclrtStream stream; auto ret = aclnnDynamicMxQuantV2Test(deviceId, stream); CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnDynamicMxQuantV2Test failed. ERROR: %d\n", ret); return ret); Finalize(deviceId, stream); return 0; } ```