aclnnSoftshrinkBackward

产品支持情况

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

功能说明

• 算子功能：Softshrink函数的反向接口。
• 计算公式：

  • Softshrink正向计算公式：

    $$Softshrink(x)= \begin{cases} x - {\lambda}, \ if \ x > {\lambda}\\ x + {\lambda}, \ if \ x < -{\lambda} \end{cases}$$

  • Softshrink反向计算公式：

    $$gradInput= \begin{cases} gradOutput, \ if \ x > \lambda \\ gradOutput, \ if \ x <-\lambda \\ 0, \ otherwise \end{cases}$$

函数原型

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

• aclnnStatus aclnnSoftshrinkBackwardGetWorkspaceSize(const aclTensor* gradOutput, const aclTensor* self, const aclScalar* lambda, aclTensor* gradInput, uint64_t* workspaceSize, aclOpExecutor** executor)
• aclnnStatus aclnnSoftshrinkBackward(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, const aclrtStream stream)

aclnnSoftshrinkBackwardGetWorkspaceSize

• 参数说明：

  • gradOutput（aclTensor*，计算输入）：反向传播过程中上一步输出的梯度，作为本反向算子的输入，公式中的$gradOutput$，Device侧的aclTensor，shape支持0-8维度，shape与self满足undefined，支持undefined，支持空Tensor传入，undefined支持ND，gradOutput、self和gradInput的数据类型一致。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持FLOAT16、FLOAT。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT、BFLOAT16。
  • self（aclTensor*，计算输入）：公式中的$x$，正向的输入tensor。shape支持0-8维度，shape与gradOutput满足undefined，数据类型需要gradOutput一致，支持undefined，支持空Tensor传入，undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持FLOAT16、FLOAT。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT、BFLOAT16。
  • lambda（aclScalar*，计算输入）：公式中的输入$\lambda$。数据类型支持FLOAT类型，取值范围应大于等于0。
  • gradInput（aclTensor*，计算输出）：公式中的$gradInput$，输出tensor。shape支持0-8维度，shape需要与self和gradOutput的broadcast结果一致。数据类型需要gradOutput一致。支持undefined，支持空Tensor传入，undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持FLOAT16、FLOAT。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT、BFLOAT16。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnSoftshrinkBackward

• 参数说明：

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

• 返回值：

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

约束说明

无。

调用示例

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