FlashAttentionUnpaddingScoreGrad

支持的产品型号

Atlas A2 训练系列产品

产品形态详细说明请参见。

功能描述

• 算子功能：训练场景下计算注意力的反向输出，即的反向计算。

• 计算公式：

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

  $$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}}$$ $$d(pse)=dS*\sqrt{d}$$

算子执行接口

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

• aclnnStatus aclnnFlashAttentionUnpaddingScoreGradGetWorkspaceSize(const aclTensor* query, const aclTensor* keyIn, const aclTensor* value, const aclTensor* dy, const aclTensor* pseShiftOptional, const aclTensor* dropMaskOptional, const aclTensor* paddingMaskOptional, const aclTensor* attenMaskOptional, const aclTensor* softmaxMaxOptional, const aclTensor* softmaxSumOptional, const aclTensor* softmaxInOptional, const aclTensor* attentionInOptional, const aclIntArray* prefixOptional, const aclIntArray* actualSeqQLenOptional, const aclIntArray* actualSeqKvLenOptional, double scaleValueOptional, double keepProbOptional, int64_t preTokensOptional, int64_t nextTokensOptional, int64_t headNum, char* inputLayout, int64_t innerPreciseOptional, int64_t sparseModeOptional, const aclTensor* dqOut, const aclTensor* dkOut, const aclTensor* dvOut, const aclTensor* dpseOut, uint64_t* workspaceSize, aclOpExecutor** executor)
• aclnnStatus aclnnFlashAttentionUnpaddingScoreGrad(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

说明：

• 算子执行接口对外屏蔽了算子内部实现逻辑以及不同代际NPU的差异，且开发者无需编译算子，实现了算子的精简调用。
• 若开发者不使用算子执行接口的调用算子，也可以定义基于Ascend IR的算子描述文件，通过ATC工具编译获得算子om文件，然后加载模型文件执行算子，详细调用方法可参见《应用开发指南》的章节。

aclnnFlashAttentionUnpaddingScoreGradGetWorkspaceSize

• 参数说明：

  • query（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入Q，数据类型支持FLOAT16、BFLOAT16、FLOAT32，支持ND。综合约束请见。

  • keyIn（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入K，数据类型支持FLOAT16、BFLOAT16、FLOAT32，支持ND。综合约束请见。

  • value（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入V，数据类型支持FLOAT16、BFLOAT16、FLOAT32，支持ND。综合约束请见。

  • dy（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入dY，数据类型支持、FLOAT16、BFLOAT16、FLOAT32，支持ND。综合约束请见。

  • pseShiftOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入pse，可选参数，表示位置编码。数据类型支持FLOAT16、BFLOAT16、FLOAT32，支持ND，支持shape范围为[B,N,H,S]、[1,N,H,S]，H固定为1024。alibi位置编码场景，preTokensOptional和nextTokensOptional必须配置下三角，且Sq和Skv是等长的。

  • dropMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，可选属性，数据类型支持UINT8，支持ND，其shape和数据排布可表示为：

    $$(\sum_{b=0}^{B-1} (\sum_{n=0}^{N-1}(Sq*Skv)))/8$$

  • paddingMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，暂不支持该传参。

  • attenMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，可选属性，数据类型支持BOOL(8bit的BOOL)、UINT8，支持ND，支持shape范围为[S1Max,S2Max]。综合约束请见。

  • softmaxMaxOptional（aclTensor*，计算输入）：Device侧的aclTensor，注意力正向计算的中间输出，数据类型支持FLOAT，支持ND。综合约束请见。

  • softmaxSumOptional（aclTensor*，计算输入）：Device侧的aclTensor，注意力正向计算的中间输出，数据类型支持FLOAT，支持ND。综合约束请见。

  • softmaxInOptional（aclTensor*，计算输入）：Device侧的aclTensor，注意力正向计算的中间输出，预留参数暂未使用，调用时该参数需传空。

  • attentionInOptional（aclTensor*，计算输入）：Device侧的aclTensor，注意力正向计算的最终输出，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型和shape与query一致，支持ND。

  • prefixOptional（aclTensor*，计算输入）：Device侧的aclTensor，可选属性，代表prefix稀疏计算场景每个Batch的N值。数据类型支持INT64，支持ND。综合约束请见。

  • actualSeqQLenOptional（aclIntArray*，计算输入）：数据类型支持INT64。支持ND。描述了每个Batch对应的query S大小。综合约束请见。

  • actualSeqKvLenOptional（aclIntArray*，计算输入）：数据类型支持INT64。支持ND。描述了每个Batch对应的key/value S大小。

  • dqOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的dQ，表示query的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16、FLOAT32，支持ND。

  • dkOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的dK，表示keyIn的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16、FLOAT32，支持ND。

  • dvOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的dV，表示value的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据格式支持ND。

  • dpseOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的d(pse)，表示pse的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16、FLOAT32，支持ND，预留参数暂未使用，但在pseShiftOptional不为空时，shape和数据类型与pseShiftOptional一致。

  • scaleValueOptional（double，计算输入）：Host侧的double，公式中d开根号的倒数，代表缩放系数，作为计算流中Muls的scalar值，数据类型支持DOUBLE。

  • keepProbOptional（double，计算输入）：Host侧的double，可选参数，代表dropMaskOptional中1的比例，数据类型支持DOUBLE。综合约束请见。

  • preTokensOptional（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算的参数，可选参数，数据类型支持INT64。

  • nextTokensOptional（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算的参数，可选参数，数据类型支持INT64。

  • headNum（int64_t，计算输入）：Host侧的int64_t，代表head个数，数据类型支持INT64。综合约束请见。

  • inputLayout（string*，计算输入）：Host侧的string，代表输入query、keyIn、value的数据排布格式，支持TND。

    说明： query、keyIn、value数据排布格式支持从多种维度解读，其中T (Total S Length) 表示所有batch对应的S的总长、B（Batch）表示输入样本批量大小、S（Seq-Length）表示输入样本序列长度、H（Head-Size）表示隐藏层的大小、N（Head-Num）表示多头数、D（Head-Dim）表示隐藏层最小的单元尺寸，且满足D=H/N。

  • innerPreciseOptional（int32_t，计算输入）：保留参数，暂未使用。

  • sparseModeOptional（int64_t，计算输入）：Host侧的int，表示sparse的模式。数据类型支持INT64。

    • sparseModeOptional为0时，代表defaultMask模式，如果attenMaskOptional未传入则不做mask操作，忽略preTokensOptional和nextTokensOptional(内部赋值为INT_MAX)；如果传入，则需要传入完整的attenMaskOptional矩阵（S1Max * S2Max），表示preTokensOptional和nextTokensOptional之间的部分需要计算。
    • sparseModeOptional为1时，代表allMask，即传入完整的attenMaskOptional矩阵。
    • sparseModeOptional为2时，代表leftUpCausal模式的mask，对应以左顶点为划分的下三角场景，需要传入优化后的attenMaskOptional矩阵（2048*2048）。
    • sparseModeOptional为3时，代表rightDownCausal模式的mask，对应以右下顶点为划分的下三角场景，需要传入优化后的attenMaskOptional矩阵（2048*2048）。
    • sparseModeOptional为4时，代表band场景，即计算preTokensOptional和nextTokensOptional之间的部分。
    • sparseModeOptional为5时，不支持。
    • sparseModeOptional为6时，代表prefix压缩场景，需要传入shape为[3072, 2048]的attenMaskOptional矩阵；分为两部分：其中上半部分为[2048, 2048]的下三角矩阵；下半部分为[1024, 2048]的矩阵，矩形矩阵左半部分全0，右半部分全1。0代表保留，1代表掩掉。
    • sparseModeOptional为7时，代表rightDownCausal_Band场景，该场景由长序列外切产生，需要正确配置preTokensOptional和nextTokensOptional参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。
    • sparseModeOptional为8时，代表band_LeftUpCausal场景，该场景由长序列外切产生，需要正确配置preTokensOptional和nextTokensOptional参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。

    用户不特意指定时可传入默认值0。sparse不同模式的详细说明请参见。

    说明： 当所有的attenMaskOptional的shape小于2048且相同的时候，建议使用default模式，来减少内存使用量；sparseModeOptional配置为1、2、3、5、6时，用户配置的preTokensOptional、nextTokensOptional不会生效；sparse_mode配置为0、4时，须保证attenMaskOptional与b、nextTokensOptional的范围一致。

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

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

• 返回值：

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

  [object Object]

aclnnFlashAttentionUnpaddingScoreGrad

• 参数说明：

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

• 返回值：

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

约束与限制[object Object][object Object]

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

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

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

• 输入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~512。
  • KeepProb: 取值范围为(0, 1]。

• prefixOptional稀疏计算仅支持压缩场景，sparseModeOptional=6，当Sq > Skv时，prefix的N值取值范围[0, Skv]，当Sq <= Skv时，prefix的N值取值范围[Skv-Sq, Skv]。

• sparseModeOptional=7或者8时，不支持可选输入pseShiftOptional。

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

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

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

算子原型

调用示例

该融合算子有两种调用方式：通过PyTorch框架在网络模型中调用，通过aclnn单算子进行调用：

• PyTorch框架调用

  如果通过PyTorch单算子方式调用该融合算子，并且用户定制了该融合算子，则需要参考《Ascend C算子开发》手册。

• aclnn单算子调用方式

  通过aclnn单算子调用示例如下：

  [object Object]