aclnnTriu&aclnnInplaceTriu

支持的产品型号

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

接口原型

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

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

• 每个算子分为，必须先调用 “aclnnTriuGetWorkspaceSize” 或者 “aclnnInplaceTriuGetWorkspaceSize” 接口获取入参并根据计算流程计算所需workspace大小，再调用 “aclnnTriu” 或者 “aclnnInplaceTriu” 接口执行计算。

  • aclnnStatus aclnnTriuGetWorkspaceSize(const aclTensor *self, int64_t diagonal, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnStatus aclnnTriu(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceTriuGetWorkspaceSize(aclTensor *selfRef, int64_t diagonal, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnStatus aclnnInplaceTriu(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：将输入的self张量的最后二维（按shape从左向右数）沿对角线的左下部分置零。参数diagonal可正可负，默认为零，正数表示主对角线向右上方向移，负数表示主对角线向左下方向移动。
• 计算公式：下面用i表示遍历倒数第二维元素的序号（i是行索引），用j表示遍历最后一维元素的序号（j是列索引），用d表示diagonal，在(i, j)对应的二维坐标图中，i+d==j表示在对角线上，

$$对角线及其右上方，即i+d<=j，保留原值： out_{i, j} = self_{i, j}\\ 而位于对角线左下方的情况，即i+d>j，置零（不含对角线）：out_{i, j} = 0$$

• 示例：

  self = [[9, 6, 3],
      [1, 2, 2],
      [3, 4, 1]]
  triu(self, diagonal=0)的结果是：
    [[9, 6, 3],
     [0, 2, 2],
     [0, 0, 1]]
  调整diagonal的值，triu(self, diagonal=1)结果为：
    [[0, 6, 3],
     [0, 0, 2],
     [0, 0, 0]]
  调整diagonal为-1，triu(self, diagonal=-1)结果为：
    [[9, 6, 3],
     [1, 2, 2],
     [0, 4, 1]]

aclnnTriuGetWorkspaceSize

• 参数说明：

  • self(const aclTensor*, 计算输入)：Device侧的aclTensor，数据类型支持UINT64, INT64, UINT32, INT32, UINT16, INT16, UINT8, INT8, FLOAT16, BFLOAT16（仅Atlas A2训练系列产品支持）, FLOAT32, DOUBLE, BOOL. 支持非连续的Tensor，支持ND。数据维度不高于8维、不低于2维。
  • diagonal(int64_t, 计算输入)：对角线偏移量，数据类型int64_t。
  • out(aclTensor*, 计算输出)：Device侧的aclTensor，数据类型支持UINT64, INT64, UINT32, INT32, UINT16, INT16, UINT8, INT8, FLOAT16, FLOAT32, DOUBLE, BOOL. 为ND
  • workspaceSize(uint64_t *, 出参)：返回用户需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnTriu

• 参数说明：

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

• 返回值：

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

aclnnInplaceTriuGetWorkspaceSize

• 参数说明：

  • selfRef(aclTensor*, 计算输入)：Device侧的aclTensor，数据类型支持UINT64, INT64, UINT32, INT32, UINT16, INT16, UINT8, INT8, FLOAT16, BFLOAT16（仅Atlas A2训练系列产品支持）, FLOAT32, DOUBLE, BOOL. 支持非连续的Tensor，支持ND。数据维度不高于8维、不低于2维。
  • diagonal(int64_t, 计算输入)：对角线偏移量，数据类型int64_t。
  • workspaceSize(uint64_t *, 出参)：返回用户需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnInplaceTriu

• 参数说明：

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

• 返回值：

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

约束与限制

对于Atlas 训练系列产品，不支持BFLOAT16数据类型的计算。

调用示例

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