aclnnSoftshrinkBackward

支持的产品型号

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

接口原型

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

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

功能描述

• 算子功能：Softshrink函数的反向接口。
• Softshrink正向的计算公式：$$Softshrink(x)= \begin{cases} x - {\lambda}, \ if \ x > {\lambda}\\ x + {\lambda}, \ if \ x < -{\lambda} \end{cases}$$ ​ aclnnSoftshrinkBackward计算公式：

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

aclnnSoftshrinkBackwardGetWorkspaceSize

• 参数说明：

  • gradOutput(const aclTensor *，计算输入)：公式中的$gradOutput$，数据类型支持FLOAT16、FLOAT，shape与self满足broadcast规则，支持，支持空Tensor传入，支持ND。
  • self(const aclTensor *, 计算输入)：公式中的$x$，输入tensor。数据类型支持FLOAT、FLOAT16。shape与gradOutput满足broadcast规则，支持，支持空Tensor传入，支持ND。
  • lambda(const aclScalar *, 计算输入): 公式中的输入$\lambda$.数据类型支持FLOAT类型。
  • gradInput(aclTensor *, 计算输入)：公式中的gradInput，输出tensor。数据类型支持FLOAT16、FLOAT，且shape需要与self和gradOutput的broadcast结果一致。支持，支持空Tensor传入，支持ND。
  • workspaceSize(uint64_t *，出参)：返回用户需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnSoftshrinkBackwardBackward

• 参数说明：

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

• 返回值：

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

约束与限制

无。

调用示例

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