aclnnFlashAttentionUnpaddingScoreGradV4

产品支持情况

[object Object]undefined

功能说明

• 接口功能：训练场景下计算注意力的反向输出，即的反向计算。该接口相较于接口，新增softmaxInLayout参数。

  • 当输入softmaxSumOut和softmaxMaxOut的shape和实际数据排布均为TND格式时，softmaxInLayout需要配置为"same_as_input"。
  • 当输入softmaxSumOut和softmaxMaxOut的shape为TND但实际数据排布均为NTD格式时，softmaxInLayout需要配置为""。
  • 原有FlashAttentionVarLenScore接口的softmaxSumOut和softmaxMaxOut的输出格式为NTD，FlashAttentionVarLenScoreV4接口允许传入字符串类型参数softmaxOutLayout，来控制是否输出Shape和数据排布均为TND格式的softmaxSumOut和softmaxMaxOut。

• 计算公式：

  已知注意力的正向计算公式为：

  $$Y=Dropout(Softmax(Mask(\frac{QK^T+pse}{\sqrt{d}}),atten\_mask),keep\_prob)V$$

  为方便表达，以变量$S$和$P$表示计算公式：

  $$S=Mask(\frac{QK^T+pse}{\sqrt{d}}),atten\_mask$$ $$P=Dropout(Softmax(S),keep\_prob)$$ $$Y=PV$$

  则注意力的反向计算公式为：

  $$dV=P^TdY$$ $$dQ=\frac{((dS)*K)}{\sqrt{d}}$$ $$dK=\frac{((dS)^T*Q)}{\sqrt{d}}$$

函数原型

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

aclnnFlashAttentionUnpaddingScoreGradV4GetWorkspaceSize

• 参数说明：

  [object Object]

• 返回值：

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

  第一段接口完成入参校验，出现以下场景时报错：

  [object Object]

aclnnFlashAttentionUnpaddingScoreGradV4

• 参数说明：

  [object Object]

• 返回值：

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

约束说明

• 确定性计算：

  • aclnnFlashAttentionUnpaddingScoreGradV4默认非确定性实现，支持通过aclrtCtxSetSysParamOpt开启确定性。

• 该接口与PyTorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。

• 输入query、key、value、dy的B：batchsize必须相等。

• 输入query、key、value、dy的inputLayout必须一致。

• 输入query、key、value、pseShiftOptional的数据类型必须一致。

• 输入key/value的shape必须一致，在query/key/value的d大小相同的情况下，query/dy的shape必须一致。注：当前版本仅支持query/key/value的d大小相同的情况。

• 支持输入query的N和key/value的N不相等，但必须成比例关系，即Nq/Nkv必须是非0整数，Nq取值范围1~256。

• 关于数据shape的约束，以inputLayout的TND为例，其中：

  • T(B*S)：取值范围为1~1M。
  • B：取值范围为1~2K。带prefixOptional的时候B最大支持1K。
  • N：取值范围为1~256。
  • S：取值范围为1~1M。
  • D：取值范围为1~768。
  • KeepProb: 取值范围为(0, 1]。

• query、key、value数据排布格式仅支持TND，T是B和S合轴紧密排列的数据（每个batch的SeqLenQ和SeqLenKV），其中B（Batch）表示输入样本批量大小、S（Seq-Length）表示输入样本序列长度、H（Head-Size）表示隐藏层的大小、N（Head-Num）表示多头数、D（Head-Dim）表示隐藏层最小的单元尺寸，且满足D=H/N。

• realShiftOptional：如果Sq大于1024的每个batch的Sq与Skv等长且是sparseMode为0、2、3的下三角掩码场景，可使能alibi位置编码压缩，此时只需要输入原始PSE最后1024行进行内存优化，即alibi_compress = ori_pse[:, :, -1024:, :]，具体如下：

  • 参数每个batch不相同时，shape为BNHSkv(H=1024)。
  • 每个batch相同时，shape为1NHSkv(H=1024)。
  • 如不使用该参数可传入nullptr。

• sparseMode的约束如下:

  • 当所有的attenMaskOptional的shape小于2048且相同的时候，建议使用default模式，来减少内存使用量；
  • 配置为1、2、3、5时，用户配置的preTokens、nextTokens不会生效；
  • 配置为0、4时，须保证attenMaskOptional与preTokens、nextTokens的范围一致。
  • 用户不特意指定时建议传入0。
  • sparse不同模式的详细说明请参见。
  • 配置为7时，不支持可选输入realShiftOptional。
  • 配置为8时，当每个sequence的q、kv等长时支持可选输入realShiftOptional，针对全局做pse生成。支持q方向进行外切，需要外切前每个sequence的q、kv等长，外切后传入的actualSeqQLenOptional

• 部分场景下，如果计算量过大可能会导致算子执行超时（aicore error类型报错，errorStr为：timeout or trap error），此时建议做轴切分处理，注：这里的计算量会受B、S、N、D等参数的影响，值越大计算量越大。

• prefixOptional稀疏计算仅支持压缩场景，sparseMode=6，当Sq > Skv时，prefix的N值取值范围[0, Skv]，当Sq <= Skv时，prefix的N值取值范围[Skv-Sq, Skv]。 [0] - actualSeqKvLenOptional[0] + qStartIdxOptional - kvStartIdxOptional == 0（本功能属实验性功能）。

• actualSeqQLenOptional输入支持某个Batch上的S长度为0，此时不支持可选输入pseShiftOptional。

• 关于softmaxMax与softmaxSum参数的约束：输入格式固定为[B, N, S, 8]，TND的输入格式除外，此时为[T, N, 8]，注：T=B*S。

• headNum的取值必须和传入的Query中的N值保持一致。

• softmaxSum、softmaxMax数据排布为TND时，softmaxInLayout需要为"same_as_input"。

调用示例

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