aclnnQuantize
支持的产品型号
- Atlas 推理系列产品。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
接口原型
每个算子分为两段式接口,必须先调用“aclnnQuantizeGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnQuantize”接口执行计算。
aclnnStatus aclnnQuantizeGetWorkspaceSize(const aclTensor* x, const aclTensor* scales, const aclTensor* zeroPoints, aclDataType dtype, int32_t axis, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
aclnnStatus aclnnQuantize(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
功能描述
- 算子功能:对输入张量进行量化处理。
- 计算公式:
aclnnQuantizeGetWorkspaceSize
参数说明
- x(aclTensor*, 计算输入):必选参数,表示需要进行量化的源数据张量,公式中的
x
,Device侧的aclTensor,数据格式支持ND,支持非连续的Tensor。- Atlas 推理系列产品:数据类型支持FLOAT、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT、FLOAT16、BFLOAT16。
- scales(aclTensor*, 计算输入):必选参数,表示量化过程中对x进行scales的张量,公式中的
scales
,Device侧的aclTensor,维度需要为1维,数据格式支持ND,支持非连续的Tensor,size需要为1或和输入x中axis轴的size相等。- Atlas 推理系列产品:数据类型支持FLOAT、FLOAT16。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持FLOAT、FLOAT16、BFLOAT16。
- zeroPoints(aclTensor*, 计算输入):可选参数,表示量化过程中对x进行offset的张量,公式中的
zero_points
,Device侧的aclTensor,维度需要为1维,数据格式支持ND,支持非连续的Tensor,size需要为1或和输入x中axis轴的size相等,并与scales的size相等。- Atlas 推理系列产品:数据类型支持INT32、INT8、UINT8。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持INT32、INT8、UINT8、BFLOAT16。
- axis(int32_t,入参):必选参数,Host侧的整型,表示需要进行量化的elewise轴,其他的轴做broadcast,指定的轴不能超过输入x的维度数,当输入的scales和zeroPoints的size均为1时,该参数实际不使用。
- dtype(aclDataType,入参):必选参数,表示量化输出Tensor的数据类型,支持ACL_INT8、ACL_UINT8、ACL_INT32。
- out(aclTensor*,计算输出):必选参数,表示量化输出Tensor,公式中的
out
,Device侧的aclTensor,数据类型支持INT8、UINT8、INT32,数据格式支持ND,支持非连续的Tensor。 - workspaceSize(uint64_t*, 出参):返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**, 出参):返回op执行器,包含了算子计算流程。
- x(aclTensor*, 计算输入):必选参数,表示需要进行量化的源数据张量,公式中的
返回值
aclnnStatus:返回状态码,具体参见aclnn返回码。
返回161001(ACLNN_ERR_PARAM_NULLPTR):1. 传入的x1、x2或out是空指针。 返回161002(ACLNN_ERR_PARAM_INVALID):1. x1、x2、bias或out的数据类型/数据格式/维度不在支持的范围之内。 2. 输入axis指定的轴超出输入x的维度数。 3. 输入dtype不在支持的范围之内。 4. 输入scales和zeroPoints的size不相等。 5. 输入scales和zeroPoints的size不为1时,与输入axis指定轴的size不相等。 6. 输入out的数据类型与输入dtype不一致。 7. 输入scales或者zeroPoints数据类型为BFLOAT16时,输入x、scales、zeroPoints的数据类型不全为BFLOAT16。
aclnnQuantize
参数说明
- workspace(void*, 入参):在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t, 入参):在Device侧申请的workspace大小,由第一段接口aclnnQuantizeGetWorkspaceSize获取。
- executor(aclOpExecutor*, 入参):op执行器,包含了算子计算流程。
- stream(aclrtStream, 入参):指定执行任务的AscendCL Stream流。
返回值
aclnnStatus:返回状态码,具体参见aclnn返回码。
约束与限制
当输入scales或zeroPoints任意一个数据类型为BFLOAT16时,要求x、scales、zeroPoints的数据类型均为BFLOAT16。
调用示例
示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_quantize.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) {
// 固定写法,AscendCL初始化
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初始化,参考AscendCL对外接口列表
// 根据自己的实际device填写deviceId
int32_t deviceId = 0;
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 = {4, 2};
std::vector<int64_t> scalesShape = {2};
std::vector<int64_t> zeroPointsShape = {2};
std::vector<int64_t> outShape = {4, 2};
void* xDeviceAddr = nullptr;
void* scalesDeviceAddr = nullptr;
void* zeroPointsDeviceAddr = nullptr;
void* outDeviceAddr = nullptr;
aclTensor* x = nullptr;
aclTensor* scales = nullptr;
aclTensor* zeroPoints = nullptr;
aclTensor* out = nullptr;
aclDataType dataType = ACL_INT32;
int32_t axis = 1;
std::vector<float> scalesHostData = {1.0, -3.0};
std::vector<int32_t> zeroPointsData = {2, 10};
std::vector<float> xHostData = {0.3382, -0.0919, 0.7564, 0.0234, 3.1024, 1.0761, 0.4228, 1.4621};
std::vector<int32_t> outHostData = {8, 0};
// 创建x aclTensor
ret = CreateAclTensor(xHostData, xShape, &xDeviceAddr, aclDataType::ACL_FLOAT, &x);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建scales aclTensor
ret = CreateAclTensor(scalesHostData, scalesShape, &scalesDeviceAddr, aclDataType::ACL_FLOAT, &scales);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建zeroPoints aclTensor
ret = CreateAclTensor(zeroPointsData, zeroPointsShape, &zeroPointsDeviceAddr, aclDataType::ACL_INT32, &zeroPoints);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建out aclTensor
ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, dataType, &out);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. 调用CANN算子库API,需要修改为具体的API名称
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnQuantize第一段接口
ret = aclnnQuantizeGetWorkspaceSize(x, scales, zeroPoints, dataType, axis, out, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQuantizeGetWorkspaceSize 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);
}
// 调用aclnnQuantize第二段接口
ret = aclnnQuantize(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQuantize 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 outSize = GetShapeSize(outShape);
std::vector<int32_t> outData(outSize, 0);
ret = aclrtMemcpy(outData.data(), outData.size() * sizeof(outData[0]), outDeviceAddr,
outSize * sizeof(outData[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 < outSize; i++) {
LOG_PRINT("out[%ld] is: %d\n", i, outData[i]);
}
// 6. 释放aclTensor和aclScalar,需要根据具体API的接口定义修改
aclDestroyTensor(x);
aclDestroyTensor(scales);
aclDestroyTensor(zeroPoints);
aclDestroyTensor(out);
// 7. 释放device资源,需要根据具体API的接口定义修改
aclrtFree(xDeviceAddr);
aclrtFree(scalesDeviceAddr);
aclrtFree(zeroPointsDeviceAddr);
aclrtFree(outDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}