TransformerEncoder

class torch.nn.TransformerEncoder(encoder_layer, num_layers, norm=None, enable_nested_tensor=True, mask_check=True)

TransformerEncoder 是 N 个编码器层的堆叠。

注意

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

用户可以使用相应的参数构建 BERT 模型 (https://arxiv.org/abs/1810.04805)。

参数

• encoder_layer (TransformerEncoderLayer) – TransformerEncoderLayer() 类的实例（必需）。

• num_layers (int) – 编码器中子编码器层的数量（必需）。

• norm (Optional[Module]) – 层归一化组件（可选）。

• enable_nested_tensor (bool) – 如果为 True，输入将自动转换为嵌套张量（并在输出时转换回来）。当填充率较高时，这将提高 TransformerEncoder 的整体性能。默认值：True（启用）。

示例：

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

forward(src, mask=None, src_key_padding_mask=None, is_causal=None)

依次将输入传递通过编码器层。

参数

• src (Tensor) – 要编码的序列（必需）。

• mask (Optional[Tensor]) – src 序列的掩码（可选）。

• src_key_padding_mask (Optional[Tensor]) – 每个批次 src 键的掩码（可选）。

• is_causal (Optional[bool]) – 如果指定，则应用因果掩码作为 mask。默认值：None；尝试检测因果掩码。警告：is_causal 提供 mask 是因果掩码的提示。提供不正确的提示可能会导致执行不正确，包括向前和向后兼容性。

返回类型

Tensor

形状

请参阅 Transformer 中的文档。