昇腾社区首页
中文
注册
开发者
下载
支持
积分兑换 NEW

FlashAttentionVarLenScoreV2

支持的产品型号

Atlas A2 训练系列产品

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

功能描述

  • 算子功能：训练场景下，使用FlashAttention算法实现self-attention（自注意力）的计算。跟的区别是该接口支持可变长S的计算，即可以一次传入多个长度不相等的sequence。使用此接口时，query，key和value使用TND的格式传入数据，其中T意为total number，表示其所有sequence的length总和，同时使用actualSeqQLenOptional与actualSeqKvLenOptional输入传入每个sequence依次的累积长度以区分不同sequence。每个sequence单独计算其注意力结果。

  • 计算公式：

    注意力的正向计算公式如下：

    • psetype=1时，与计算公式相同。

    • psetype=其他取值时，公式如下：

      attentionout=Dropout(Softmax(Mask(scale∗(query∗keyT)+pse),attenmask),keepprob)∗valueattention\\_out=Dropout(Softmax(Mask(scale*(query*key^T) + pse),atten\\_mask),keep\\_prob)*value

算子执行接口

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

  • aclnnStatus aclnnFlashAttentionVarLenScoreV2GetWorkspaceSize(const aclTensor *query,const aclTensor *key,const aclTensor *value,const aclTensor *realShiftOptional,const aclTensor *dropMaskOptional,const aclTensor *paddingMaskOptional,const aclTensor *attenMaskOptional,const aclIntArray *prefixOptional,const aclIntArray *actualSeqQLenOptional,const aclIntArray *actualSeqKvLenOptional,const aclIntArray *qStartIdxOptional,const aclIntArray *kvStartIdxOptional,double scaleValueOptional,double keepProbOptional,int64_t preTokensOptional,int64_t nextTokensOptional,int64_t headNum,char *inputLayout,int64_t innerPreciseOptional,int64_t sparseModeOptional,int64_t pseTypeOptional,const aclTensor *softmaxMaxOut,const aclTensor *softmaxSumOut,const aclTensor *softmaxOutOut,const aclTensor *attentionOutOut,uint64_t *workspaceSize,aclOpExecutor **executor)
  • aclnnStatus aclnnFlashAttentionVarLenScoreV2(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)

说明：

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

aclnnFlashAttentionVarLenScoreV2GetWorkspaceSize

  • 参数说明：

    • query（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型与key/value的数据类型一致，支持ND；综合约束请见。

    • key（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型与query/value的数据类型一致，支持ND；综合约束请见。

    • value（aclTensor*，计算输入）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型与query/key的数据类型一致，支持ND；综合约束请见。

    • realShiftOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的输入pse，可选参数，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型与query的数据类型一致，支持ND；varlen场景为多个batch的pse连续内存排布，其中sq表示每个batch上query的sequence length，skv表示每个batch上key、value的sequence length。每个batch的Sq与Skv等长且是sparseModeOptional为0、2、3的下三角掩码场景，可使能alibi位置编码压缩，此时只需要输入原始PSE最后1024行进行内存优化，即alibi_compress = ori_pse[:, :, -1024:, :]，参数每个batch不相同时，输入BNHSkv(H=1024)，每个batch相同时，输入1NHSkv(H=1024)。后续章节如无特殊说明，S表示query或key、value的sequence length，Sq表示query的sequence length，Skv表示key、value的sequence length，SS表示Sq*Skv。如果psetype为2或3的时候，数据类型需为FLOAT32, 对应shape支持范围是[B,N],[N]。

    • dropMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的dropout，可选参数，数据类型支持UINT8（标识8个1bit BOOL），支持ND。

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

    • attenMaskOptional（aclTensor*，计算输入）：Device侧的aclTensor，公式中的mask，可选参数，数据类型支持BOOL、UINT8，支持ND，输入shape类型需为[maxSq,maxSkv]。

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

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

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

    • qStartIdxOptional（aclIntArray*，计算输入）：Host侧的aclIntArray，可选参数，数据类型支持INT64，代表外切场景，当前分块的query的sequence在全局中的起始索引，默认值为0，支持ND；综合约束请见。

    • kvStartIdxOptional（aclIntArray*，计算输入）：Host侧的aclIntArray，可选参数，数据类型支持INT64，代表外切场景，当前分块的query的sequence在全局中的起始索引，默认值为0，支持ND；综合约束请见。

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

    • keepProbOptional（double，计算输入）：Host侧的double，数据类型支持DOUBLE，代表dropMaskOptional中1的比例。

    • preTockensOptional（int64_t，计算输入）：Host侧的int64_t，数据类型支持INT64，用于稀疏计算 ，表示slides window的左边界；综合约束请见。

    • nextTockensOptional（int64_t，计算输入）：Host侧的int64_t，数据类型支持INT64，用于稀疏计算，表示slides window的右边界；综合约束请见。

    • headNum（int64_t，计算输入）：Host侧的int64_t，数据类型支持INT64，代表单卡的head个数。

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

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

    • innerPreciseOptional（int64_t，计算输入）：Host侧的int64_t，数据类型支持INT64，用于提升精度，默认配置为0即可。

      说明： 当前0、1为保留配置值，当计算过程中存在整行mask进而导致精度有损失时，可以尝试将该参数配置为2以提升精度，但是该配置会导致性能下降。

    • sparseModeOptional（int64_t，计算输入）：Host侧的int64_t。数据类型支持：INT64。用户不特意指定时可传入默认值：0，支持配置值为0、1、2、3、4、6、7、8。当整网的attenMaskOptional都相同且shape小于2048*2048时，建议使用defaultMask模式，来减少内存使用量；sparse不同模式的详细说明请参见。

    • pseTypeOptional （int64_t，计算输入）：Host侧的int64_t，数据类型支持INT64，可选参数，用户不特意指定时可传入1，跟当前实现一致，支持配置值为0、1、2、3。

      pseType 含义 备注
      0 外部传入pse 先mul再add -
      1 外部传入pse 先add再mul 跟实现一致
      2 内部生成pse 先mul再add -
      3 内部生成pse 先mul再add再sqrt -

    • softmaxMaxOut（aclTensor*，计算输出）：Device侧的aclTensor，数据类型支持FLOAT，支持ND。

    • softmaxSumOut（aclTensor*，计算输出）：Device侧的aclTensor，数据类型支持FLOAT，支持ND。

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

    • attentionOutOut（aclTensor*，计算输出）：Device侧的aclTensor，数据类型支持FLOAT16、BFLOAT16、FLOAT32，数据类型query的数据类型一致，支持ND。

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

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

  • 返回值：

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

    [object Object]

aclnnFlashAttentionVarLenScoreV2

  • 参数说明：

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

  • 返回值：

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

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

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

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

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

  • 输入key/value的shape必须一致。

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

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

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

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

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

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

  • attenMaskOptional输入不支持补pad，即attenMaskOptional中不能存在某一行全1的场景。

  • 支持actualSeqQLenOptional中某个Batch上的S长度为0；如果存在S为0的情况，不支持pse输入， 假设真实的S长度为[2,2,0,2,2]，则传入的actualSeqQLenOptional为[2,4,4,6,8]。不支持某个batch中Sq不为0，但是Skv为0的场景。

算子原型

[object Object]

参数解释请参见算子执行接口。

调用示例

该融合算子有两种调用方式：

  • PyTorch框架调用

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

  • aclnn单算子调用方式

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

    [object Object]