--- title: aclnnRenorm description: "每个算子有两段接口，必须先调用“aclnnXxxGetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnXxx”接口执行计算。两段式接口如下：" url: https://www.hiascend.com/document/detail/zh/Atlas200IDKA2DeveloperKit/latest/Application%20Development%20Guide/aadgc/aclcppdevg_03_0504.html sourcePath: /source/zh/Atlas200IDKA2DeveloperKit/23.0.RC2/Application Development Guide/aadgc/aclcppdevg_03_0504.html indexId: 62b038147ea8f3c7cf20cf67f9f5bc5f8f5751ae506def5da99182a93fc7b107105 --- # aclnnRenorm #### 接口原型 每个算子有两段接口，必须先调用“aclnnXxxGetWorkspaceSize”接口获取入参并根据计算流程计算所需workspace大小，再调用“aclnnXxx”接口执行计算。两段式接口如下： - 第一段接口：aclnnStatus aclnnRenormGetWorkspaceSize(const aclTensor *self, const aclScalar *p, int64_t dim, const aclScalar maxNorm, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor) - 第二段接口：aclnnStatus aclnnRenorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream) #### 功能描述 - 算子功能：返回一个张量，其中输入张量self沿维度dim的每个子张量都经过归一化，使得子张量的p范数低于maxNorm值。 - 计算公式： 其中i维dim确定的某维度张量切片为 - 示例： ``` self = tensor([[1., 1., 1.], [2., 2., 2.], [3., 3., 3.]]) # 这里p=1，dim=0，maxnorm=5 torch.renorm(self, 1, 0, 5) # 因为dim=0，所以以行（第0维）维单位进行判断计算； # 第一行子张量的范数是1+1+1=3，小于5，因此该子张量不变; # 第二行子张量的范数是2+2+2=6，大于5，因此该子张量进行计算，(2/6)*5=1.6667; # 第三行子张量的范数是3+3+3=9，大于5，因此该子张量进行计算，(3/9)*5=1.6667; tensor([[ 1.0000, 1.0000, 1.0000], [ 1.6667, 1.6667, 1.6667], [ 1.6667, 1.6667, 1.6667]]) # 若p=2，则第一行子张量的范数计算时变更为(1+1+1)开平方根（即1.73）， # 同理第二行变为(2*2+2*2+2*2)开平方根（即3.46）、第三行变为(3*3+3*3+3*3)开平方根（即5.19） ``` #### aclnnRenormGetWorkspaceSize - 接口定义： aclnnStatus aclnnRenormGetWorkspaceSize(const aclTensor *self, const aclScalar *p, int64_t dim, const aclScalar maxNorm, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor) - 参数说明： - self：Device侧的aclTensor，输入张量，数据类型支持FLOAT、FLOAT16，支持非连续的Tensor，支持空Tensor传入，数据格式支持ND，shape维度不超过8。 - p：Host侧的aclScalar，表示范数，取值仅支持0.0f、1.0f、2.0f、3.0f，数据类型支持FLOAT。 - dim：Host侧的整型，指定求norm的维度方向，取值范围为[-self.dim(), self.dim())，数据类型支持INT64。 - maxNorm：Host侧的aclScalar，表示最大允许的归一化值，取值要求≥0，数据类型支持FLOAT。如果对应维度的p范数（由p值确定）大于maxNorm，则将该维度的值关于p范数归一化并乘上maxNorm；如果对应维度的p范数（由p值确定）小于等于maxNorm，则该维度张量保持不变输出。 - out：Device侧的aclTensor，输出张量。数据类型支持FLOAT、FLOAT16，且数据类型需要与self保持一致，shape需要与self一致。支持非连续的Tensor，支持空Tensor传入，数据格式支持ND。 - workspaceSize：返回用户需要在Device侧申请的workspace大小。 - executor：返回op执行器，包含了算子计算流程。 - 返回值： 返回aclnnStatus状态码，具体参见aclnn返回码。 第一段接口完成入参校验，出现以下场景时报错： 返回161001（ACLNN_ERR_PARAM_NULLPTR）：传入的self、p、maxNorm或out是空指针。 返回161002（ACLNN_ERR_PARAM_INVALID）： self和out的数据类型或数据格式不在支持的范围之内。 self和out的shape不一致。 self和out的dtype不一致。 p值不等于0.0f、1.0f、2.0f、3.0f。 dim的值不在支持的范围内。 maxNorm取值小于0。 self的维度超过8。 #### aclnnRenorm - 接口定义： aclnnStatus aclnnRenorm(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream) - 参数说明： - workspace：在Device侧申请的workspace内存起址。 - workspaceSize：在Device侧申请的workspace大小，由第一段接口aclnnRenormGetWorkspaceSize获取。 - executor：op执行器，包含了算子计算流程。 - stream：指定执行任务的AscendCL stream流。 - 返回值： 返回aclnnStatus状态码，具体参见aclnn返回码。 #### 调用示例 ``` #include #include #include "acl/acl.h" #include "aclnnop/aclnn_renorm.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 = {3, 3}; std::vector outShape = {3, 3}; void* selfDeviceAddr = nullptr; void* outDeviceAddr = nullptr; aclTensor* self = nullptr; aclScalar* p = nullptr; aclScalar* maxNorm = nullptr; aclTensor* out = nullptr; std::vector selfHostData = {1, 1, 1, 2, 2, 2, 3, 3, 3}; std::vector outHostData = (9, 0); int64_t dim = -1; float pValue = 1.0f; float maxNormValue = 5.0f; // 创建self aclTensor ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建p aclScalar p = aclCreateScalar(&pValue,aclDataType::ACL_FLOAT); CHECK_RET(p != nullptr, return ret); // 创建maxNorm aclScalar maxNorm = aclCreateScalar(&maxNormValue,aclDataType::ACL_FLOAT); CHECK_RET(maxNorm != nullptr, return ret); // 创建out aclTensor ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out); CHECK_RET(ret == ACL_SUCCESS, return ret); // 3. 调用CANN算子库API，需要修改为具体的API名称 uint64_t workspaceSize = 0; aclOpExecutor* executor; // 调用aclnnRenorm第一段接口 ret = aclnnRenormGetWorkspaceSize(self, p, dim, maxNorm, out, &workspaceSize, &executor) ; CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRenormGetWorkspaceSize 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); } // 调用aclnnRenorm第二段接口 ret = aclnnRenorm(workspaceAddr, workspaceSize, executor, stream) ; CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRenorm 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(outShape); std::vector resultData(size, 0); ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), outDeviceAddr, 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: %f\n", i, resultData[i]); } // 6. 释放aclTensor和aclScalar，需要根据具体API的接口定义修改 aclDestroyTensor(self); aclDestroyScalar(p); aclDestroyScalar(maxNorm); aclDestroyTensor(out); return 0; } ```