aclnnGatherV3

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	√
[object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]	√
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列产品 [object Object]	×
[object Object]Atlas 训练系列产品[object Object]	×

功能说明

• 算子功能：从输入Tensor的指定维度dim，按index中的下标序号提取元素，batchDims代表运算批次。保存到out Tensor中。

• 示例：

  例如，当batchDims为0时，输入张量 $self=\begin{bmatrix}1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9\end{bmatrix}$ 和索引张量 index=[1, 0],。

  • dim=0的结果：$out=\begin{bmatrix}4 & 5 & 6 \\ 1 & 2 & 3\end{bmatrix}$

  • dim=1的结果： $out=\begin{bmatrix}2 & 1\\ 5 & 4\\ 8 & 7\end{bmatrix}$

  具体计算过程如下： 以三维张量为例，shape为(3,2,2)的张量 self =$\begin{bmatrix}[[1,&2],&[3,&4]], \\ [[5,&6],&[7,&8]], \\ [[9,&10],&[11,&12]]\end{bmatrix}$ index=[1, 0], self张量dim=0，1，2对应的下标分别是$l， m， n$，index是一维（零维的情况：当成是size为1的一维）

  • dim为0：I=index[i];    out$[i][m][n]$ = self$[I][m][n]$

  • dim为1：J=index[j];    out$[l][j][n]$ = self$[l][J][n]$

  • dim为2：K=index[k];    out$[l][m][k]$ = self$[l][m][K]$

  当batchDims为1时：以四维张量为例 shape为(3,3,2,2)的张量 self 与shape为(3,2)的张量 index，相当于进行3次batchDims为0，dim=dim-batchDims的gather操作。

函数原型

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

• aclnnStatus aclnnGatherV3GetWorkspaceSize(const aclTensor *self, int64_t dim, const aclTensor *index, int64_t batchDims, int64_t mode, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnGatherV3(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnGatherV3GetWorkspaceSize

• 参数说明：

  • self(aclTensor*，计算输入)：待收集的数据。Device侧的aclTensor，支持undefined，undefined支持ND，数据维度不支持8维以上，数据类型支持FLOAT、FLOAT16、INT64、INT32、INT16、INT8、UINT8、BOOL、DOUBLE、COMPLEX64。

  • dim(int64_t, 计算输入)：待收集轴。Host侧的整数，数据类型支持INT64，取值范围在[-self.dim(), self.dim()-1]内，当前只支持0。

  • index(aclTensor*,计算输入)：收集数据的索引。Device侧的aclTensor，数据类型支持INT64、INT32，支持undefined，undefined支持ND，数据维度不支持8维以上。取值范围在0 ~ self.shape[dim]内（包含0，不包含self.shape[dim]）。

  • batchDims(int64_t, 计算输入)：运算批次。Host侧的整数，数据类型支持INT64，取值范围在[0, dim]内，当前只支持0。

  • mode(int64_t, 计算输入)：计算模式。Host侧的整数，数据类型支持INT64，取值范围在[0, 2]内。0：索引散列场景性能优化，1：索引聚集场景性能优化，2：支持索引越界，当前只支持1。

  • out(aclTensor*，计算输出)：Device侧的aclTensor，数据类型需要与self一致，维数等于self维数与index维数之和减一，除0维扩展为跟index的shape一样外，其他维长度与self相应维一致，undefined支持ND，数据类型支持FLOAT、FLOAT16、INT64、INT32、INT16、INT8、UINT8、BOOL、DOUBLE、COMPLEX64。

  • workspaceSize(uint64_t*，出参)：返回需要在Device侧申请的workspace大小。

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

• 返回值：

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

aclnnGatherV3

• 参数说明：

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

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

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

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

• 返回值：

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

约束说明

无。

调用示例

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