aclnnHardtanh&aclnnInplaceHardtanh

产品支持情况

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

功能说明

• 算子功能: 将输入的所有元素限制在[clipValueMin,clipValueMax]范围内，若元素大于clipValueMax则限制为clipValueMax，若元素小于clipValueMin则限制为clipValueMin，否则等于元素本身。
• 计算公式：$$HardTanh(x) = \left\{\begin{matrix}\begin{array}{l} clipValueMax, \ if\ x>clipValueMax \\ clipValueMin, \ if\ x<clipValueMin \\ x, \ otherwise \\\end{array}\end{matrix}\right.\begin{array}{l}\end{array}$$

函数原型

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

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

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

  • aclnnStatus aclnnHardtanhGetWorkspaceSize(const aclTensor *self, const aclScalar* clipValueMin, const aclScalar* clipValueMax, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnStatus aclnnHardtanh(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)
  • aclnnStatus aclnnInplaceHardtanhGetWorkspaceSize(aclTensor *selfRef, const aclScalar* clipValueMin, const aclScalar* clipValueMax, uint64_t *workspaceSize, aclOpExecutor **executor)
  • aclnnStatus aclnnInplaceHardtanh(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnHardtanhGetWorkspaceSize

• 参数说明：

  • self(aclTensor*,计算输入): 公式中的x，Device侧的aclTensor，且数据类型和out保持一致，shape和out保持一致，支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT16、BFLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
  • clipValueMin(aclScalar*,计算输入): Host侧的aclScalar，下界，数据类型需要可转化成self的数据类型，且clipValueMin和clipValueMax同时存在时需要保持一致。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT16、BFLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
  • clipValueMax(aclScalar*,计算输入): Host侧的aclScalar，上界，数据类型需要可转化成self的数据类型，且clipValueMin和clipValueMax同时存在时需要保持一致。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT16、BFLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
  • out(aclTensor*，计算输出)：Device侧的aclTensor，且数据类型和self保持一致，shape和self保持一致，支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT16、BFLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnHardtanh

• 参数说明：

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

• 返回值：

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

aclnnInplaceHardtanhGetWorkspaceSize

• 参数说明：

  • selfRef(aclTensor*，计算输入): Device侧的aclTensor。支持undefined，undefined支持ND。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT16、BFLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
  • clipValueMin(aclScalar*,计算输入): Host侧的aclScalar，下界，数据类型需要可转化成selfRef的数据类型，且clipValueMin和clipValueMax同时存在时需要保持一致。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT16、BFLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
  • clipValueMax(aclScalar*,计算输入): Host侧的aclScalar，上界，数据类型需要可转化成selfRef的数据类型，且clipValueMin和clipValueMax同时存在时需要保持一致。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：FLOAT16、BFLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
    • [object Object]Atlas 推理系列产品[object Object]、[object Object]Atlas 训练系列产品[object Object]：FLOAT16、FLOAT、FLOAT64、INT8、UINT8、INT16、INT32、INT64
  • workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor **, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnInplaceHardtanh

• 参数说明：

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

• 返回值：

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

约束说明

无

调用示例

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