aclnnAdaptiveMaxPool2d
支持的产品型号
- Atlas 训练系列产品。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
接口原型
- 每个算子分为两段式接口,必须先调用“aclnnAdaptiveMaxPool2dGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnAdaptiveMaxPool2d”接口执行计算。
aclnnStatus aclnnAdaptiveMaxPool2dGetWorkspaceSize(const aclTensor* self, const aclIntArray* outputSize, aclTensor* outputOut, aclTensor* indicesOut, uint64_t* workspaceSize, aclOpExecutor** executor)
aclnnStatus aclnnAdaptiveMaxPool2d(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
功能描述
算子功能: 对输入self的feature_map进行最大值池化操作。与max_pool2d的区别在于,不需要feature_map的长、宽被kernel_size整除,只需指定outputSize大小,并按outputSize的大小来划分pooling区域。
Shape描述:
- self: (N, C, Hin, Win) 或者 (C, Hin, Win) 或 (N, Hin, Win, C)
- outputSize: (Hout, Wout)
- outputOut: (N, C, Hout, Wout) 或者 (C, Hout, Wout) 或 (N, Hout, Wout,C)
- indicesOut: (N, C, Hout, Wout) 或者 (C, Hout, Wout) 或 (N, Hout, Wout,C)
aclnnAdaptiveMaxPool2dGetWorkspaceSize
参数说明:
- self(aclTensor*, 计算输入):: Device侧的aclTensor, 数据类型支持FLOAT16、FLOAT和DOUBLE,且数据类型与outputOut的数据类型一致。支持非连续的Tensor, 数据格式支持NCHW、NCL、NHWC。NCL输入时按照(C, Hin, Win)处理。
- outputSize(aclIntArray*, 计算输入):host侧的aclIntArray, 数据类型为int数组, size大小为2。表示输出结果在H和W维度上的空间大小。
- outputOut(aclTensor *, 计算输出):Device侧的aclTensor, 数据类型支持FLOAT16、FLOAT和DOUBLE, 且数据类型与self的数据类型一致,shape与indicesOut一致。支持非连续的Tensor, 数据格式支持NCHW、NCL、NHWC。NCL输入时按照(C, Hout, Wout)处理。
- indicesOut(aclTensor *,计算输出):Device侧的aclTensor, 表示outputOut元素在输入self中的索引位置。数据类型支持INT64, 且shape与outputOut一致。支持非连续的Tensor, 数据格式支持NCHW、NCL、NHWC。NCL输入时按照(C, Hout, Wout)处理。
- workspaceSize(uint64_t*, 出参): 返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**, 出参): 返回op执行器,包含了算子计算流程。
返回值:
aclnnStatus:返回状态码,具体参见aclnn返回码。
第一段接口完成入参校验,出现以下场景时报错: 161001 (ACLNN_ERR_PARAM_NULLPTR): 1. 传入的self、outputSize、outputOut或indicesOut是空指针。 161002 (ACLNN_ERR_PARAM_INVALID): 1. self的数据类型不在支持的范围之内。 2. self和outputOut的数据类型不一致。 3. indicesOut的数据类型不为int64。 4. self的shape不是3维或者4维。 5. self在非第一维度上的size小于1。 6. outputOut和indicesOut的shape不一致。 7. outputSize的size大小不等于2。 8. outputSize中元素值小于等于0。 9. outputOut的shape与实际输出shape不匹配。 10. self的format不是NCHW/NHWC这两种format。
aclnnAdaptiveMaxPool2d
参数说明:
- workspace(void *, 入参): 在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t, 入参): 在Device侧申请的workspace大小,由第一段接口aclnnAdaptiveMaxPool2dGetWorkspaceSize获取。
- executor(aclOpExecutor *, 入参): op执行器,包含了算子计算流程。
- stream(aclrtStream, 入参): 指定执行任务的AscendCL Stream流。
返回值: aclnnStatus: 返回状态码,具体参见aclnn返回码。
约束与限制
无
调用示例
示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_adaptive_max_pool2d.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_NCHW,
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> selfShape = {1, 1, 4, 4};
std::vector<int64_t> outShape = {1, 1, 2, 2};
void* selfDeviceAddr = nullptr;
void* outDeviceAddr = nullptr;
void* indDeviceAddr = nullptr;
aclTensor* self = nullptr;
aclTensor* out = nullptr;
aclTensor* indices = nullptr;
std::vector<float> selfHostData = {0, 1, 2, 3, 4, 5, 6, 7,
8, 9, 10, 11, 12, 13, 14, 15};
std::vector<float> outHostData = {0, 0, 0, 0.0};
std::vector<int64_t> indicesHostData = {0, 0, 0, 0};
// 创建self aclTensor
ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_FLOAT, &self);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建out aclTensor
ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_FLOAT, &out);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建indices aclTensor
ret = CreateAclTensor(indicesHostData, outShape, &indDeviceAddr, aclDataType::ACL_INT64, &indices);
CHECK_RET(ret == ACL_SUCCESS, return ret);
std::vector<int64_t> arraySize = {2, 2};
const aclIntArray *outputSize = aclCreateIntArray(arraySize.data(), arraySize.size());
CHECK_RET(outputSize != nullptr, return ACL_ERROR_INTERNAL_ERROR);
// 3. 调用CANN算子库API,需要修改为具体的Api名称
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnAdaptiveMaxPool2d第一段接口
ret = aclnnAdaptiveMaxPool2dGetWorkspaceSize(self, outputSize, out, indices, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnAdaptiveMaxPool2dGetWorkspaceSize 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);
}
// 调用aclnnAdaptiveMaxPool2d第二段接口
ret = aclnnAdaptiveMaxPool2d(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnAdaptiveMaxPool2d 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<float> outData(size, 0);
std::vector<int64_t> indicesData(size, 0);
ret = aclrtMemcpy(outData.data(), outData.size() * sizeof(outData[0]), outDeviceAddr,
size * 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);
ret = aclrtMemcpy(indicesData.data(), indicesData.size() * sizeof(indicesData[0]), indDeviceAddr,
size * sizeof(indicesData[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("out[%ld] is: %f\n", i, outData[i]);
}
for (int64_t i = 0; i < size; i++) {
LOG_PRINT("indices[%ld] is: %ld\n", i, indicesData[i]);
}
// 6. 释放aclTensor和aclScalar,需要根据具体API的接口定义修改
aclDestroyTensor(self);
aclDestroyTensor(out);
aclDestroyTensor(indices);
aclDestroyIntArray(outputSize);
// 7. 释放device 资源
aclrtFree(selfDeviceAddr);
aclrtFree(outDeviceAddr);
aclrtFree(indDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}