aclnnThreshold&aclnnInplaceThreshold

支持的产品型号

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

接口原型

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

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

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

  • aclnnStatus aclnnThresholdGetWorkspaceSize(const aclTensor *self, const aclScalar *threshold, const aclScalar *value, aclTensor *out, uint64_t *workspaceSize, alcOpExecutor **executor)
  • aclnnStatus aclnnThreshold(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceThresholdGetWorkspaceSize(aclTensor *selfRef, const aclScalar *threshold,const aclScalar *value, uint64_t *workspaceSize,aclOpExecutor **executor)
  • aclnnStatus aclnnInplaceThreshold(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

• 算子功能：对输入x进行阈值操作。当x中的elements大于threshold时，返回elements；否则，返回value。
• 计算公式：$$out(x) = \begin{cases} x, & x\gt threshold \\ value, & otherwise \end{cases}$$

aclnnThresholdGetWorkspaceSize

• 参数说明

  • self（aclTensor*, 计算输入）：公式中的输入x，Device侧的aclTensor，支持FLOAT、FLOAT16、INT32、INT8、UINT8、INT16和INT64、BFLOAT16（仅Atlas A2训练系列产品支持）数据类型。支持，支持ND。
  • threshold（aclScalar*, 计算输入）：公式中的输入threshold，Device侧的aclScalar，即阈值。支持FLOAT、FLOAT16、INT32、INT8、UINT8、INT16和INT64、BFLOAT16（仅Atlas A2训练系列产品支持）数据类型,且数据类型与self的数据类型需满足数据类型推导规则（参见）。
  • value（aclScalar*, 计算输入）：公式中的输入value，Device侧的aclScalar，表示输入self的元素小于阈值时的返回值。支持FLOAT、FLOAT16、INT32、INT8、UINT8、INT16和INT64、BFLOAT16（仅Atlas A2训练系列产品支持）数据类型，且数据类型与self的数据类型需满足数据类型推导规则（参见）。
  • out（aclTensor*, 计算输出）：公式中的输出out，Device侧的aclTensor，支持FLOAT、FLOAT16、INT32、INT8、UINT8、INT16和INT64、BFLOAT16（仅Atlas A2训练系列产品支持）数据类型，且数据类型与self的数据类型需满足数据类型推导规则（参见），shape需要与self满足。支持，支持ND。
  • workspaceSize（uint64_t*, 出参）：返回用户需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**, 出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnThreshold

• 参数说明：

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

• 返回值：

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

aclnnInplaceThresholdGetWorkspaceSize

• 参数说明：

  • selfRef（aclTensor*, 计算输入）：公式中的输入x，Device侧的aclTensor，支持FLOAT、FLOAT16、INT32、INT8、UINT8、INT16和INT64、BFLOAT16（仅Atlas A2训练系列产品支持）数据类型。支持，支持ND。
  • threshold（aclScalar*, 计算输入）：公式中的输入threshold，Device侧的aclScalar，即阈值。支持FLOAT、FLOAT16、INT32、INT8、UINT8、INT16和INT64、BFLOAT16（仅Atlas A2训练系列产品支持）数据类型,且数据类型与selfRef的数据类型需满足数据类型推导规则（参见）。
  • value（aclScalar*, 计算输入）：公式中的输入value，Device侧的aclScalar，表示输入selfRef的元素小于阈值时的返回值。支持FLOAT、FLOAT16、INT32、INT8、UINT8、INT16和INT64、BFLOAT16（仅Atlas A2训练系列产品支持）数据类型，且数据类型与selfRef的数据类型需满足数据类型推导规则（参见）。
  • workspaceSize（uint64_t*, 出参）：返回用户需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**, 出参）：返回op执行器，包含了算子计算流程。

• 返回值

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

  [object Object]

aclnnInplaceThreshold

• 参数说明

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

• 返回值

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

约束与限制

无

调用示例

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