aclnnIndexFill&aclnnInplaceIndexFill

产品支持情况

产品	是否支持
[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]	×

功能说明

• 算子功能：沿输入self的给定轴dim，将index指定位置的值使用value进行替换，计算结果是确定的。

• 示例： 输入self为:

    [[1, 2, 3],

     [4, 5, 6],

     [7, 8, 9]]

  若dim = 0，index = [0, 2]， value = 0时，算子的计算结果为：

    [[0, 0, 0],

     [4, 5, 6],

     [0, 0, 0]]

  若dim = 1，index = [0, 2]， value = 0时，算子的计算结果为：

    [[0, 2, 0],

     [0, 5, 0],

     [0, 8, 0]]

函数原型

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

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

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

  • aclnnStatus aclnnIndexFillGetWorkspaceSize(const aclTensor* self, int64_t dim, const aclTensor* index, const aclScalar* value, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnIndexFill(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceIndexFillGetWorkspaceSize(aclTensor* selfRef, int64_t dim, const aclTensor* index, const aclScalar* value, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnInplaceIndexFill(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

aclnnIndexFillTensorGetWorkspaceSize

• 参数说明：

  • self(aclTensor*, 计算输入)：功能示例中的self，即待被在指定位置的值用value替换的张量。Device侧的aclTensor。支持undefined，undefined支持ND。shape支持0-8维，数据类型支持FLOAT16、FLOAT、INT32、INT64、BOOL、BFLOAT16。
  • dim(int64_t, 计算输入)：Host侧int64类型，指定了self将要填充的维度，当self为1-8维时，dim的取值范围在[-self.dim(), self.dim())，当self为0维时，dim的取值范围在[-1, 1)。
  • index(aclTensor*, 计算输入)：Device侧的aclTensor 类型，指定self在dim维度将要填充的下标。其中的元素值小于self对应dim的维度大小，支持负数，支持越界，对于越界值会直接跳过。数据类型支持INT32、INT64。
  • value(aclScalar*, 计算输入)：Host侧的aclScalar，指定填充的数据值。需要可转化为self的数据类型。数据类型支持FLOAT16、FLOAT、INT32、INT64、BOOL、BFLOAT16。
  • out(aclTensor*, 计算输出)：指定的输出张量，Device侧的aclTensor类型，数据类型需要与self保持一致，shape需要与self保持一致，支持undefined，undefined支持ND。数据类型支持FLOAT16、FLOAT、INT32、INT64、BOOL、BFLOAT16。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

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

  [object Object]

aclnnIndexFill

• 参数说明：

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

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

aclnnInplaceIndexFillGetWorkspaceSize

• 参数说明：

  • selfRef(aclTensor*, 计算输入/计算输出)：待被在指定位置的值用value替换的张量。输入输出tensor，Device侧的aclTensor。支持undefined，undefined支持ND，shape支持0-8维，数据类型支持FLOAT16、FLOAT、INT32、INT64、BOOL、BFLOAT16。
  • dim(int64_t, 计算输入)：host侧int64类型，指定了selfRef将要填充的维度，当selfRef为1-8维时，dim的取值范围在[-selfRef.dim(), selfRef.dim())，当self为0维时，dim的取值范围在[-1, 1)。
  • index(aclTensor, 计算输入)：Device侧的aclTensor，指定selfRef在dim维度将要填充的下标。其中的元素值小于selfRef对应的dim的维度大小，支持负数，支持越界，对于越界值会直接跳过。数据类型支持INT32、INT64。
  • value(aclScalar*, 计算输入)：Host侧的aclScalar，指定填充的数据值。数据类型支持FLOAT16、FLOAT、INT32、INT64、BOOL、BFLOAT16。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

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

  [object Object]

aclnnInplaceIndexFill

• 参数说明：

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

• 返回值：

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

约束说明

无

调用示例

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

aclnnIndexFill调用示例：

aclnnInplaceIndexFillTensor调用示例：