昇腾社区首页
中文
注册
开发者
下载
支持
积分兑换 NEW

aclnnScatter&aclnnInplaceScatter

支持的产品型号

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

接口原型

  • aclnnScatter和aclnnInplaceScatter实现相同的功能，使用区别如下，请根据自身实际场景选择合适的算子。

    • aclnnScatter：需新建一个输出张量对象存储计算结果。
    • aclnnInplaceScatter：无需新建输出张量对象，直接在输入张量的内存中存储计算结果。

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

    • aclnnStatus aclnnScatterGetWorkspaceSize(const aclTensor* self, int64_t dim, const aclTensor* index, const aclTensor* src, int64_t reduce, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
    • aclnnStatus aclnnScatter(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, const aclrtStream stream)
    • aclnnStatus aclnnInplaceScatterGetWorkspaceSize(aclTensor* selfRef, int64_t dim, const aclTensor* index, const aclTensor* src, int64_t reduce, uint64_t* workspaceSize, aclOpExecutor** executor)
    • aclnnStatus aclnnInplaceScatter(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, const aclrtStream stream)

功能描述

  • 算子功能: 将tensor src中的值按指定的轴和方向和对应的位置关系逐个填入tensor self中。

  • 示例： 对于一个3D tensor， self会按照如下的规则进行更新：

    [object Object]

    在计算时需要满足以下要求：

    • self、index和src的维度数量必须相同。
    • 对于每一个维度d，有index.size(d) <= src.size(d)的限制。
    • 对于每一个维度d，如果d != dim, 有index.size(d) <= self.size(d)的限制。
    • dim的值的大小必须在 [-self的维度数量, self的维度数量-1] 之间。
    • self的维度数应该小于等于8。
    • index中对应维度dim的值大小必须在[0, self.size(dim)-1]之间。

aclnnScatterGetWorkspaceSize

  • 参数说明：

    • self(aclTensor*, 计算输入)：公式中的self，Device侧的aclTensor。self的维度数量需要与index、src相同,shape支持0-8维。self的数据类型需要与src一致。支持undefined，undefined支持ND。

      • Atlas 训练系列产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128、BFLOAT16。

    • dim(int64_t, 计算输入)：用来scatter的维度，数据类型为INT64。范围为[-self的维度数量, self的维度数量-1]。

    • index(aclTensor*, 计算输入)：公式中的index，Device侧的aclTensor。index的维度数量需要与self、src相同,shape支持0-8维。支持undefined。undefined支持ND。

      • Atlas 训练系列产品：数据类型支持INT32、INT64。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持INT32、INT64。

    • src(aclTensor*, 计算输入)：公式中的src，Device侧的aclTensor。src的维度数量需要与self、index相同,shape支持0-8维。src的数据类型需要与self一致。支持undefined，undefined支持ND。

      • Atlas 训练系列产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128、BFLOAT16。

    • reduce(int64_t, 计算输入)：Host侧的整型，选择应用的reduction操作。可选的操作选项以及对应的int值为 (add, 1), (mul, 2)，(none, 0)。具体操作含义如下： 0：表示替换操作，将src中的对应位置的值按照index替换到out中的对应位置。 1：表示累加操作，将src中的对应位置的值按照index累加到out中的对应位置。 2：表示累乘操作，将src中的对应位置的值按照index累乘到out的对应位置。

    • out(aclTensor*, 计算输出)：数据类型与self的数据类型一致。shape需要与self一致。undefined支持ND。

      • Atlas 训练系列产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128、BFLOAT16。

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

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

  • 返回值：

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

    [object Object]

aclnnScatter

  • 参数说明：

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

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

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

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

  • 返回值：

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

aclnnInplaceScatterGetWorkspaceSize

  • 参数说明：

    • selfRef(aclTensor*, 计算输入|计算输出)：公式中的self，Device侧的aclTensor。scatter的目标张量，shape支持0-8维，shape需要与index和src相同。数据类型与src的数据类型满一致。支持空tensor， 支持undefined。undefined支持ND。
      • Atlas 训练系列产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT32、DOUBLE、COMPLEX64、COMPLEX128、BFLOAT16。
    • dim(int64_t, 计算输入)：指定沿哪个维度进行scatter操作，数据类型为INT64，host侧整型。范围为[-selfRef的维度数量, selfRef的维度数量-1]。
    • index(aclTensor*, 计算输入)：索引张量，用于指定src张量中散布到self张量中的位置，Device侧的aclTensor。数据类型支持INT32, INT64。index的维度数量需要与selfRef、src相同,shape支持0-8维。对于每一个维度d，需保证index.size(d) <= src.size(d)，如果d != dim, 需要保证index.size(d) <= selfRef.size(d)。支持空tensor，支持undefined。undefined支持ND。
    • src(aclTensor*, 计算输入)：公式中的src，Device侧的aclTensor。源张量，其中的值将根据index张量指定的位置散布到self中,src的维度数量需要与selfRef、index相同,shape支持0-8维。src的数据类型需要与selfRef一致。支持空tensor， 支持undefined。undefined支持ND。
      • Atlas 训练系列产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT、DOUBLE、COMPLEX64、COMPLEX128。
      • Atlas A2训练系列产品/Atlas 800I A2推理产品：数据类型支持UINT8、INT8、INT16、INT32、INT64、BOOL、FLOAT16、FLOAT、DOUBLE、COMPLEX64、COMPLEX128、BFLOAT16。
    • reduce(int64_t, 计算输入)：选择应用的reduction操作。可选的操作选项以及对应的int值为 (add, 1), (mul, 2)，(none, 0)。具体操作含义如下： 0：表示替换操作，将src中的对应位置的值按照index替换到selfRef中的对应位置 1：表示累加操作，将src中的对应位置的值按照index累加到selfRef中的对应位置 2：表示累乘操作，将src中的对应位置的值按照index累乘到selfRef的对应位置
    • workspaceSize(uint64_t*，出参)：返回需要在Device侧申请的workspace大小。
    • executor(aclOpExecutor**，出参)：返回op执行器，包含了算子计算流程。

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

    [object Object]

aclnnInplaceScatter

  • 参数说明：

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

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

约束与限制

  • 无。

调用示例

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

aclnnScatter示例代码：

[object Object]

aclnnInplaceScatter示例代码：

[object Object]