aclnnClampMaxTensor&aclnnInplaceClampMaxTensor

支持的产品型号

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

接口原型

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

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

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

  • aclnnStatus aclnnClampMaxTensorGetWorkspaceSize(const aclTensor* self, const aclTensor* max, aclTensor* out, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnClampMaxTensor(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceClampMaxTensorGetWorkspaceSize(aclTensor* selfRef, const aclTensor* max, uint64_t* workspaceSize, aclOpExecutor** executor)
  • aclnnStatus aclnnInplaceClampMaxTensor(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

功能描述

• 算子功能：将输入的所有元素限制在[-inf, max]范围内。

• 计算公式：

  $${out}_{i} = min({{self}_{i}},{max}_{i})$$

aclnnClampMaxTensorGetWorkspaceSize

• 参数说明：

  • self(aclTensor*, 计算输入)：输入tensor，数据类型支持FLOAT16、FLOAT、DOUBLE、INT8、UINT8、INT16、INT32、INT64、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与max的数据类型需满足数据类型推导规则（参见undefined）。shape需要与max满足undefined，支持undefined，undefined支持ND。
  • max(aclTensor*, 计算输入)：输入上限值tensor，数据类型支持FLOAT16、FLOAT、DOUBLE、INT8、UINT8、INT16、INT32、INT64、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与self的数据类型需满足数据类型推导规则（参见undefined）。shape需要与self满足undefined，支持undefined，undefined支持ND。
  • out(aclTensor*, 计算输出)：输出tensor，数据类型支持FLOAT16、FLOAT、DOUBLE、INT8、UINT8、INT16、INT32、INT64、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要是self与max推导之后可转换的数据类型，shape需要是self与max broadcast之后的shape，支持undefined，undefined支持ND。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnClampMaxTensor

• 参数说明：

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

• 返回值：

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

aclnnInplaceClampMaxTensorGetWorkspaceSize

• 参数说明：

  • selfRef(aclTensor*, 计算输入|计算输出)：输入输出tensor，即公式中的self与out。数据类型支持FLOAT16、FLOAT、DOUBLE、INT8、UINT8、INT16、INT32、INT64、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与max的数据类型需满足数据类型推导规则（参见undefined）。shape需要与max满足undefined，支持undefined，undefined支持ND。
  • max(aclTensor*, 计算输入)：输入上限值tensor，数据类型支持FLOAT16、FLOAT、DOUBLE、INT8、UINT8、INT16、INT32、INT64、BFLOAT16（仅Atlas A2训练系列产品/Atlas 800I A2推理产品支持），且数据类型需要与selfRef的数据类型需满足数据类型推导规则（参见undefined）。shape需要与selfRef满足undefined，支持undefined，undefined支持ND。
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnInplaceClampMaxTensor

• 参数说明：

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

• 返回值：

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

约束与限制

无

调用示例

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

aclnnClampMaxTensor调用示例：

aclnnInplaceClampMaxTensor调用示例：