aclnnScatterAdd

支持的产品型号

• Atlas 训练系列产品。
• Atlas A2训练系列产品。

接口原型

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

• aclnnStatus aclnnScatterAddGetWorkspaceSize(const aclTensor *self, int64_t dim, const aclTensor *index, const aclTensor *src, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnScatterAdd(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

功能描述

算子功能：将源tensor中的值按指定的轴方向和index tensor中的位置关系逐个填入输出tensor中，若有多于一个src值被填入到self的同一位置，那么这些值将会在这一位置上进行累加。在计算时需要满足以下要求：

• self, index和src的维度数量必须相同
• 对于每一个维度d, 有index.size(d) <= src.size(d)
• 对于每一个维度d, 如果有d != dim, 有index.size(d) <= self.size(d)
• dim取值范围为[-self.dim(),self.dim()]

用例：

输入tensor $self = \begin{bmatrix} 1&2&3 \\4&5&6 \\7&8&9\end{bmatrix}$, 索引tensor $index = \begin{bmatrix} 0&1&2&0\\0&0&1&2 \end{bmatrix}$, dim = 1, 源tensor $src = \begin{bmatrix} 1&2&3&4&5 \\ 6&7&8&9&10 \end{bmatrix}$， 输出tensor $output = \begin{bmatrix}6&4&6\\17&13&15\\7&8&9\end{bmatrix}$

dim = 1表示scatter_add根据$index$在tensor的列上进行累加

$output[0][0] = self[0][0] + src[0][0] + src[0][3]$,

$output[0][1] = self[0][1] + src[0][1]$,

$output[0][2] = self[0][2] + src[0][2]$,

$output[1][0] = self[1][0] + src[1][0] + src[1][1]$,

$output[1][1] = self[1][1] + src[0][2]$,

$output[1][2] = self[1][2] + src[0][3]$,

$output[2][0] = self[2][0]$,

$output[2][1] = self[2][1]$,

$output[2][2] = self[2][2]$.

其中，$self$,$index$,$src$的维度数量均为2，$index$每个维度大小{2，4}都不大于$src$的对应维度大小{2，5}，在dim != 1的维度上（dim = 0），$index$的维度大小{2}不大于$self$的对应维度大小{3}，$index$中的最大值{2}，不大于$self$在dim = 1维度的大小{3}。

aclnnScatterAddGetWorkspaceSize

• 参数说明：

  • self(const aclTensor *，计算输入)：公式中的self，数据类型支持FLOAT16, BFLOAT16（仅Atlas A2训练系列产品支持）, FLOAT32, DOUBLE, INT64, INT32, INT16, INT8, UINT8, BOOL,COMPLEX64, COMPLEX128类型，维度数量需要与index和src相同。支持非连续的Tensor，支持ND，且数据类型需要与src一致。

  • dim(INT64, 计算输入)：计算公式中的dim，数据类型为INT64。

  • index：公式中的index，数据类型支持INT32, INT64类型，index维度数量需要与src相同。支持非连续的Tensor，支持ND。

  • src(const aclTensor *，计算输入)：公式中的src，数据类型支持FLOAT16, BFLOAT16（仅Atlas A2训练系列产品支持）, FLOAT32, DOUBLE, INT64, INT32, INT16, INT8, UINT8, BOOL,COMPLEX64, COMPLEX128类型，src维度数量需要与index相同，支持ND，且数据类型需要与self一致。

  • out(aclTensor *，计算输出)： 公式中的output，数据类型支持FLOAT16, BFLOAT16（仅Atlas A2训练系列产品支持）, FLOAT32, DOUBLE, INT64, INT32, INT16, INT8, UINT8, BOOL,COMPLEX64, COMPLEX128类型，shape，和数据类型需要与self一致。

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

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

• 返回值：

  aclnnStatus(aclOpExecutor **，出参)：返回状态码，具体参见。

aclnnScatterAdd

• 参数说明：

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

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

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

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

• 返回值：

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

约束与限制

无。

调用示例

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