aclnnFlashAttentionScoreGrad

产品支持情况

产品	是否支持
[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]	×
[object Object]Atlas A2 训练系列产品[object Object]	√
[object Object]Atlas 800I A2 推理产品[object Object]	×
A200I A2 Box 异构组件	×
[object Object]Atlas 200I/500 A2 推理产品[object Object]	×
[object Object]Atlas 推理系列产品[object Object]	×
[object Object]Atlas 训练系列产品[object Object]	×

功能说明

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

• 计算公式：

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

  $$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}}$$

函数原型

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

• aclnnStatus aclnnFlashAttentionScoreGradGetWorkspaceSize(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, double scaleValue, double keepProb, int64_t preTokens, int64_t nextTokens, int64_t headNum, char* inputLayout, int64_t innerPrecise, int64_t sparseMode, const aclTensor* dqOut, const aclTensor* dkOut, const aclTensor* dvOut, const aclTensor* dpseOut, uint64_t* workspaceSize, aclOpExecutor** executor)
• aclnnStatus aclnnFlashAttentionScoreGrad(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

aclnnFlashAttentionScoreGradGetWorkspaceSize

• 参数说明：

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

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

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

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

  • pseShiftOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入pse，表示位置编码。数据类型支持FLOAT16、BFLOAT16、FLOAT32，undefined支持ND，支持shape范围为[B,N,S,S]、[B,N,1,S]、[1,N,S,S]、[B,N,H,S]、[1,N,H,S]，H固定为1024。alibi位置编码场景，preTokens和nextTokens必须配置下三角,且Sq和Skv是等长的。后续章节如无特殊说明，S表示query或key、value的sequence length, Sq表示query的sequence length, Skv表示key、value的sequence length, SS表示Sq*Skv。

  • dropMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持UINT8，undefined支持ND，如不使用该参数，可传入nullptr。其shape和数据排布可表示为：

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

  • paddingMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，预留参数暂未使用。

  • attenMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，0代表保留，1代表掩掉的mask矩阵，数据类型支持BOOL(8bit的BOOL)、UINT8，undefined支持ND，支持shape范围为[B,N,S,S]、[B,1,S,S]、[1,1,S,S]、[S,S]。综合约束请见undefined。如不使用该参数，可传入nullptr。

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

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

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

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

  • prefixOptional（aclIntArray*，计算输入）：Device侧的aclTensor，代表prefix稀疏计算场景每个Batch的N值。数据类型支持INT64，undefined支持ND。综合约束请见undefined。如不使用该参数，可传入nullptr。

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

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

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

  • dpseOut（aclTensor*，计算输出）：保留参数，暂未使用。

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

  • keepProb（double，计算输入）：Host侧的double，代表dropMaskOptional中1的比例，数据类型支持DOUBLE。综合约束请见undefined。用户不特意指定时建议传入1.0。

  • preTokens（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算的参数，数据类型支持INT64。用户不特意指定时建议传入2147483647。

  • nextTokens（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算的参数，数据类型支持INT64。用户不特意指定时建议传入2147483647。

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

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

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

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

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

    • sparseMode为0时，代表defaultMask模式，如果attenMaskOptional未传入则不做mask操作，忽略preTokens和nextTokens(内部赋值为INT_MAX)；如果传入，则需要传入完整的attenMaskOptional矩阵（S1 * S2），表示preTokens和nextTokens之间的部分需要计算。

  • sparseMode为1时，代表allMask，即传入完整的attenMaskOptional矩阵。

    • sparseMode为2时，代表leftUpCausal模式的mask，对应以左顶点为划分的下三角场景，需要传入优化后的attenMaskOptional矩阵（2048*2048）。
    • sparseMode为3时，代表rightDownCausal模式的mask，对应以右下顶点为划分的下三角场景，需要传入优化后的attenMaskOptional矩阵（2048*2048）。
    • sparseMode为4时，代表band场景，即计算preTokens和nextTokens之间的部分。
    • sparseMode为5时，代表prefix场景，即在rightDownCausal的基础上，左侧加上一个长为S1，宽为N的矩阵，N的值由输入prefixOptional获取，每个Batch对应一个PrefixN值。该场景下，attenMask的shape类型不支持[1,1,S,S]、[S,S]。
    • sparseMode为6时，代表prefix压缩场景，需要传入shape为[3072, 2048]的attenMaskOptional矩阵；分为两部分：其中上半部分为[2048, 2048]的下三角矩阵；下半部分为[1024, 2048]的矩阵，矩形矩阵左半部分全0，右半部分全1。0代表保留，1代表掩掉。
    • sparseMode为7时，代表rightDownCausal_Band场景，该场景由长序列外切产生，需要正确配置preTokens和nextTokens参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。
    • sparseMode为8时，代表band_LeftUpCausal场景，该场景由长序列外切产生，需要正确配置preTokens和nextTokens参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。

    用户不特意指定时建议传入0。sparse不同模式的详细说明请参见undefined。

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

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

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

• 返回值：

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

  [object Object]

aclnnFlashAttentionScoreGrad

• 参数说明：

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

• 返回值：

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

约束说明

• 该接口与PyTorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。
• 输入query、key、value、dy的B：batchsize必须相等。
• 输入query、key、value的D：Head-Dim必须满足(qD == kD && kD >= vD)。
• 输入query、key、value、dy的input_layout必须一致。
• 输入query、key、value、pseShiftOptional的数据类型必须一致。
• 输入key/value的shape除D外必须一致，在query/key/value的D大小相同的情况下，query/dy的shape必须一致。
• 支持输入query/dy的N和key/value的N不相等，但必须成比例关系，即Nq/Nkv必须是非0整数，Nq取值范围1~256。
• 关于数据shape的约束，以inputLayout的BSND、BNSD为例（BSH、SBH下H=N*D），其中：
  • B：取值范围为1~2M。带prefixOptional的时候B最大支持2K。
  • N：取值范围为1~256。
  • S：取值范围为1~1M。
  • D：取值范围为1~768。
  • KeepProb: 取值范围为(0,1].
• 部分场景下，如果计算量过大可能会导致算子执行超时(aicore error类型报错，errorStr为：timeout or trap error)，此时建议做轴切分处理，注：这里的计算量会受B、S、N、D等参数的影响，值越大计算量越大。
• 关于softmaxMax与softmaxSum参数的约束：输入格式固定为[B, N, S, 8]；TND的输入格式除外，此时为[T, N, 8]，注：T=B*S。
• headNum的取值必须和传入的Query中的N值保持一致。
• band场景，preTokens和nextTokens之间必须要有交集。
• pseShiftOptional中的Sq在大于1024场景下，且此时shape取值为BNHS或1NHS时，需要满足Sq和Skv等长。
• prefixOptional稀疏计算场景，即sparseMode=5或者sparseMode=6，当Sq > Skv时，prefix的N值取值范围[0, Skv]，当Sq <= Skv时，prefix的N值取值范围[Skv-Sq, Skv]。

调用示例

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