aclnnScaledMaskedSoftmaxBackward

产品支持情况

功能说明

• 算子功能：softmax的反向传播，并对结果进行缩放以及掩码。
• 计算公式：$$out = gradOutput \cdot output - sum(gradOutput \cdot output)\cdot output \\ out = \begin{cases} out * scale, &\text { mask is 0 } \\ 0, &\text { mask is 1 } \end{cases}$$

函数原型

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

• aclnnStatus aclnnScaledMaskedSoftmaxBackwardGetWorkspaceSize(const aclTensor *gradOutput, const aclTensor *y, const aclTensor *mask, double scale, bool fixTriuMask, aclTensor* out, uint64_t *workspaceSize, aclOpExecutor **executor)

• aclnnStatus aclnnScaledMaskedSoftmaxBackward(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnScaledMaskedSoftmaxBackwardGetWorkspaceSize

• 参数说明：

  • gradOutput（aclTensor*，计算输入）：反向传播的梯度值，即上一层的输出梯度，公式中的gradOutput，Device侧的aclTensor。shape仅支持4维，最后一维范围是[0, 4096]，数据类型支持FLOAT16、FLOAT32、BFLOAT16，gradOutput与mask满足undefined。支持undefined，undefined支持ND。

  • y（aclTensor*，计算输入）：softmax函数的输出值，公式中的y，Device侧的aclTensor。shape和dtype与gradOutput一致，数据类型支持FLOAT16、FLOAT32、BFLOAT16。支持undefined，undefined支持ND。

  • mask(aclTensor*，计算输入): 用于对计算结果进行掩码，公式中的mask，Device侧的aclTensor。shape支持4维，数据类型支持BOOL，mask后两维与gradOutput一致，且mask可以broadcast成gradOutput。支持undefined，undefined支持ND。

  • scale（double，计算输入）：用于对输出进行缩放，公式中的scale。

  • fixTriuMask（bool，计算输入）：表示是否需要在算子内生成上三角的mask Tensor，仅支持false。

  • out（aclTensor*，计算输出）：函数的输出是输入的梯度值，即对输入进行求导后的结果，公式中的out，Device侧的aclTensor。shape和dtype与gradOutput一致，数据类型支持FLOAT16、FLOAT32、BFLOAT16。支持undefined，undefined支持ND。

  • workspaceSize（uint64_t *，出参）：返回需要在Device侧申请的workspace大小。

  • executor（aclOpExecutor **，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnScaledMaskedSoftmaxBackward

• 参数说明：

  • workspace（void *，入参）：在Device侧申请的workspace内存地址。

  • workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnScaledMaskedSoftmaxBackwardGetWorkspaceSize获取。

  • executor（aclOpExecutor *，入参）：op执行器，包含了算子计算流程。

  • stream（aclrtStream，入参）：指定执行任务的Stream。

• 返回值：

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

调用示例

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