FlashAttentionScoreV2
支持的产品型号
Atlas A2 训练系列产品
功能描述
算子执行接口
每个算子分为，必须先调用“aclnnFlashAttentionScoreV2GetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnFlashAttentionScoreV2”接口执行计算。
aclnnStatus aclnnFlashAttentionScoreV2GetWorkspaceSize(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 *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 aclnnFlashAttentionScoreV2(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream)
说明：
- 算子执行接口对外屏蔽了算子内部实现逻辑以及不同代际NPU的差异，且开发者无需编译算子，实现了算子的精简调用。
- 若开发者不使用算子执行接口的调用算子，也可以定义基于Ascend IR的算子描述文件，通过ATC工具编译获得算子om文件，然后加载模型文件执行算子，详细调用方法可参见《应用开发指南》的章节。
aclnnFlashAttentionScoreV2GetWorkspaceSize
参数说明：
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，输入shape类型需为[B,N,S,S]、[B,N,1,S]、[1,N,S,S]。如果Sq大于1024、每个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，公式中的atten_mask，可选参数，数据类型支持BOOL、UINT8，支持ND，输入shape类型需为[B,N,S,S]、[B,1,S,S]、[1,1,S,S]、[S,S]，varlen场景只支持SS格式，SS分别是maxSq和maxSkv；综合约束请见。
prefixOptional（aclIntArray*，计算输入）：Host侧的aclIntArray，可选参数，数据类型支持INT64，代表prefix稀疏计算场景每个Batch的N值，支持ND；综合约束请见。
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的数据排布格式，支持BSH、SBH、BSND、BNSD。
说明： 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为3，Sq > Skv场景。
sparseModeOptional（int64_t，计算输入）：Host侧的int64_t。数据类型支持：INT64。用户不特意指定时可传入默认值：0，支持配置值为0、1、2、3、4、5、6。当整网的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执行器，包含了算子计算流程。
返回值：
[object Object]
aclnnFlashAttentionScoreV2
参数说明：
- workspace（void*，入参）：在Device侧申请的workspace内存地址。
- workspaceSize（uint64_t，入参）：在Device侧申请的workspace大小，由第一段接口aclnnFlashAttentionScoreV2GetWorkspaceSize获取。
- executor（aclOpExecutor*，入参）：op执行器，包含了算子计算流程。
- stream（aclrtStream，入参）：指定执行任务的AscendCL stream流。
返回值：
约束与限制[object Object][object Object]
该接口与pytorch配合使用时，需要保证CANN相关包与PyTorch相关包的版本匹配。
输入query、key、value的B：batchsize必须相等。
输入query、key、value的input_layout必须一致。
输入key/value的shape必须一致。
关于数据shape的约束，以inputLayout的BSND、BNSD为例（BSH、SBH下H=N*D），其中：
- B：取值范围为1~2M。带prefixOptional的时候B最大支持2K。
- N：取值范围为1~256。
- S：取值范围为1~1M。
- D：取值范围为1~512。
keepProbOptional的取值范围为(0, 1]。
band场景，preTockensOptional和nextTockensOptional之间必须要有交集。
prefixOptional稀疏计算场景即sparseModeOptional=5或者sparseModeOptional=6，当Sq > Skv时，prefix的N值取值范围[0, Skv]，当Sq <= Skv时，prefix的N值取值范围[Skv-Sq, Skv]。
realShiftOptional Sq大于1024时如果配置BNHS、1NHS，需要Sq和Skv等长。
算子原型
参数解释请参见算子执行接口。
调用示例
该融合算子有两种调用方式：