aclnnIndexCopy&aclnnInplaceIndexCopy

支持的产品型号

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

接口原型

• aclnnIndexCopy和aclnnInplaceIndexCopy实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。
  • aclnnIndexCopy：需新建一个输出张量对象存储计算结果。
  • aclnnInplaceIndexCopy：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。
• 每个算子分为undefined，必须先调用“aclnnIndexCopyGetWorkspaceSize”或者“aclnnInplaceIndexCopyGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnIndexCopy”或者“aclnnInplaceIndexCopy”接口执行计算。
  • aclnnStatus aclnnIndexCopyGetWorkspaceSize(aclTensor* selfRef, int64_t dim, const aclTensor* index, const aclTensor* source, aclTensor* outRef, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnIndexCopy(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceIndexCopyGetWorkspaceSize(aclTensor* selfRef, int64_t dim, const aclTensor* index, const aclTensor* source, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnInplaceIndexCopy(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

算子功能:将index张量中元素值作为索引，针对指定轴dim，把source中元素复制到selfRef的对应位置上。

aclnnIndexCopyGetWorkspaceSize

• 参数说明：

  • selfRef（aclTensor*, 计算输入)：Device侧的aclTensor，输入数据类型支持FLOAT、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）、FLOAT16、INT32、INT64、INT16、INT8、UINT8、DOUBLE、BOOL、COMPLEX128、COMPLEX64，支持undefined，undefined支持ND。
  • dim(int64_t,计算输入): host侧的int64类型，在[-selfRef.dim(), selfRef.dim() - 1]范围内。
  • index(aclTensor*, 计算输入)： Device侧的aclTensor，数据类型支持INT32、INT64，维度不能大于1，元素个数要求和张量source中dim轴的大小相同。支持undefined，undefined支持ND，当index有重复索引值的时候，结果不保序。index中的索引数据不支持越界。
  • source(aclTensor*, 计算输入): Device侧的aclTensor，数据类型与维度和selfRef一致，dim轴的大小和index的元素数量相同，其他维度同selfRef的shape，支持undefined，undefined支持ND。
  • out(aclTensor*, 计算输出)：Device侧的aclTensor，数据类型与形状与selfRef相同，数据类型支持FLOAT、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）、FLOAT16、INT32、INT64、INT16、INT8、UINT8、DOUBLE、BOOL、COMPLEX128、COMPLEX64。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnIndexCopy

• 参数说明：

  • workspace(void*, 入参)：在Device侧申请的workspace内存地址。
  • workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnIndexCopyWorkspaceSize获取。
  • executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。
  • stream(aclrtStream, 入参)：指定执行任务的AscendCL Stream流。

• 返回值：

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

aclnnInplaceIndexCopyGetWorkspaceSize

• 参数说明：

  • selfRef（aclTensor*, 计算输入)：Device侧的aclTensor，输入数据类型支持FLOAT、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持）、FLOAT16、INT32、INT64、INT16、INT8、UINT8、DOUBLE、BOOL、COMPLEX128、COMPLEX64，支持undefined，undefined支持ND。
  • dim(int64_t,计算输入): host侧的int64类型，在[-selfRef.dim(), selfRef.dim() - 1]范围内。
  • index(aclTensor*, 计算输入)：Device侧的aclTensor，数据类型支持INT32、INT64，维度不能大于1，元素个数要求和张量source中dim轴的大小相同。支持undefined，undefined支持ND，当index有重复索引值的时候，结果不保序。
  • source(aclTensor*, 计算输入): Device侧的aclTensor，数据类型与维度和selfRef一致，dim轴的大小和index的元素数量相同，其他维度同selfRef的shape，支持undefined，undefined支持ND。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnInplaceIndexCopy

• 参数说明：

  • workspace(void*, 入参)：在Device侧申请的workspace内存地址。
  • workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnInplaceIndexCopyWorkspaceSize获取。
  • executor(aclOpExecutor*, 入参)：op执行器，包含了算子计算流程。
  • stream(aclrtStream, 入参)：指定执行任务的AscendCL Stream流。

• 返回值：

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

约束与限制

无

调用示例

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