aclnnQuantMax
产品支持情况
| 产品 | 是否支持 |
|---|---|
| Ascend 950PR/Ascend 950DT | √ |
| Atlas A3 训练系列产品/Atlas A3 推理系列产品 | × |
| Atlas A2 训练系列产品/Atlas A2 推理系列产品 | × |
| Atlas 200I/500 A2 推理产品 | × |
| Atlas 推理系列产品 | × |
| Atlas 训练系列产品 | × |
功能说明
-
接口功能：根据输入的scale对输入x进行量化，并计算输入x的绝对值的最大值amax。
-
计算公式：
y=Cast(x×scale,dst_type,round_mode)y = \text{Cast}(x \times scale, \text{dst\_type}, \text{round\_mode})
amax=max(∣x∣)amax = \max(|x|)
其中，xx表示输入张量，scalescale表示量化缩放因子，dst_type\text{dst\_type}指定输出类型，round_mode\text{round\_mode}指定舍入模式，amaxamax为输入张量所有元素绝对值的最大值。
函数原型
每个算子分为两段式接口，必须先调用"aclnnQuantMaxGetWorkspaceSize"接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用"aclnnQuantMax"接口执行计算。
aclnnStatus aclnnQuantMaxGetWorkspaceSize(
const aclTensor *x,
const aclTensor *scale,
char *roundMode,
int64_t dstType,
const aclTensor *y,
const aclTensor *amax,
uint64_t *workspaceSize,
aclOpExecutor **executor)
aclnnStatus aclnnQuantMax(
void *workspace,
uint64_t workspaceSize,
aclOpExecutor *executor,
aclrtStream stream)
aclnnQuantMaxGetWorkspaceSize
-
参数说明
参数名 输入/输出 描述 使用说明 数据类型 数据格式 维度(shape) 非连续Tensor x（aclTensor*） 输入 待量化的输入张量，对应公式中x。 - 支持空Tensor。
FLOAT、FLOAT16、BFLOAT16 ND 1-8 √ scale（aclTensor*） 输入 量化缩放因子，对应公式中scale。 - 不支持空Tensor。
- shape固定为[1]。
FLOAT ND 1 - roundMode（char*） 输入 指定舍入模式。 - 当dstType取值为34，roundMode支持"round"、"hybrid"。
- 当dstType取值为35或者36时，roundMode支持"rint"。
- - - - dstType（int64_t） 输入 指定输出量化数据类型。34=HIFLOAT8，35=FLOAT8_E5M2，36=FLOAT8_E4M3。 - 取值范围为{34, 35, 36}。
- - - - y（aclTensor*） 输出 量化后的输出张量，对应公式中y。 - 数据类型由dstType决定。
- shape与x一致。
HIFLOAT8、FLOAT8_E5M2、FLOAT8_E4M3 ND 1-8 √ amax（aclTensor*） 输出 x绝对值的最大值，对应公式中amax。 - 数据类型需与x一致。
- shape固定为[1]。
FLOAT、FLOAT16、BFLOAT16 ND 1 - workspaceSize（uint64_t*） 输出 返回需要在Device侧申请的workspace大小。 - - - - - executor（aclOpExecutor**） 输出 返回op执行器，包含了算子计算流程。 - - - - - -
返回值
aclnnStatus：返回状态码，具体参见aclnn返回码。
第一段接口完成入参校验，出现以下场景时报错：
返回值 错误码 描述 ACLNN_ERR_PARAM_NULLPTR 161001 x、scale、y、amax存在空指针。 ACLNN_ERR_PARAM_INVALID 161002 x的数据类型不在支持的范围之内。 scale的数据类型不是FLOAT。 dstType取值不在{34, 35, 36}范围之内。 roundMode为无效值。 x的shape维度不在1-8范围之内，或scale、amax的shape不是[1]。
aclnnQuantMax
-
参数说明
参数名 输入/输出 描述 workspace 输入 在Device侧申请的workspace内存地址。 workspaceSize 输入 在Device侧申请的workspace大小，由第一段接口aclnnQuantMaxGetWorkspaceSize获取。 executor 输入 op执行器，包含了算子计算流程。 stream 输入 指定执行任务的Stream。 -
返回值
aclnnStatus：返回状态码，具体参见aclnn返回码。
约束说明
- 确定性计算：
- aclnnQuantMax默认确定性实现。
调用示例
示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <memory>
#include <vector>
#include <cmath>
#include "acl/acl.h"
#include "aclnnop/aclnn_quant_max.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 aclnnQuantMaxTest(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);
LOG_PRINT("Init acl success.\n");
std::vector<int64_t> xShape = {4, 4};
std::vector<int64_t> scaleShape = {1};
std::vector<int64_t> amaxShape = {1};
// x 的值选择可以覆盖多种情况
std::vector<float> xHostData = {1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f,
0.5f, -0.5f, 0.0f, 448.0f, -448.0f, 0.125f, -0.125f, 2.5f};
// scale = 1.0
std::vector<float> scaleHostData = {1.0f};
// 输出 y 初始化为 0
std::vector<uint8_t> yHostData(GetShapeSize(xShape), 0);
// amax 初始化为 0
std::vector<float> amaxHostData = {0.0f};
void* xDeviceAddr = nullptr;
void* scaleDeviceAddr = nullptr;
void* yDeviceAddr = nullptr;
void* amaxDeviceAddr = nullptr;
aclTensor* xTensor = nullptr;
aclTensor* scaleTensor = nullptr;
aclTensor* yTensor = nullptr;
aclTensor* amaxTensor = nullptr;
// Create input x tensor
ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_FLOAT, &xTensor);
std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> xTensorPtr(xTensor, aclDestroyTensor);
std::unique_ptr<void, aclError (*)(void*)> xDeviceAddrPtr(xDeviceAddr, aclrtFree);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// Create scale tensor (float, shape [1])
ret = CreateAclTensor(scaleHostData, scaleShape, &scaleDeviceAddr, aclDataType::ACL_FLOAT, &scaleTensor);
std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> scaleTensorPtr(scaleTensor, aclDestroyTensor);
std::unique_ptr<void, aclError (*)(void*)> scaleDeviceAddrPtr(scaleDeviceAddr, aclrtFree);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// Create output y tensor (FLOAT8_E4M3FN, same shape as x)
ret = CreateAclTensor(yHostData, xShape, &yDeviceAddr, aclDataType::ACL_FLOAT8_E4M3FN, &yTensor);
std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> yTensorPtr(yTensor, aclDestroyTensor);
std::unique_ptr<void, aclError (*)(void*)> yDeviceAddrPtr(yDeviceAddr, aclrtFree);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// Create output amax tensor (float, shape [1])
ret = CreateAclTensor(amaxHostData, amaxShape, &amaxDeviceAddr, aclDataType::ACL_FLOAT, &amaxTensor);
std::unique_ptr<aclTensor, aclnnStatus (*)(const aclTensor*)> amaxTensorPtr(amaxTensor, aclDestroyTensor);
std::unique_ptr<void, aclError (*)(void*)> amaxDeviceAddrPtr(amaxDeviceAddr, aclrtFree);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. Call quant_max API
int64_t dstType = 36; // FLOAT8_E4M3FN
char* roundMode = const_cast<char*>("rint");
uint64_t workspaceSize = 0;
aclOpExecutor* executor = nullptr;
// First stage: get workspace size
ret = aclnnQuantMaxGetWorkspaceSize(
xTensor, scaleTensor, roundMode, dstType, yTensor, amaxTensor, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQuantMaxGetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
LOG_PRINT("aclnnQuantMaxGetWorkspaceSize success, workspaceSize: %lu\n", workspaceSize);
// Allocate workspace
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);
}
// Second stage: execute
ret = aclnnQuantMax(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQuantMax failed. ERROR: %d\n", ret); return ret);
// 4. Synchronize stream
ret = aclrtSynchronizeStream(stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);
LOG_PRINT("aclnnQuantMax execution success.\n");
// 5. Get results
// Copy y (FLOAT8_E4M3FN) back to host
auto ySize = GetShapeSize(xShape);
std::vector<uint8_t> yOutData(ySize, 0);
ret = aclrtMemcpy(
yOutData.data(), ySize * sizeof(uint8_t), yDeviceAddr, ySize * sizeof(uint8_t), ACL_MEMCPY_DEVICE_TO_HOST);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy y from device to host failed. ERROR: %d\n", ret); return ret);
// Copy amax back to host
std::vector<float> amaxOutData(1, 0);
ret = aclrtMemcpy(amaxOutData.data(), sizeof(float), amaxDeviceAddr, sizeof(float), ACL_MEMCPY_DEVICE_TO_HOST);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy amax from device to host failed. ERROR: %d\n", ret); return ret);
// Print results
auto size = GetShapeSize(xShape);
for (int64_t i = 0; i < size; i++) {
LOG_PRINT("yOut[%ld] is: %d\n", i, yOutData[i]);
}
LOG_PRINT("amaxOut is: %f\n", amaxOutData[0]);
return ACL_SUCCESS;
}
int main()
{
// 1. （固定写法）device/stream初始化，参考acl API手册
// 根据自己的实际device填写deviceId
int32_t deviceId = 0;
aclrtStream stream;
auto ret = aclnnQuantMaxTest(deviceId, stream);
CHECK_FREE_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQuantMaxTest failed. ERROR: %d\n", ret); return ret);
Finalize(deviceId, stream);
LOG_PRINT("All test cases passed!\n");
return 0;
}