# aclnnInplaceQuantScatter ## 支持的产品型号 - Atlas A2训练系列产品/Atlas 800I A2推理产品。 - Atlas 推理系列产品。 ## 接口原型每个算子分为[两段式接口](common/两段式接口.md)，必须先调用“aclnnInplaceQuantScatterGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnInplaceQuantScatter”接口执行计算。 * `aclnnStatus aclnnInplaceQuantScatterGetWorkspaceSize(aclTensor* selfRef, const aclTensor* indices, const aclTensor* updates, const aclTensor* quantScales, const aclTensor* quantZeroPoints, int64_t axis, int64_t quantAxis, int64_t reduction, uint64_t* workspaceSize, aclOpExecutor** executor)` * `aclnnStatus aclnnInplaceQuantScatter(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)` ## 功能描述先将updates进行量化，然后将updates中的值按指定的轴axis和索引indices逐个更新selfRef中的值。 ## aclnnInplaceQuantScatterGetWorkspaceSize - **参数说明**： * selfRef(aclTensor*, 计算输入|计算输出)：Device侧的Tensor，源数据张量，数据类型支持INT8，支持3-8维，[数据格式](common/数据格式.md)支持ND，支持[非连续的Tensor](common/非连续的Tensor.md)；其最后一维的大小必须32B对齐。 * indices(aclTensor*, 计算输入)：Device侧的Tensor，索引张量，数据类型支持INT32、INT64类型，仅支持1维或2维；当indices shape为1维时取值范围为[0, selfRef.shape(axis) - updates.shape(axis)); 当indices shape为2维时，indices每项的第0个数据取值范围[0, selfRef.shape(0)), indices每项的第1个数据取值范围[0, selfRef.shape(axis) - updates.shape(axis)); [数据格式](common/数据格式.md)支持ND，支持[非连续的Tensor](common/非连续的Tensor.md)。 * updates(aclTensor*, 计算输入)：Device侧的Tensor，更新数据张量，updates的维数需要与selfRef的维数一样；其第1维的大小等于indices的第1维的大小，且不大于selfRef的第1维的大小；其axis轴的大小不大于selfRef的axis轴的大小；其余维度的大小要跟selfRef对应维度的大小相等；数据类型支持BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）、FLOAT16类型，[数据格式](common/数据格式.md)支持ND，支持[非连续的Tensor](common/非连续的Tensor.md)。 * quantScales(aclTensor*, 计算输入)：Device侧的Tensor，量化缩放张量，支持1-8维，quantScales的元素个数需要等于updates在quantAxis轴的大小；数据类型支持BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）、FLOAT32类型，支持[非连续的Tensor](common/非连续的Tensor.md)，[数据格式](common/数据格式.md)支持ND。 * quantZeroPoints(aclTensor*, 计算输入)：Device侧的Tensor，量化偏移张量，支持1-8维，quantZeroPoints的元素个数需要等于updates在quantAxis轴的大小；数据类型支持BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）、INT32类型，支持[非连续的Tensor](common/非连续的Tensor.md)，[数据格式](common/数据格式.md)支持ND，可选参数。 * axis(int64_t, 计算输入)：updates上用来更新的轴，数据类型为INT64，取值范围[-len(updates.shape) + 1, -1)或者[1, len(updates.shape) - 1)。 * quantAxis(int64_t, 计算输入)：updates上用来量化的轴，数据类型为INT64，取值支持-1或者len(updates.shape) - 1。 * reduction(int64_t, 计算输入)：指定数据操作方式，数据类型为INT64，取值1。 * workspaceSize(uint64_t *，出参)：返回需要在Device侧申请的workspace大小。 * executor(aclOpExecutor **，出参)：返回op执行器，包含了算子计算流程。 - **返回值：** 返回aclnnStatus状态码，具体参见[aclnn返回码](common/aclnn返回码.md)。 ``` - 161001 (ACLNN_ERR_PARAM_NULLPTR)：如果传入参数是必选输入，输出或者必选属性，且是空指针，则返回161001。 - 161002 (ACLNN_ERR_PARAM_INVALID)： 1. selfRef、indices、updates、quantScales、quantZeroPoints数据类型不在支持范围内。 2. selfRef和updates的维度数不一致。 ``` ## aclnnInplaceQuantScatter - **参数说明**： * workspace(void*，入参)：在Device侧申请的workspace内存地址。 * workspaceSize(uint64_t，入参)：在Device侧申请的workspace大小，由第一段接口aclnnInplaceQuantScatterGetWorkspaceSize获取。 * executor(aclOpExecutor *，入参)：op执行器，包含了算子计算流程。 * stream(aclrtStream，入参)：指定执行任务的AscendCL stream流。 - **返回值**：返回aclnnStatus状态码，具体参见[aclnn返回码](common/aclnn返回码.md)。 ## 约束与限制 - selfRef的维数只能是3~8维。 - indices的维数只能是1维或者2维；如果是2维，其第2维的大小必须是2；不支持索引越界，索引越界不校验；indices映射的selfRef数据段不能重合，若重合则会因为多核并发原因导致多次执行结果不一样。 - updates的维数需要与selfRef的维数一样；其第1维的大小等于indices的第1维的大小，且不大于selfRef的第1维的大小；其axis轴的大小不大于selfRef的axis轴的大小；其余维度的大小要跟selfRef对应维度的大小相等；其最后一维的大小必须32B对齐。 - quantScales的元素个数需要等于updates在quantAxis轴的大小。 - quantZeroPoints的元素个数需要等于updates在quantAxis轴的大小。 - axis不能为updates的第1维或者最后1维。 - quantAxis只能为updates的最后1维。 - reduction当前只支持1('update')。 - selfRef,indices,updates,quantScales,quantZeroPoints数据类型输入组合包括：(INT8, INT32，BFLOAT16, BFLOAT16, BFLOAT16)、(INT8, INT64，BFLOAT16, BFLOAT16, BFLOAT16)、(INT8, INT32，FLOAT16, FLOAT32, INT32)、(INT8, INT64，FLOAT16, FLOAT32, INT32)，其中涉及BFLOAT16的组合（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）。 ## 调用示例仅供参考，具体编译和执行过程请参考[编译与运行样例](common/编译与运行样例.md)。 ```c++ #include #include #include "acl/acl.h" #include "aclnnop/aclnn_quant_scatter.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& 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 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; } 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 selfRefShape = {1, 1, 32}; std::vector indicesShape = {1}; std::vector updatesShape = {1, 1, 32}; std::vector quantScalesShape = {1, 1, 32}; std::vector quantZeroPointsShape = {1, 1, 32}; void* selfRefDeviceAddr = nullptr; void* indicesDeviceAddr = nullptr; void* updatesDeviceAddr = nullptr; void* quantScalesDeviceAddr = nullptr; void* quantZeroPointsDeviceAddr = nullptr; aclTensor* selfRef = nullptr; aclTensor* indices = nullptr; aclTensor* updates = nullptr; aclTensor* quantScales = nullptr; aclTensor* quantZeroPoints = nullptr; std::vector selfRefHostData{32, 0}; std::vector indicesHostData{0}; std::vector updatesHostData{32, 1.0}; std::vector quantScalesHostData{32, 0.5}; std::vector quantZeroPointsHostData{32, 0.5}; int64_t axis = -2; int64_t quantAxis = -1; int64_t reduction = 1; // 创建selfRef aclTensor ret = CreateAclTensor(selfRefHostData, selfRefShape, &selfRefDeviceAddr, aclDataType::ACL_INT8, &selfRef); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建indices aclTensor ret = CreateAclTensor(indicesHostData, indicesShape, &indicesDeviceAddr, aclDataType::ACL_INT32, &indices); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建updates aclTensor ret = CreateAclTensor(updatesHostData, updatesShape, &updatesDeviceAddr, aclDataType::ACL_FLOAT16, &updates); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建quantScales aclTensor ret = CreateAclTensor(quantScalesHostData, quantScalesShape, &quantScalesDeviceAddr, aclDataType::ACL_FLOAT, &quantScales); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建quantZeroPoints aclTensor ret = CreateAclTensor(quantZeroPointsHostData, quantZeroPointsShape, &quantZeroPointsDeviceAddr, aclDataType::ACL_INT32, &quantZeroPoints); CHECK_RET(ret == ACL_SUCCESS, return ret); // 3. 调用CANN算子库API，需要修改为具体的Api名称 uint64_t workspaceSize = 0; aclOpExecutor* executor; // 调用aclnnInplaceQuantScatter第一段接口 ret = aclnnInplaceQuantScatterGetWorkspaceSize(selfRef, indices, updates, quantScales, quantZeroPoints, axis, quantAxis, reduction, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInplaceQuantScatterGetWorkspaceSize 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); } // 调用aclnnInplaceQuantScatter第二段接口 ret = aclnnInplaceQuantScatter(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInplaceQuantScatter 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 size = GetShapeSize(selfRefShape); std::vector resultData(size, 0); ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), selfRefDeviceAddr, size * sizeof(resultData[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 < size; i++) { LOG_PRINT("result[%ld] is: %d\n", i, resultData[i]); } // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改 aclDestroyTensor(selfRef); aclDestroyTensor(indices); aclDestroyTensor(updates); aclDestroyTensor(quantScales); aclDestroyTensor(quantZeroPoints); // 7. 释放device 资源 aclrtFree(selfRefDeviceAddr); aclrtFree(indicesDeviceAddr); aclrtFree(updatesDeviceAddr); aclrtFree(quantScalesDeviceAddr); aclrtFree(quantZeroPointsDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; } ```