快捷方式

MultiheadAttention

class torch.nn.MultiheadAttention(embed_dim, num_heads, dropout=0.0, bias=True, add_bias_kv=False, add_zero_attn=False, kdim=None, vdim=None, batch_first=False, device=None, dtype=None)[source][source]

允许模型共同关注来自不同表示子空间的信息。

请参阅本教程,深入讨论 PyTorch 为构建您自己的 Transformer 层提供的性能构建块。

论文中描述的方法:Attention Is All You Need

多头注意力定义为

MultiHead(Q,K,V)=Concat(head1,,headh)WO\text{MultiHead}(Q, K, V) = \text{Concat}(\text{head}_1,\dots,\text{head}_h)W^O

其中 headi=Attention(QWiQ,KWiK,VWiV)\text{head}_i = \text{Attention}(QW_i^Q, KW_i^K, VW_i^V)

nn.MultiheadAttention 将尽可能使用 scaled_dot_product_attention() 的优化实现。

除了支持新的 scaled_dot_product_attention() 函数以加速推理外,MHA 还将使用快速路径推理,并支持嵌套张量,如果满足以下条件:

  • 正在计算自注意力(即,querykeyvalue 是相同的张量)。

  • 输入是批处理的 (3D),且 batch_first==True

  • 自动微分已禁用(使用 torch.inference_modetorch.no_grad),或者没有张量参数 requires_grad

  • 训练已禁用(使用 .eval()

  • add_bias_kvFalse

  • add_zero_attnFalse

  • kdimvdim 等于 embed_dim

  • 如果传递了 NestedTensor,则不传递 key_padding_maskattn_mask

  • 自动类型转换已禁用

如果正在使用优化的推理快速路径实现,则可以为 query/key/value 传递 NestedTensor,以比使用填充掩码更有效地表示填充。在这种情况下,将返回 NestedTensor,并且可以预期额外的加速与输入中填充部分的比例成正比。

参数
  • embed_dim – 模型的总维度。

  • num_heads – 并行注意力头的数量。请注意,embed_dim 将在 num_heads 之间拆分(即,每个头的维度为 embed_dim // num_heads)。

  • dropoutattn_output_weights 上的 dropout 概率。默认值:0.0(无 dropout)。

  • bias – 如果指定,则向输入/输出投影层添加偏置。默认值:True

  • add_bias_kv – 如果指定,则向 dim=0 处的键和值序列添加偏置。默认值:False

  • add_zero_attn – 如果指定,则向 dim=1 处的键和值序列添加新的零批次。默认值:False

  • kdim – 键的特征总数。默认值:None(使用 kdim=embed_dim)。

  • vdim – 值的特征总数。默认值:None(使用 vdim=embed_dim)。

  • batch_first – 如果为 True,则输入和输出张量以 (batch, seq, feature) 形式提供。默认值:False (seq, batch, feature)。

示例

>>> multihead_attn = nn.MultiheadAttention(embed_dim, num_heads)
>>> attn_output, attn_output_weights = multihead_attn(query, key, value)
forward(query, key, value, key_padding_mask=None, need_weights=True, attn_mask=None, average_attn_weights=True, is_causal=False)[source][source]

使用查询、键和值嵌入计算注意力输出。

支持填充、掩码和注意力权重的可选参数。

参数
  • query (Tensor) – 查询嵌入,形状为 (L,Eq)(L, E_q),用于非批处理输入;当 batch_first=False 时为 (L,N,Eq)(L, N, E_q);当 batch_first=True 时为 (N,L,Eq)(N, L, E_q),其中 LL 是目标序列长度,NN 是批大小,EqE_q 是查询嵌入维度 embed_dim。查询与键值对进行比较以生成输出。有关更多详细信息,请参阅“Attention Is All You Need”。

  • key (Tensor) – 键嵌入,形状为 (S,Ek)(S, E_k),用于非批处理输入;当 batch_first=False 时为 (S,N,Ek)(S, N, E_k);当 batch_first=True 时为 (N,S,Ek)(N, S, E_k),其中 SS 是源序列长度,NN 是批大小,EkE_k 是键嵌入维度 kdim。有关更多详细信息,请参阅“Attention Is All You Need”。

  • value (Tensor) – 值嵌入,形状为 (S,Ev)(S, E_v),用于非批处理输入;当 batch_first=False 时为 (S,N,Ev)(S, N, E_v);当 batch_first=True 时为 (N,S,Ev)(N, S, E_v),其中 SS 是源序列长度,NN 是批大小,EvE_v 是值嵌入维度 vdim。有关更多详细信息,请参阅“Attention Is All You Need”。

  • key_padding_mask (Optional[Tensor]) – 如果指定,则为形状为 (N,S)(N, S) 的掩码,指示要忽略 key 中哪些元素以进行注意力计算(即视为“填充”)。对于未批处理的 query,形状应为 (S)(S)。支持二进制和浮点掩码。对于二进制掩码,True 值表示相应的 key 值将被忽略以进行注意力计算。对于浮点掩码,它将直接添加到相应的 key 值。

  • need_weights (bool) – 如果指定,则除了 attn_outputs 之外,还会返回 attn_output_weights。设置 need_weights=False 以使用优化的 scaled_dot_product_attention 并为 MHA 实现最佳性能。默认值:True

  • attn_mask (Optional[Tensor]) – 如果指定,则为阻止关注某些位置的 2D 或 3D 掩码。 形状必须为 (L,S)(L, S)(Nnum_heads,L,S)(N\cdot\text{num\_heads}, L, S),其中 NN 是批大小,LL 是目标序列长度,SS 是源序列长度。 2D 掩码将在批次中广播,而 3D 掩码允许批次中每个条目使用不同的掩码。 支持二进制和浮点掩码。 对于二进制掩码,True 值表示不允许关注相应位置。 对于浮点掩码,掩码值将添加到注意力权重中。 如果同时提供 attn_mask 和 key_padding_mask,则它们的类型应匹配。

  • average_attn_weights (bool) – 如果为 true,则表示返回的 attn_weights 应在 head 之间平均。 否则,attn_weights 将按 head 单独提供。 请注意,此标志仅在 need_weights=True 时有效。 默认值:True(即,跨 head 平均权重)

  • is_causal (bool) – 如果指定,则应用因果掩码作为注意力掩码。 默认值:False。 警告:is_causal 提供了一个提示,表明 attn_mask 是因果掩码。 提供不正确的提示可能会导致执行不正确,包括向前和向后兼容性。

返回类型

Tuple[Tensor, Optional[Tensor]]

输出
  • attn_output - 注意力输出,当输入未批处理时,形状为 (L,E)(L, E),当 batch_first=False 时,形状为 (L,N,E)(L, N, E),或者当 batch_first=True 时,形状为 (N,L,E)(N, L, E),其中 LL 是目标序列长度,NN 是批大小,EE 是嵌入维度 embed_dim

  • attn_output_weights - 仅当 need_weights=True 时返回。 如果 average_attn_weights=True,则返回跨 head 平均的注意力权重,当输入未批处理时,形状为 (L,S)(L, S),或者形状为 (N,L,S)(N, L, S),其中 NN 是批大小,LL 是目标序列长度,SS 是源序列长度。 如果 average_attn_weights=False,则返回每个 head 的注意力权重,当输入未批处理时,形状为 (num_heads,L,S)(\text{num\_heads}, L, S),或者形状为 (N,num_heads,L,S)(N, \text{num\_heads}, L, S)

对于未批处理的输入,将忽略 batch_first 参数。

merge_masks(attn_mask, key_padding_mask, query)[source][source]

确定掩码类型并在必要时组合掩码。

如果仅提供一个掩码,则将返回该掩码和相应的掩码类型。 如果同时提供了两个掩码,则它们都将扩展到形状 (batch_size, num_heads, seq_len, seq_len),与逻辑 or 组合,并返回掩码类型 2 :param attn_mask: 形状为 (seq_len, seq_len) 的注意力掩码,掩码类型 0 :param key_padding_mask: 形状为 (batch_size, seq_len) 的填充掩码,掩码类型 1 :param query: 形状为 (batch_size, seq_len, embed_dim) 的查询嵌入

返回

merged mask mask_type: 合并的掩码类型 (0, 1, 或 2)

返回类型

merged_mask

文档

访问 PyTorch 的综合开发者文档

查看文档

教程

获取面向初学者和高级开发者的深入教程

查看教程

资源

查找开发资源并获得您的问题解答

查看资源