aclnnGatherNd

支持的产品型号

• Atlas 训练系列产品。
• Atlas A2训练系列产品/Atlas 800I A2推理产品。
• Atlas 推理系列产品。

接口原型

每个算子分为undefined，必须先调用“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中一个切片)，具体计算逻辑为：

1. 如果indices_shape[-1] > r，不合法场景。
2. 如果indices_shape[-1] = r，则输出张量out的维度为q-1，即out的shape为 [indices_shape[0:q-1]]，out中元素为self的索引对位置的元素。（见例1）
3. 如果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] 的一些限制条件如下：

1. 必须满足r≥1，q≥1。
2. indices_shape[-1]的值必须满足在1(包含)和r(包含)之间。
3. indices的每个元素，必须在[-s, s-1]范围内(s为self_shape各个轴上的值)，即-self_shape[i]≤indices[...,i]≤self_shape[i]-1。

示例

aclnnGatherNdGetWorkspaceSize

• 参数说明：

  • self(aclTensor*, 计算输入) ：Device侧的aclTensor，支持undefined，undefined支持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，支持undefined，undefined支持ND。

  • negativeIndexSupport(bool, 计算输入)：数据类型支持bool，当值为True时，表示onnx模型存在负索引；当值为False时，表示索引在合理范围内，且不存在负索引。

  • out(aclTensor*, 计算输出)：Device侧的aclTensor，支持undefined，undefined支持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：返回状态码，具体参见undefined。

aclnnGatherNd

• 参数说明：

  • workspace(void*, 入参)：在Device侧申请的workspace内存地址。

  • workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnGatherNdGetWorkspaceSize获取。

  • executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。

  • stream(aclrtStream, 入参)：指定执行任务的AscendCL Stream流。

• 返回值：

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

约束与限制

无。

调用示例

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