变换器 ¶

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 层。

用户可以根据需要修改属性。该架构基于论文《Attention Is All You Need》。

参数:

d_model (int) – 编码器/解码器输入中期望的特征数量（默认=512）。
nhead（整数）- 多头注意力模型中的头数（默认=8）。
num_encoder_layers（整数）- 编码器中的子编码器层数（默认=6）。
num_decoder_layers（整数）- 解码器中的子解码器层数（默认=6）。
dim_feedforward（整数）- 前馈网络模型的维度（默认=2048）。
dropout (浮点数) – 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 (浮点数) – 层归一化组件中的 eps 值（默认=1e-5）。
batch_first (布尔值) – 如果 True ，则输入和输出张量以（batch，seq，feature）的形式提供。默认： False （seq，batch，feature）。
norm_first (布尔值) – 如果 True ，编码器和解码器层将在其他注意力和前馈操作之前执行 LayerNorms，否则之后。默认： False （之后）。
bias (布尔值) – 如果设置为 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)

注意：在 https://github.com/pytorch/examples/tree/master/word_language_model 中提供了一个完整的示例，用于应用 nn.Transformer 模块进行单词语言模型。

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（可选[Tensor]）- 编码器输出的加性掩码（可选）。
src_key_padding_mask（可选[Tensor]）- 每个批次的 src 键的 Tensor 掩码（可选）。
tgt_key_padding_mask（可选[Tensor]）- 每个批次的 tgt 键的 Tensor 掩码（可选）。
memory_key_padding_mask（可选[Tensor]）- 每个批次的内存键的 Tensor 掩码（可选）。
src_is_causal（可选[bool]）- 如果指定，则应用因果掩码为 src_mask 。默认： None ；尝试检测因果掩码。警告： src_is_causal 提供提示， src_mask 是因果掩码。提供错误的提示可能导致执行错误，包括向前和向后兼容性。
tgt_is_causal（可选[bool]）- 如果指定，则应用因果掩码为 tgt_mask 。默认： None ；尝试检测因果掩码。警告： tgt_is_causal 提供提示， tgt_mask 是因果掩码。提供错误的提示可能导致执行错误，包括向前和向后兼容性。
memory_is_causal（bool）- 如果指定，则应用因果掩码为 memory_mask 。默认： False 。警告： memory_is_causal 提供提示， memory_mask 是因果掩码。提供错误的提示可能导致执行错误，包括向前和向后兼容性。

返回类型:

张量

形状：

src: $(S, E)$ 用于非批处理输入， $(S, N, E)$ 如果 batch_first=False 或 (N, S, E) 如果 batch_first=True。
tgt: $(T, E)$ 对于非批处理输入， $(T, N, E)$ 如果 batch_first=False 或（N，T，E）如果 batch_first=True。
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)$ 对于非批处理输入， $(T, N, E)$ 如果 batch_first=False 或 (N, T, E) 如果 batch_first=True。

注意：由于 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)。

返回类型:: 张量

变换器 ¶

文档

教程

资源