aclnnFlashAttentionScoreGrad

支持的产品型号

Atlas A2训练系列产品。

接口原型

每个算子分为两段式接口，必须先调用“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 scaleValueOptional, double keepProbOptional, int64_t preTockensOptional, int64_t nextTockensOptional, 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 aclnnFlashAttentionScoreGrad(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

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

• 计算公式：

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

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

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

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

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

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

aclnnFlashAttentionGradGetWorkspaceSize

• 参数说明：

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

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

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

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

  • pseShiftOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入pse，可选参数，表示位置编码。数据类型支持 FLOAT16、BFLOAT16，数据格式支持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位置编码场景，preTockens和nextTockens必须配置下三角。后续章节如无特殊说明，S表示query或key、value的 sequence length, Sq表示query的sequence length, Skv表示key、value的sequence length, SS表示Sq*Skv。

  • dropMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，可选属性，数据类型支持UINT8(标识8个1bit BOOL)，数据格式支持ND。综合约束请见约束与限制。

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

  • attenMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，可选属性，代表下三角全为0上三角全为负无穷的倒三角mask矩阵，数据类型支持BOOL(8bit的BOOL)、UINT8，数据格式支持ND，支持shape范围为[B,N,S,S]、[B,1,S,S]、[1,1,S,S]、[S,S]。综合约束请见约束与限制。

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

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

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

  • attentionInOptional（aclTensor*，计算输入）：Device侧的aclTensor，注意力正向计算的最终输出，数据类型支持FLOAT16、BFLOAT16，数据格式支持ND。综合约束请见约束与限制。

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

  • dqOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的dQ，表示query的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16，数据格式支持ND。综合约束请见约束与限制。

  • dkOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的dK，表示keyIn的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16，数据格式支持ND。综合约束请见约束与限制。

  • dvOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的dV，表示value的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16，数据格式支持ND。综合约束请见约束与限制。

  • dpseOut（aclTensor*，计算输出）：Device侧的aclTensor，公式中的d(pse)，表示pse的梯度，计算输出，数据类型支持FLOAT16、BFLOAT16，数据格式支持ND，预留参数暂未使用。

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

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

  • preTockensOptional（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算的参数，可选参数，数据类型支持INT64。综合约束请见约束与限制。

  • nextTockensOptional（int64_t，计算输入）：Host侧的int64_t，用于稀疏计算的参数，可选参数，数据类型支持INT64。综合约束请见约束与限制。

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

  • inputLayout（string*，计算输入）：Host侧的string，代表输入query、keyIn、value的数据排布格式，支持BSH、SBH、BSND、BNSD、TND。综合约束请见约束与限制。

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

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

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

    • sparseModeOptional为0时，代表defaultMask模式，如果attenMaskOptional未传入则不做mask操作，忽略preTockensOptional和nextTockensOptional(内部赋值为INT_MAX)；如果传入，则需要传入完整的attenMaskOptional矩阵（S1 * S2），表示preTockensOptional和nextTockensOptional之间的部分需要计算。
    • sparseModeOptional为1时，代表allMask，即传入完整的attenMaskOptional矩阵。
    • sparseModeOptional为2时，代表leftUpCausal模式的mask，对应以左顶点为划分的下三角场景，需要传入优化后的attenMaskOptional矩阵（2048*2048）。
    • sparseModeOptional为3时，代表rightDownCausal模式的mask，对应以右下顶点为划分的下三角场景，需要传入优化后的attenMaskOptional矩阵（2048*2048）。
    • sparseModeOptional为4时，代表band场景，即计算preTockensOptional和nextTockensOptional之间的部分。
    • sparseModeOptional为5时，代表prefix场景，即在rightDownCasual的基础上，左侧加上一个长为S1，宽为N的矩阵，N的值由输入prefixOptional获取，每个Batch对应一个PrefixN值。该场景下，attenMask的shape类型不支持[1,1,S,S]、[S,S]。
    • sparseModeOptional为6时，代表prefix压缩场景，需要传入shape为[3072, 2048]的attenMaskOptional矩阵；分为两部分：[2048, 2048]的下三角矩阵；[1024, 2048]的矩阵，左半部分全0，右半部分全1。
    • sparseModeOptional为7时，代表rightDownCausal_Band场景，该场景由长序列外切产生，需要正确配置preTockensOptional和nextTockensOptional参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。
    • sparseModeOptional为8时，代表band_LeftUpCausal场景，该场景由长序列外切产生，需要正确配置preTockensOptional和nextTockensOptional参数；传入shape为[2048, 2048]的下三角attenMaskOptional矩阵。

    用户不特意指定时可传入默认值0。

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

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

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

• 返回值：

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

  说明： 第一段接口完成入参校验，若出现以下错误码，则对应原因为：

  • 返回161001（ACLNN_ERR_PARAM_NULLPTR）：如果传入参数是必选输入，输出或者必选属性，且是空指针，则返回161001。
  • 返回161002（ACLNN_ERR_PARAM_INVALID）：query、keyIn、value、dy、pseShiftOptional、dropMaskOptional、paddingMaskOptional、attenMaskOptional、softmaxMaxOptional、softmaxSumOptional、softmaxInOptional、attentionInOptional、dqOut、dkOut、dvOut的数据类型和数据格式不在支持的范围内。

aclnnFlashAttentionScoreGrad

• 参数说明：

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

• 返回值：

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

约束与限制

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

• 关于数据shape的约束，以inputLayout的BSND、BNSD为例（BSH、SBH下H=N*D），其中：

  • B：取值范围为1~2K。
  • N：取值范围为1~256，支持N不等长。
  • S：取值范围为1~512K，支持S不等长。
  • D：取值范围为1~512。
  • KeepProb: 取值范围为0~1.

• prefix场景，即sparse_mode=5 或者 sparse_mode=6，batch数不超过32。

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

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

• band场景，preTockensOptional和nextTockensOptional之间必须要有交集。

调用示例