aclnnRepeatInterleaveWithDim
支持的产品型号
- Atlas 推理系列产品。
- Atlas 训练系列产品。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
接口原型
每个算子分为两段式接口,必须先调用“aclnnRepeatInterleaveWithDimGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器,再调用“aclnnRepeatInterleaveWithDim”接口执行计算。
aclnnStatus aclnnRepeatInterleaveWithDimGetWorkspaceSize(const aclTensor* self, const aclTensor* repeats, int64_t dim, int64_t outputSize, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
aclnnStatus aclnnRepeatInterleaveWithDim(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
功能描述
算子功能:将tensor中的每个元素根据dim这个维度,重复Tensor repeats中对应位置的相应次数。
示例:假设input tensor是 [[a, b], [c, d], [e, f]]。repeats为([1, 2, 3]), dim为0。 那么最后生成的tensor为 ([[a, b], [c, d], [c, d], [e, f], [e, f], [e, f]])。 在dim 0维度,对应的a、b会重复1次,对应的c、d会重复2次,对应的e、f会重复3次。
假设input tensor是 ([[a, b], [c, d], [e, f]])。repeats为([2]), dim为0。 那么最后生成的tensor为 [ [a, b], [a, b], [c, d], [c, d], [e, f], [e, f]]。 在dim 0维度,对应的a、b会重复2次,对应的c、d会重复2次,对应的e、f会重复2次。 注意:该场景等效于 repeats为(2)。
aclnnRepeatInterleaveWithDimGetWorkspaceSize
参数说明:
self(aclTensor*, 计算输入):Device侧的aclTensor,功能描述中待被数据复制的输入tensor。支持空tensor, 支持非连续的Tensor。数据格式支持ND,shape支持0-8维。
- Atlas 推理系列产品、Atlas 训练系列产品:数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT类型。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、BFLOAT16、FLOAT类型。
repeats(aclTensor*, 计算输入):重复的次数。Device侧的aclTensor,数据类型支持INT32、INT64。repeats只能为0D / 1D tensor。如果为1D tensor,那么repeats的size必须为1或self的dim维度的size。支持空tensor,支持非连续的Tensor。数据格式支持ND。
dim(int64_t, 计算输入):进行重复的维度,Host侧的int64_t类型。范围为[-self.dim(), self.dim() - 1]。
outputSize(int64_t, 计算输入):dim维度在进行重复后的最终大小。Host侧的int64_t类型。如果repeats中有多个值,则outputSize值必须为repeats的求和。如果repeats只有一个元素时,则outputSize值必须为repeats * self的dim维度size。
out(aclTensor*, 计算输出):Device侧的aclTensor,功能描述中数据复制完成的输出tensor。数据类型需要与self一致,数据格式支持ND。如果repeats中有多个值,out的shape在dim维度下的size等于repeats中所有元素的和,如果repeats只有一个元素时,out的shape在dim维度下的size等于repeats * self的dim维度下的size。
- Atlas 推理系列产品、Atlas 训练系列产品:数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT类型。
- Atlas A2训练系列产品/Atlas 800I A2推理产品:数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、BFLOAT16、FLOAT类型。
workspaceSize(uint64_t*, 出参):返回需要在Device侧申请的workspace大小。
executor(aclOpExecutor**, 出参):返回op执行器,包含了算子计算流程。
返回值:
aclnnStatus:返回状态码,具体参见aclnn返回码。
第一段接口完成入参校验,出现以下场景时报错: 返回161001 (ACLNN_ERR_PARAM_NULLPTR): 1. 传入的self、repeats或out是空指针 返回161002 (ACLNN_ERR_PARAM_INVALID): 1. self、repeats的数据类型不在支持范围内 2. self、out的数据类型不一样 3. repeats不为0D / 1D tensor。 4. dim的值不在[-self的维度数量, self的维度数量-1]之间 5. 当repeats为1D tensors,repeats的size不为1,不为self的dim维度的size。 6. self的维度数超过8。 7. 当self为0维时,不支持传入dim。
aclnnRepeatInterleaveWithDim
参数说明:
workspace(void*, 入参):在Device侧申请的workspace内存地址。
workspaceSize(uint64_t, 入参):在Device侧申请的workspace大小,由第一段接口aclnnRepeatInterleaveWithDimGetWorkspaceSize获取。
executor(aclOpExecutor*, 入参):op执行器,包含了算子计算流程。
stream(aclrtStream, 入参):指定执行任务的AscendCL Stream流。
返回值:
aclnnStatus:返回状态码,具体参见aclnn返回码。
约束与限制
在计算时需要满足以下要求:
repeats只能为0D / 1D tensor。 如果为1D tensor,那么repeats的size必须为1或self的dim维度的size。 repeats tensor中的值必须为自然数。
outputSize的值必须符合以下计算结果: 当repeats中只有一个元素时,outputSize = self的dim维度的size * repeats的值。 当repeats中有多个值时,outputSize = repeats的值之和。
调用示例
示例代码如下,仅供参考,具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_repeat_interleave.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_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<int64_t> selfShape = {2, 3};
std::vector<int64_t> repeatsShape = {2};
std::vector<int64_t> outShape = {3, 3};
void* selfDeviceAddr = nullptr;
void* repeatsDeviceAddr = nullptr;
void* outDeviceAddr = nullptr;
aclTensor* self = nullptr;
aclTensor* repeats = nullptr;
aclTensor* out = nullptr;
int64_t dim = 0;
int64_t output_size = 3;
std::vector<int64_t> selfHostData = {3, 4, 5, -3, -4, -5};
std::vector<int64_t> repeatsHostData = {1, 2};
std::vector<int64_t> outHostData = {0, 0, 0, 0, 0, 0, 0, 0, 0};
// 创建self aclTensor
ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_INT64, &self);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建repeats aclTensor
ret = CreateAclTensor(repeatsHostData, repeatsShape, &repeatsDeviceAddr, aclDataType::ACL_INT64, &repeats);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 创建out aclTensor
ret = CreateAclTensor(outHostData, outShape, &outDeviceAddr, aclDataType::ACL_INT64, &out);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. 调用CANN算子库API,需要修改为具体的Api名称
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnRepeatInterleaveWithDim第一段接口
ret = aclnnRepeatInterleaveWithDimGetWorkspaceSize(self, repeats, dim, output_size, out, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRepeatInterleaveWithDimGetWorkspaceSize 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);
}
// 调用aclnnRepeatInterleaveWithDim第二段接口
ret = aclnnRepeatInterleaveWithDim(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnRepeatInterleaveWithDim 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<int64_t> 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: %ld\n", i, resultData[i]);
}
// 6. 释放aclTensor和aclScalar,需要根据具体API的接口定义修改
aclDestroyTensor(self);
aclDestroyTensor(repeats);
aclDestroyTensor(out);
// 7. 释放device资源,需要根据具体API的接口定义修改
aclrtFree(selfDeviceAddr);
aclrtFree(repeatsDeviceAddr);
aclrtFree(outDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}