mindspore.nn.MultiheadAttention

class mindspore.nn.MultiheadAttention(embed_dim, num_heads, dropout=0.0, has_bias=True, add_bias_kv=False, add_zero_attn=False, kdim=None, vdim=None, batch_first=False, dtype=mstype.float32)[源代码]

论文 Attention Is All You Need 中描述了多头注意力的实现。给定query向量、key向量和value向量，注意力计算流程如下：

M u l t i H e a d A t t e n t i o n (q u e r y, k e y, v a l u e) = C o n c a t (h e a d_{1}, \dots, h e a d_{h}) W^{O}

其中， $h e a d_{i} = A t t e n t i o n (Q W_{i}^{Q}, K W_{i}^{K}, V W_{i}^{V})$ ， $W^{O}$ 、 $W_{i}^{Q}$ 、 $W_{i}^{K}$ 、 $W_{i}^{V}$ 是权重矩阵。注意：默认输入、输出投影层中带有偏置参数。

如果query、key和value相同，则上述即为自注意力机制的计算过程。

参数：

embed_dim (int) - 模型的总维数。
num_heads (int) - 并行注意力头的数量。num_heads 需要能够整除 embed_dim （每个头的维数为 embed_dim // num_heads ）。
dropout (float，可选) - 应用到输入 attn_output_weights 上的随机丢弃比例. 默认值： 0.0。
has_bias (bool，可选) - 是否给输入、输出投射层添加偏置。默认值： True。
add_bias_kv (bool，可选) - 是否给key、value序列的零维添加偏置。默认值： False。
add_zero_attn (bool，可选) - 是否给key、value序列的一维添加0。默认值： False。
kdim (int，可选) - key的总特征数。默认值： None （即 kdim=embed_dim）。
vdim (int，可选) - value的总特征数。默认值： None （即 vdim=embed_dim）。
batch_first (bool，可选) - 如果为 True，则输入输出Tensor的shape为 $(b a t c h, s e q, f e a t u r e)$ ，否则shape为 $(s e q, b a t c h, f e a t u r e)$ 。默认值： False 。
dtype (mindspore.dtype，可选) - Parameter的数据类型。默认值： mstype.float32 。

输入：

query (Tensor) - Query矩阵。当输入非Batch数据时，shape为： $(L, E_{q})$ 。当输入Batch数据，参数 batch_first=False 时，shape为 $(L, N, E_{q})$ ，当 batch_first=True 时，shape为 $(N, L, E_{q})$ 。其中， $L$ 为目标序列的长度， $N$ 为batch size， $E_{q}$ 为Query矩阵的维数 embed_dim。数据类型：float16、float32或者float64。注意力机制通过Query与Key-Value运算以生成最终输出。
key (Tensor) - Key矩阵。当输入非Batch数据时，shape为： $(S, E_{k})$ 。当输入Batch数据，参数 batch_first=False 时，shape为 $(S, N, E_{k})$ ，当 batch_first=True 时，shape为 $(N, S, E_{k})$ 。其中， $S$ 为源序列的长度， $N$ 为batch size， $E_{k}$ 为Key矩阵的维数 kdim。数据类型：float16、float32或者float64。
value (Tensor) - Value矩阵。当输入非Batch数据时，shape为： $(S, E_{v})$ 。当输入Batch数据，参数 batch_first=False 时，shape为 $(S, N, E_{v})$ ，当 batch_first=True 时，shape为 $(N, S, E_{v})$ 。其中， $S$ 为源序列的长度， $N$ 为batch size， $E_{v}$ 为Key矩阵的维数 vdim。数据类型：float16、float32或者float64。
key_padding_mask (Tensor, 可选) - 如果指定此值，则表示shape为 $(N, S)$ 的掩码将被用于 key。当输入非Batch数据时，shape为： $(S)$ 。支持Bool和float类型。如果输入Tensor为Bool类型，则 key 中对应为 True 的位置将在Attention计算时被忽略。如果输入Tensor为float类型，则将直接与 key 相加。float支持数据类型：float16、float32或者float64。默认值： None。
need_weights (bool，可选) - 是否需要返回 attn_output_weights，如果为 True，则输出包含 attn_output_weights。默认值： True。
attn_mask (Tensor, 可选) - 如果指定此值，则表示shape为 $(L, S)$ 或 $(N \cdot num_heads, L, S)$ 的掩码将被用于Attention计算。其中 $N$ 为batch size， $L$ 为目标序列长度， $S$ 为源序列长度。如果输入为二维矩阵，则将自动沿batch维广播至三维矩阵。若为三维矩阵，则允许沿batch维使用不同的掩码。如果输入Tensor为Bool类型，则值为 True 对应位置允许被注意力计算。如果输入Tensor为float类型，则将直接与注意力权重相加。float支持数据类型：float16、float32或者float64。默认值： None。
average_attn_weights (bool，可选) - 如果为 True，则返回值 attn_weights 为注意力头的平均值。如果为 False，则 attn_weights 分别返回每个注意力头的值。本参数仅在 need_weights=True 时生效。默认值： True 。

输出：

Tuple，表示一个包含(attn_output, attn_output_weights)的元组。

attn_output - 注意力机制的输出。当输入非Batch数据时，shape为： $(L, E)$ 。当输入Batch数据，参数 batch_first=False 时，shape为 $(L, N, E)$ ，当 batch_first=True 时，shape为 $(N, L, E)$ 。其中， $L$ 为目标序列的长度， $N$ 为batch size， $E$ 为模型的总维数 embed_dim。
attn_output_weights - 仅当 need_weights=True 时返回。如果 average_attn_weights=True，则返回值 attn_weights 为注意力头的平均值。当输入非Batch数据时， shape为： $(L, S)$ ，当输入Batch数据时，shape为 $(N, L, S)$ 。其中 $N$ 为batch size， $L$ 为目标序列的长度， $S$ 为源序列长度。如果 average_attn_weights=False ，分别返回每个注意力头的值。当输入非Batch数据时，shape为： $(num_heads, L, S)$ ，当输入Batch数据时，shape为 $(N, num_heads, L, S)$ 。

异常：

ValueError - 如果 embed_dim 不能被 num_heads 整除。
TypeError - 如果 key_padding_mask 不是bool或float类型。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore as ms
>>> import numpy as np
>>> embed_dim, num_heads = 128, 8
>>> seq_length, batch_size = 10, 8
>>> query = ms.Tensor(np.random.randn(seq_length, batch_size, embed_dim), ms.float32)
>>> key = ms.Tensor(np.random.randn(seq_length, batch_size, embed_dim), ms.float32)
>>> value = ms.Tensor(np.random.randn(seq_length, batch_size, embed_dim), ms.float32)
>>> multihead_attn = ms.nn.MultiheadAttention(embed_dim, num_heads)
>>> attn_output, attn_output_weights = multihead_attn(query, key, value)
>>> print(attn_output.shape)
(10, 8, 128)