Transformer¶

class torch.nn.Transformer(d_model=512, nhead=8, num_encoder_layers=6, num_decoder_layers=6, dim_feedforward=2048, dropout=0.1, activation=<function relu>, custom_encoder=None, custom_decoder=None, layer_norm_eps=1e-05, batch_first=False, norm_first=False, bias=True, device=None, dtype=None)[source][source]¶

一个 Transformer 模型。

注意

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

用户可以根据需要修改属性。该架构基于论文 “Attention Is All You Need”。Ashish Vaswani, Noam Shazeer, Niki Parmar, Jakob Uszkoreit, Llion Jones, Aidan N Gomez, Lukasz Kaiser, 和 Illia Polosukhin. 2017. Attention is all you need. In Advances in Neural Information Processing Systems, pages 6000-6010.

参数

d_model (int) – 编码器/解码器输入中预期特征的数量 (默认=512)。
nhead (int) – 多头注意力模型中的头数 (默认=8)。
num_encoder_layers (int) – 编码器中子编码器层的数量 (默认=6)。
num_decoder_layers (int) – 解码器中子解码器层的数量 (默认=6)。
dim_feedforward (int) – 前馈网络模型的维度 (默认=2048)。
dropout (float) – dropout 值 (默认=0.1)。
activation (Union[str, Callable[[Tensor], Tensor]]) – 编码器/解码器中间层的激活函数，可以是字符串 (“relu” 或 “gelu”) 或一元可调用对象。默认值：relu
custom_encoder (Optional[Any]) – 自定义编码器 (默认=None)。
custom_decoder (Optional[Any]) – 自定义解码器 (默认=None)。
layer_norm_eps (float) – 层归一化组件中的 eps 值 (默认=1e-5)。
batch_first (bool) – 如果为 True，则输入和输出张量以 (batch, seq, feature) 形式提供。默认值：False (seq, batch, feature)。
norm_first (bool) – 如果为 True，编码器和解码器层将在其他注意力机制和前馈操作之前执行 LayerNorms，否则在之后执行。默认值：False (之后)。
bias (bool) – 如果设置为 False，Linear 和 LayerNorm 层将不会学习加性偏置。默认值：True。

示例：

>>> transformer_model = nn.Transformer(nhead=16, num_encoder_layers=12)
>>> src = torch.rand((10, 32, 512))
>>> tgt = torch.rand((20, 32, 512))
>>> out = transformer_model(src, tgt)

注意：有关应用 nn.Transformer 模块进行词语语言模型的完整示例，请参阅 https://github.com/pytorch/examples/tree/master/word_language_model

forward(src, tgt, src_mask=None, tgt_mask=None, memory_mask=None, src_key_padding_mask=None, tgt_key_padding_mask=None, memory_key_padding_mask=None, src_is_causal=None, tgt_is_causal=None, memory_is_causal=False)[source][source]¶

接收并处理带掩码的源/目标序列。

注意

如果为任何 [src/tgt/memory]_mask 参数提供了布尔张量，则 True 值的位置不允许参与注意力机制，这与 torch.nn.functional.scaled_dot_product_attention() 中的 attn_mask 的定义相反。

参数

src (Tensor) – 到编码器的序列 (必需)。
tgt (Tensor) – 到解码器的序列 (必需)。
src_mask (Optional[Tensor]) – src 序列的加性掩码 (可选)。
tgt_mask (Optional[Tensor]) – tgt 序列的加性掩码 (可选)。
memory_mask (Optional[Tensor]) – 编码器输出的加性掩码 (可选)。
src_key_padding_mask (Optional[Tensor]) – 每个批次 src 键的张量掩码 (可选)。
tgt_key_padding_mask (Optional[Tensor]) – 每个批次 tgt 键的张量掩码 (可选)。
memory_key_padding_mask (Optional[Tensor]) – 每个批次 memory 键的张量掩码 (可选)。
src_is_causal (Optional[bool]) – 如果指定，则应用因果掩码作为 src_mask。默认值：None；尝试检测因果掩码。警告：src_is_causal 提供了一个提示，表明 src_mask 是因果掩码。提供不正确的提示可能会导致不正确的执行，包括向前和向后兼容性。
tgt_is_causal (Optional[bool]) – 如果指定，则应用因果掩码作为 tgt_mask。默认值：None；尝试检测因果掩码。警告：tgt_is_causal 提供了一个提示，表明 tgt_mask 是因果掩码。提供不正确的提示可能会导致不正确的执行，包括向前和向后兼容性。
memory_is_causal (bool) – 如果指定，则应用因果掩码作为 memory_mask。默认值：False。警告：memory_is_causal 提供了一个提示，表明 memory_mask 是因果掩码。提供不正确的提示可能会导致不正确的执行，包括向前和向后兼容性。

返回类型

Tensor

形状

src：对于非批处理输入，为 $(S, E)$ ；如果 batch_first=False，则为 $(S, N, E)$ ；如果 batch_first=True，则为 (N, S, E)。
tgt：对于非批处理输入，为 $(T, E)$ ；如果 batch_first=False，则为 $(T, N, E)$ ；如果 batch_first=True，则为 (N, T, E)。
src_mask： $(S, S)$ 或 $(N\cdot\text{num\_heads}, S, S)$ 。
tgt_mask： $(T, T)$ 或 $(N\cdot\text{num\_heads}, T, T)$ 。
memory_mask： $(T, S)$ 。
src_key_padding_mask：对于非批处理输入，为 $(S)$ ；否则为 $(N, S)$ 。
tgt_key_padding_mask：对于非批处理输入，为 $(T)$ ；否则为 $(N, T)$ 。
memory_key_padding_mask：对于非批处理输入，为 $(S)$ ；否则为 $(N, S)$ 。

注意：[src/tgt/memory]_mask 确保位置 $i$ 允许关注未掩码的位置。如果提供 BoolTensor，则 True 值的位置不允许关注，而 False 值的位置将保持不变。如果提供 FloatTensor，则会将其添加到注意力权重中。[src/tgt/memory]_key_padding_mask 提供指定的键元素，以便注意力机制忽略。如果提供 BoolTensor，则值为 True 的位置将被忽略，而值为 False 的位置将保持不变。

输出：对于非批处理输入，为 $(T, E)$ ；如果 batch_first=False，则为 $(T, N, E)$ ；如果 batch_first=True，则为 (N, T, E)。

注意：由于 Transformer 模型中的多头注意力架构，Transformer 的输出序列长度与解码器的输入序列（即目标序列）长度相同。

其中 $S$ 是源序列长度， $T$ 是目标序列长度， $N$ 是批大小， $E$ 是特征数量

示例

>>> output = transformer_model(src, tgt, src_mask=src_mask, tgt_mask=tgt_mask)

static generate_square_subsequent_mask(sz, device=None, dtype=None)[source][source]¶

为序列生成方形因果掩码。

掩码位置填充为 float(‘-inf’)。未掩码位置填充为 float(0.0)。

返回类型: Tensor

Transformer¶

文档

教程

资源