--- title: aclnnQr description: "每个算子有两段接口，必须先调用“aclnnXxxGetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnXxx”接口执行计算。两段式接口如下：" url: https://www.hiascend.com/document/detail/zh/Atlas200IDKA2DeveloperKit/latest/Application%20Development%20Guide/aadgc/aclcppdevg_03_0489.html sourcePath: /source/zh/Atlas200IDKA2DeveloperKit/23.0.RC2/Application Development Guide/aadgc/aclcppdevg_03_0489.html indexId: 448685b8e7535ecd998047f29bb1c7e393cb9f851850769e0805c36ba2449d5f105 --- # aclnnQr #### 接口原型 每个算子有两段接口，必须先调用“aclnnXxxGetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnXxx”接口执行计算。两段式接口如下： - 第一段接口：aclnnStatus aclnnQrGetWorkspaceSize(const aclTensor *self, bool some, aclTensor *Q, aclTensor *R, uint64_t *workspaceSize, aclOpExecutor **executor) - 第二段接口：aclnnStatus aclnnQr(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor，aclrtStream stream) #### 功能描述 - 算子功能：对输入张量进行正交分解。 - 计算公式： 其中A为输入Tensor，维度至少为2，A表示为正交矩阵Q与上三角矩阵R的乘积的形式。 - 示例： ``` A = tensor([[1,2],[3,4]],dtype=torch.float) q, r = qr(A,some=False) q = tensor([[-0.3162, -0.9487], [-0.9487, 0.3162]]) r = tensor([[-3.1623, -4.4272], [ 0.0000, -0.6325]]) ``` #### aclnnQrGetWorkspaceSize - 接口定义： aclnnStatus aclnnQrGetWorkspaceSize(const aclTensor *self, bool some, aclTensor *Q, aclTensor *R, uint64_t *workspaceSize, aclOpExecutor **executor) - 参数说明： - self：Device侧的aclTensor，计算公式中的A，数据类型支持FLOAT、FLOAT16、DOUBLE、COMPLEX64、COMPLEX128，支持非连续的Tensor，数据格式支持ND。shape维度至少为2且不大于8，且shape需要与Q、R满足约束条件。 - some：Host侧的BOOL型，计算属性。当some为False，输入A(* , m, n)，输出完整大小的Q(* , m, m)、R(* , m, n)；当some为True，输入A(* , m, n)，输出简化大小的Q(* , m, k)、R(*, k, n)，其中k为m、n的最小值。 - Q：Device侧的aclTensor，正交矩阵，数据类型支持FLOAT、FLOAT16、DOUBLE、COMPLEX64、COMPLEX128。支持非连续的Tensor，数据格式支持ND，且数据格式与self、R一致，shape为Q(* , m, m)或Q(* , m, k)，其中k为m、n的最小值。 - R：Device侧的aclTensor，上三角矩阵，数据类型支持FLOAT、FLOAT16、DOUBLE、COMPLEX64、COMPLEX128。支持非连续的Tensor，数据格式支持ND，且数据格式与self、Q一致，shape为R(* , m, n)或R(* , k, n)，其中k为m、n的最小值。 - workspaceSize：返回用户需要在Device侧申请的workspace大小。 - executor：返回op执行器，包含了算子计算流程。 - 返回值： 返回aclnnStatus状态码，具体参见aclnn返回码。 第一段接口完成入参校验，出现以下场景时报错： 返回161001（ACLNN_ERR_PARAM_NULLPTR）：传入的self、Q、R是空指针。 返回161002（ACLNN_ERR_PARAM_INVALID）： self、Q、R的数据类型不在支持的范围之内。 self、Q、R的shape不符合约束。 #### aclnnQr - 接口定义： aclnnStatus aclnnQr(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor，aclrtStream stream) - 参数说明： - workspace：在Device侧申请的workspace内存起址。 - workspaceSize：在Device侧申请的workspace大小，由第一段接口aclnnQrGetWorkspaceSize获取。 - executor：op执行器，包含了算子计算流程。 - stream：指定执行任务的AscendCL stream流。 - 返回值： 返回aclnnStatus状态码，具体参见aclnn返回码。 #### 调用示例 ``` #include #include #include "acl/acl.h" #include "aclnnop/aclnn_qr.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, aclrtContext* context, 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 = aclrtCreateContext(context, deviceId); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateContext failed. ERROR: %d\n", ret); return ret); ret = aclrtSetCurrentContext(*context); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetCurrentContext 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/context/stream初始化，参考AscendCL对外接口列表 // 根据自己的实际device填写deviceId int32_t deviceId = 0; aclrtContext context; aclrtStream stream; auto ret = Init(deviceId, &context, &stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret); // 2. 构造输入与输出，需要根据API的接口自定义构造 std::vector selfShape = {2, 2}; bool some = false; std::vector qShape = {2, 2}; std::vector rShape = {2, 2}; void* selfDeviceAddr = nullptr; void* qDeviceAddr = nullptr; void* rDeviceAddr = nullptr; aclTensor* self = nullptr; aclTensor* q = nullptr; aclTensor* r = nullptr; std::vector selfHostData = {1, 2, 3, 4}; std::vector qHostData = {0, 0, 0, 0}; std::vector rHostData = {0, 0, 0, 0}; // 创建self aclTensor ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建q,r aclTensor ret = CreateAclTensor(qHostData, qShape, &qDeviceAddr, aclDataType::ACL_FLOAT, &q); CHECK_RET(ret == ACL_SUCCESS, return ret); ret = CreateAclTensor(rHostData, rShape, &rDeviceAddr, aclDataType::ACL_FLOAT, &r); CHECK_RET(ret == ACL_SUCCESS, return ret); // 3. 调用CANN算子库API，需要修改为具体的API名称 uint64_t workspaceSize = 0; aclOpExecutor* executor; // 调用aclnnQr第一段接口 ret = aclnnQrGetWorkspaceSize(self, some, q, r, &workspaceSize, &executor) ; CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQrGetWorkspaceSize 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); } // 调用aclnnQr第二段接口 ret = aclnnQr(workspaceAddr, workspaceSize, executor, stream) ; CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnQr 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(qShape); std::vector resultQData(size, 0); ret = aclrtMemcpy(resultQData.data(), resultQData.size() * sizeof(resultQData[0]), qDeviceAddr, size * sizeof(resultQData[0]), ACL_MEMCPY_DEVICE_TO_HOST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result Q from device to host failed. ERROR: %d\n", ret); return ret); for (int64_t i = 0; i < size; i++) { LOG_PRINT("result Q[%ld] is: %f\n", i, resultQData[i]); } std::vector resultRData(size, 0); ret = aclrtMemcpy(resultRData.data(), resultRData.size() * sizeof(resultRData[0]), rDeviceAddr, size * sizeof(resultRData[0]), ACL_MEMCPY_DEVICE_TO_HOST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result R from device to host failed. ERROR: %d\n", ret); return ret); for (int64_t i = 0; i < size; i++) { LOG_PRINT("result R[%ld] is: %f\n", i, resultRData[i]); } // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改 aclDestroyTensor(self); aclDestroyTensor(q); aclDestroyTensor(r); // 7. 释放device资源，需要根据具体API的接口定义参数 aclrtFree(selfDeviceAddr); aclrtFree(qDeviceAddr); aclrtFree(rDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtDestroyContext(context); aclrtResetDevice(deviceId); aclFinalize(); return 0; } ```