aclnnGatherNd
支持的产品型号
- Atlas 训练系列产品。
- Atlas A2训练系列产品/Atlas 800I A2推理产品。
- Atlas 推理系列产品。
接口原型
每个算子分为两段式接口，必须先调用“aclnnGatherNdGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnGatherNd”接口执行计算。
aclnnStatus aclnnGatherNdGetWorkspaceSize(const aclTensor *self, const aclTensor *indices, bool negativeIndexSupport, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)aclnnStatus aclnnGatherNd(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
功能描述
算子功能：对于维度为r≥1的输入张量self，和维度q≥1的输入张量indices，将数据切片收集到维度为 (q-1) + (r - indices_shape[-1]) 的输出张量out中。indices是一个q维的整型张量，可视作一个q-1维的由索引对构成的特殊张量(每个索引对是一个长度为indices_shape[-1]的一维张量，每个索引对指向self中一个切片)，具体计算逻辑为：
- 如果indices_shape[-1] > r，不合法场景。
- 如果indices_shape[-1] = r，则输出张量out的维度为q-1，即out的shape为 [indices_shape[0:q-1]]，out中元素为self的索引对位置的元素。（见例1）
- 如果indices_shape[-1] < r，则输出张量out的维度为 (q-1) + (r - indices_shape[-1])，设c=indices_shape[-1]，即out的shape为 [indices_shape[0:q-1],self_shape[c:r]]，
out由self的索引对位置的切片组成。（见例2,3,4）
关于r、q、indices_shape[-1] 的一些限制条件如下：
- 必须满足r≥1，q≥1。
- indices_shape[-1]的值必须满足在1(包含)和r(包含)之间。
indices的每个元素，必须在[-s, s-1]范围内(s为self_shape各个轴上的值)，即-self_shape[i]≤indices[...,i]≤self_shape[i]-1。
示例
例1：
self: [[0, 1],[2, 3]] # self_shape=[2, 2], r=2
indices: [[0, 0], [1, 1]] # indices_shape=[2, 2], q=2, indices_shape[-1]=2
out: [0, 3] # out_shape=[2]
例2：
self: [[0, 1],[2, 3]] # self_shape=[2, 2], r=2
indices: [[1], [0]] # indices_shape=[2, 1], q=2, indices_shape[-1]=1
out: [[2, 3], [0, 1]] # out_shape=[2, 2]
例3：
self: [[[0, 1],[2, 3]], [[4, 5],[6, 7]]] # self_shape=[2, 2, 2], r=3
indices: [[0, 1], [1, 0]] # indices_shape=[2, 2], q=2, indices_shape[-1]=2
out: [[2, 3], [4, 5]] # out_shape=[2, 2]
例4：
self: [[[0, 1],[2, 3]], [[4, 5],[6, 7]]] # self_shape=[2, 2, 2], r=3
indices: [[[0, 1]], [[1, 0]]] # indices_shape=[2, 1, 2], q=3, indices_shape[-1]=2
out: [[[2, 3]], [[4, 5]]] # out_shape=[2, 1, 2]aclnnGatherNdGetWorkspaceSize
参数说明：
self(aclTensor*, 计算输入) ：Device侧的aclTensor，支持非连续的Tensor，数据格式支持ND，数据维度支持1～8维。
- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持INT64、INT32、INT8、UINT8、BOOL、FLOAT、FLOAT16、BFLOAT16
- Atlas 训练系列产品、Atlas 推理系列产品：数据类型支持INT64、INT32、INT8、UINT8、BOOL、FLOAT、FLOAT16
indices(aclTensor * ,计算输入)：Device侧的aclTensor，数据类型支持INT32、INT64，支持非连续的Tensor，数据格式支持ND。
negativeIndexSupport(bool, 计算输入)：数据类型支持bool，当值为True时，表示onnx模型存在负索引；当值为False时，表示索引在合理范围内，且不存在负索引。
out(aclTensor*, 计算输出)：Device侧的aclTensor，支持非连续的Tensor，数据格式支持ND，数据类型需要与self一致。
- Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持INT64、INT32、INT8、UINT8、BOOL、FLOAT、FLOAT16、BFLOAT16
- Atlas 训练系列产品、Atlas 推理系列产品：数据类型支持INT64、INT32、INT8、UINT8、BOOL、FLOAT、FLOAT16
workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。
返回值：
aclnnStatus：返回状态码，具体参见aclnn返回码。
第一段接口完成入参校验，出现以下场景时报错：
返回161001(ACLNN_ERR_PARAM_NULLPTR)：1. 参数self、out是空指针。
返回161002(ACLNN_ERR_PARAM_INVALID)：1. 参数self的数据类型不在支持的范围内。
2. self或indices的维数小于1或超过8。
3. self和out的数据类型不一致。aclnnGatherNd
参数说明：
workspace(void*, 入参)：在Device侧申请的workspace内存地址。
workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnGatherNdGetWorkspaceSize获取。
executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。
stream(aclrtStream, 入参)：指定执行任务的 AscendCL Stream流。
返回值：
aclnnStatus：返回状态码，具体参见aclnn返回码。
约束与限制
无。
调用示例
示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_gather_nd.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, 2};
std::vector<int64_t> indicesShape = {2, 2};
std::vector<int64_t> outShape = {2};
void* selfDeviceAddr = nullptr;
void* indicesDeviceAddr = nullptr;
void* outDeviceAddr = nullptr;
aclTensor* self = nullptr;
aclTensor* indices = nullptr;
bool negativeIndexSupport = true;
aclTensor* out = nullptr;
std::vector<float> selfHostData = {0, 1, 2, 3};
std::vector<int64_t> indicesHostData = {0, 0, 1, 1};
std::vector<float> outHostData = {0, 3};
// 创建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_INT64, &indices);
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);
// 3. 调用CANN算子库API，需要修改为具体的Api名称
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// 调用aclnnGatherNd第一段接口
ret = aclnnGatherNdGetWorkspaceSize(self, indices, negativeIndexSupport, out, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGatherNdGetWorkspaceSize 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);
}
// 调用aclnnGatherNd第二段接口
ret = aclnnGatherNd(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnGatherNd 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> 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);
aclDestroyTensor(indices);
aclDestroyTensor(out);
// 7. 释放device资源，需要根据具体API的接口定义修改
aclrtFree(selfDeviceAddr);
aclrtFree(indicesDeviceAddr);
aclrtFree(outDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}