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][source]¶

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

注意

有关 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》。《神经信息处理系统进展》，第 6000-6010 页。用户可以在应用期间修改或以不同的方式实现。

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

如果您要实现自定义层，则可以从 Module 或 TransformerEncoderLayer 类派生它。如果您的自定义层同时支持 torch.Tensor 和 Nested Tensor 输入，请使其实现成为 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 中描述的特殊优化实现

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

如果正在使用优化后的实现，则可以为 src 传递 NestedTensor，以比使用填充掩码更有效地表示填充。在这种情况下，将返回 NestedTensor，并且可以预期额外的加速与输入填充部分的比例成正比。

forward(src, src_mask=None, src_key_padding_mask=None, is_causal=False)[source][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 是因果掩码。提供不正确的提示可能会导致执行错误，包括向前和向后兼容性问题。

返回类型

Tensor

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

TransformerEncoderLayer¶

文档

教程

资源