CANN 3D最大池化反向传播算子

aclnnMaxPool3dWithArgmaxBackward

【免费下载链接】ops-nn本项目是CANN提供的神经网络类计算算子库，实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-nn

📄 查看源码

产品支持情况

功能说明

正向最大池化aclnnMaxPool3dWithArgmax的反向传播，将梯度回填到每个窗口最大值的坐标处，相同坐标处累加。

函数原型

每个算子分为两段式接口，必须先调用“aclnnMaxPool3dWithArgmaxBackwardGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnMaxPool3dWithArgmaxBackward”接口执行计算。

aclnnStatus aclnnMaxPool3dWithArgmaxBackwardGetWorkspaceSize( const aclTensor *gradOutput, const aclTensor *self, const aclTensor *indices, const aclIntArray *kernelSize, const aclIntArray *stride, const aclIntArray *padding, const aclIntArray *dilation, bool ceilMode, aclTensor *gradInput, uint64_t *workspaceSize, aclOpExecutor **executor)

aclnnStatus aclnnMaxPool3dWithArgmaxBackward( void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnMaxPool3dWithArgmaxBackwardGetWorkspaceSize

• 参数说明：

  参数名	输入/输出	描述	使用说明	数据类型	数据格式	维度(shape)	非连续Tensor
  gradOutput	输入	反向传播过程中上一步输出的梯度。	和正向的输出shape一致，数据格式和self一致。	FLOAT32、FLOAT16、BFLOAT16	ND	4-5	√
  self	输入	正向的输入数据。	-	FLOAT32、FLOAT16、BFLOAT16	ND	4-5	√
  indices	输入	正向输入中最大元素的索引位置。	-	INT32、INT64	ND	4-5	√
  kernelSize	输入	池化操作中使用的滑动窗口大小。	长度为1 (kD = kH = kW) 或3 (kD, kH, kW)。	INT64	-	-	-
  stride	输入	窗口移动的步长。	长度为0（sD = kD, sH = kH, sW = kW）或者1（sD = sH = sW）或3（sD, sH, sW）。	INT64	-	-	-
  padding	输入	在输入的D、H、W方向上padding补0的层数。	长度为1（padD = padH = padW）或3（padD, padH, padW）。	INT64	-	-	-
  dilation	输入	控制窗口中元素的步幅。	长度为1或3，值仅支持1。	INT64	-	-	-
  ceilMode	输入	计算输出形状时取整的方法。	为True时表示计算输出形状时用向上取整的方法，为False时则表示向下取整。	BOOL	-	-	-
  gradInput	输出	反向传播输出的梯度。	shape和数据格式与self保持一致。	BFLOAT16、FLOAT16、FLOAT32	ND	4-5	√
  workspaceSize	输出	返回需要在Device侧申请的workspace大小。	-	-	-	-	-
  executor	输出	返回op执行器，包含了算子计算流程。	-	-	-	-	-

  • Atlas A3 训练系列产品/Atlas A3 推理系列产品 、 Atlas A2 训练系列产品/Atlas A2 推理系列产品 ：indices数据类型不支持INT64。depthheightwidth 不支持大于 max int32。

• 返回值：

  aclnnStatus: 返回状态码，具体参见aclnn返回码。

  第一段接口完成入参校验，出现以下场景时报错：

  返回码	错误码	描述
  ACLNN_ERR_PARAM_NULLPTR	161001	传入的self、indices是空指针。
  ACLNN_ERR_PARAM_INVALID	161002	gradOutput、self、indices、gradInput的数据类型不在支持的范围内。
  		gradOutput、self、indices、gradInput的数据格式不在支持的范围内。
  		gradOutput与indices的shape不一致，self和gradInput的shape不一致。
  		kernelSize的长度不等于1或者3。
  		kernelSize中存在小于等于0的数值。
  		stride的长度不等于0，1或3。
  		stride中存在小于等于0的数值。
  		padding的长度不等于1或3。
  		padding中存在小于0或者大于kernelSize/2的数值。
  		dilation的长度不等于1或者3。
  		平台不支持。

aclnnMaxPool3dWithArgmaxBackward

• 参数说明：

  参数名	输入/输出	描述
  workspace	输入	在Device侧申请的workspace内存地址。
  workspaceSize	输入	在Device侧申请的workspace大小，由第一段接口aclnnMaxPool3dWithArgmaxBackwardGetWorkspaceSize获取。
  executor	输入	op执行器，包含了算子计算流程。
  stream	输入	指定执行任务的Stream。

• 返回值：

  aclnnStatus：返回状态码，具体参见aclnn返回码。

约束说明

• 确定性计算：

  • aclnnMaxPool3dWithArgmaxBackward默认非确定性实现，支持通过aclrtCtxSetSysParamOpt开启确定性。

• 未支持类型说明：

  • DOUBLE：指令不支持DOUBLE。
  • 是否支持空tensor：不支持空进空出。

• 边界值场景说明：

  • 当输入是Inf时，输出为Inf。
  • 当输入是NaN时，输出为NaN。

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。

#include <cstdio> #include <iostream> #include <vector> #include "acl/acl.h" #include "aclnnop/aclnn_max_pool3d_with_argmax_backward.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) { // 固定写法，资源初始化 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初始化，参考acl API手册 // 根据自己的实际device填写deviceId int32_t deviceId = 0; aclrtStream stream; auto ret = Init(deviceId, &stream); // check根据自己的需要处理 CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret); // 2. 构造输入与输出，需要根据API的接口自定义构造 std::vector<int64_t> gradOutShape = {1, 1, 1, 1, 1}; std::vector<int64_t> selfShape = {1, 1, 2, 2, 2}; std::vector<int64_t> indicesShape = {1, 1, 1, 1, 1}; std::vector<int64_t> gradInShape = {1, 1, 2, 2, 2}; std::vector<int64_t> kernelSizeData = {2, 2, 2}; std::vector<int64_t> strideData = {2, 2, 2}; std::vector<int64_t> paddingData = {0, 0, 0}; std::vector<int64_t> dilationData = {1, 1, 1}; void* gradOutDeviceAddr = nullptr; void* selfDeviceAddr = nullptr; void* indicesDeviceAddr = nullptr; void* gradInDeviceAddr = nullptr; aclTensor* gradOut = nullptr; aclTensor* self = nullptr; aclTensor* indices = nullptr; aclTensor* gradIn = nullptr; std::vector<float> gradOutHostData = {0.4757}; std::vector<float> selfHostData = {0.0850, -0.5147, -0.0212, -0.5654, -0.3222, 0.5847, 1.7510, 0.9954}; std::vector<int32_t> indicesHostData = {6}; std::vector<float> gradInHostData = {0, 0, 0, 0, 0, 0, 0, 0}; // 创建gradOut aclTensor ret = CreateAclTensor(gradOutHostData, gradOutShape, &gradOutDeviceAddr, aclDataType::ACL_FLOAT, &gradOut); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建self aclTensor ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self); 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); // 创建gradIn aclTensor ret = CreateAclTensor(gradInHostData, gradInShape, &gradInDeviceAddr, aclDataType::ACL_FLOAT, &gradIn); CHECK_RET(ret == ACL_SUCCESS, return ret); // 创建输入数组 aclIntArray* kernelSize = aclCreateIntArray(kernelSizeData.data(), 3); aclIntArray* stride = aclCreateIntArray(strideData.data(), 3); aclIntArray* padding = aclCreateIntArray(paddingData.data(), 3); aclIntArray* dilation = aclCreateIntArray(dilationData.data(), 3); const bool ceilMode = false; uint64_t workspaceSize = 0; aclOpExecutor* executor; // aclnnMaxPool3dWithArgmaxBackward接口调用示例 // 3. 调用CANN算子库API，需要修改为具体的API名称 // 调用aclnnMaxPool3dWithArgmaxBackwardGetWorkspaceSize第一段接口 ret = aclnnMaxPool3dWithArgmaxBackwardGetWorkspaceSize(gradOut, self, indices, kernelSize, stride, padding, dilation, ceilMode, gradIn, &workspaceSize, &executor); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnMaxPool3dWithArgmaxBackwardGetWorkspaceSize 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); } // 调用aclnnMaxPool3dWithArgmaxBackward第二段接口 ret = aclnnMaxPool3dWithArgmaxBackward(workspaceAddr, workspaceSize, executor, stream); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnMaxPool3dWithArgmaxBackward 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(gradInShape); std::vector<float> resultData(size, 0); ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), gradInDeviceAddr, size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST); CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy gradIn 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(gradOut); aclDestroyTensor(self); aclDestroyTensor(indices); aclDestroyTensor(gradIn); // 7. 释放device资源，需要根据具体API的接口定义修改 aclrtFree(gradOutDeviceAddr); aclrtFree(selfDeviceAddr); aclrtFree(indicesDeviceAddr); aclrtFree(gradInDeviceAddr); if (workspaceSize > 0) { aclrtFree(workspaceAddr); } aclrtDestroyStream(stream); aclrtResetDevice(deviceId); aclFinalize(); return 0; }

【免费下载链接】ops-nn本项目是CANN提供的神经网络类计算算子库，实现网络在NPU上加速计算。项目地址: https://gitcode.com/cann/ops-nn