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)[源][源]¶
TransformerEncoderLayer 由自注意力(self-attn)和前馈网络(feedforward network)组成。
注
参见此教程以深入了解 PyTorch 为构建您自己的 transformer 层提供的性能构建块。
这个标准编码器层基于论文 Attention Is All You Need。用户可在应用过程中修改或以不同方式实现。
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
禁用训练(使用
.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
值(除非调用者手动修改了其中一个而未修改另一个,否则通常如此)
如果使用了优化实现,可以为
src
传入一个 NestedTensor,以比使用填充掩码更高效地表示填充。在这种情况下,将返回一个 NestedTensor,并且可以预期获得与输入中填充部分比例相当的额外速度提升。
- forward(src, src_mask=None, src_key_padding_mask=None, is_causal=False)[源][源]¶
通过编码器层传递输入。
- 参数
- 返回类型
- 形状
参见
Transformer
中的文档。