TransformerEncoderLayer#

class torch.nn.TransformerEncoderLayer(d_model, nhead, dim_feedforward=2048, dropout=0.1, activation=<function relu>, layer_norm_eps=1e-05, batch_first=False, norm_first=False, bias=True, device=None, dtype=None)[source]#

TransformerEncoderLayer 由自注意力机制和前馈网络组成。

此 TransformerEncoderLayer 实现《Attention Is All You Need》论文中描述的原始架构。该层的目的是作为基础理解的参考实现，因此它包含的功能相对于较新的 Transformer 架构而言有限。考虑到 Transformer 类架构的快速创新步伐，我们建议通过此教程从核心的构建块构建高效层，或者使用 PyTorch 生态系统的更高级库。

TransformerEncoderLayer 可以处理传统的 torch.tensor 输入或 Nested Tensor 输入。派生类也应接受这两种输入格式。（Nested Tensor 尚处于原型状态，TransformerEncoderLayer 目前并非支持所有输入组合。）

如果您正在实现自定义层，可以从 Module 或 TransformerEncoderLayer 类派生。如果您的自定义层同时支持 torch.Tensors 和 Nested Tensors 输入，则将其实现作为 TransformerEncoderLayer 的派生类。如果您的自定义层仅支持 torch.Tensor 输入，则将其实现从 Module 派生。

参数

d_model (int) – 输入中预期的特征数量（必需）。
nhead (int) – 多头注意力模型中的头数（必需）。
dim_feedforward (int) – 前馈网络模型的维度（默认值：2048）。
dropout (float) – dropout值（默认值：0.1）。
activation (Union[str, Callable[[Tensor], Tensor]]) – 中间层的激活函数，可以是字符串（“relu” 或 “gelu”）或一元可调用对象。默认值：relu
layer_norm_eps (float) – 层归一化组件中的eps值（默认值：1e-5）。
batch_first (bool) – 如果为 True，则输入和输出张量按 (batch, seq, feature) 提供。默认值：False (seq, batch, feature)。
norm_first (bool) – 如果为 True，则层归一化分别在注意力机制和前馈操作之前完成。否则，在之后完成。默认值：False（之后）。
bias (bool) – 如果设置为 False，则 Linear 和 LayerNorm 层将不学习加性偏置。默认值：True。

示例

>>> encoder_layer = nn.TransformerEncoderLayer(d_model=512, nhead=8)
>>> src = torch.rand(10, 32, 512)
>>> out = encoder_layer(src)

或者，当 batch_first 为 True 时

>>> encoder_layer = nn.TransformerEncoderLayer(
...     d_model=512, nhead=8, batch_first=True
... )
>>> src = torch.rand(32, 10, 512)
>>> out = encoder_layer(src)

快速路径

如果满足以下所有条件，则 forward() 将使用 FlashAttention: Fast and Memory-Efficient Exact Attention with IO-Awareness 中描述的特殊优化实现：

autograd 被禁用（使用 torch.inference_mode 或 torch.no_grad）或没有张量参数 requires_grad
training 被禁用（使用 .eval()）
batch_first 为 True 且输入已分批（即 src.dim() == 3）
activation 是以下之一："relu"、"gelu"、torch.functional.relu 或 torch.functional.gelu
最多传递 src_mask 和 src_key_padding_mask 中的一个
如果 src 是 NestedTensor，则不传递 src_mask 和 src_key_padding_mask
两个 LayerNorm 实例具有一致的 eps 值（除非调用者在未修改另一个的情况下手动修改了一个，否则这将自然成立）

如果使用了优化实现，可以将 NestedTensor 传递给 src，以比 padding mask 更有效地表示 padding。在这种情况下，将返回一个 NestedTensor，并且可以预期相对于输入 padding 部分有额外的提速。

forward(src, src_mask=None, src_key_padding_mask=None, is_causal=False)[source]#

将输入通过编码器层。

参数

src (Tensor) – 编码器层的序列（必需）。
src_mask (Optional[Tensor]) – src 序列的掩码（可选）。
src_key_padding_mask (Optional[Tensor]) – src 键的每批掩码（可选）。
is_causal (bool) – 如果指定，则将因果掩码作为 src mask 应用。默认值：False。警告：is_causal 提供了一个提示，即 src_mask 是因果掩码。提供不正确的提示可能导致执行不正确，包括前向和后向兼容性问题。

返回类型

张量

形状: 请参阅Transformer中的文档。

TransformerEncoderLayer#

文档

教程

资源