Transformer¶
- 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)[原始碼][原始碼]¶
一個 Transformer 模型。
注意
請參考此教學，深入了解 PyTorch 提供的用於構建您自己的 Transformer 層的高效構建模組。
使用者可以根據需要修改屬性。此架構基於論文“Attention Is All You Need”。Ashish Vaswani, Noam Shazeer, Niki Parmar, Jakob Uszkoreit, Llion Jones, Aidan N Gomez, Lukasz Kaiser, and Illia Polosukhin. 2017. Attention is all you need. In Advances in Neural Information Processing Systems, pages 6000-6010.
- 參數
d_model (int) – 編碼器/解碼器輸入中預期的特徵數量 (預設值=512)。
nhead (int) – multiheadattention 模型中的 head 數量 (預設值=8)。
num_encoder_layers (int) – 編碼器中的 sub-encoder-layers 數量 (預設值=6)。
num_decoder_layers (int) – 解碼器中的 sub-decoder-layers 數量 (預設值=6)。
dim_feedforward (int) – feedforward 網路模型的維度 (預設值=2048)。
dropout (float) – dropout 值 (預設值=0.1)。
activation (Union[str, Callable[[Tensor], Tensor]]) – 編碼器/解碼器中間層的激活函數，可以是字串 (“relu” 或 “gelu”) 或一元 callable。預設值: relu
layer_norm_eps (float) – layer normalization 元件中的 eps 值 (預設值=1e-5)。
batch_first (bool) – 如果
True，則輸入和輸出 tensor 會以 (batch, seq, feature) 的形式提供。預設值：False(seq, batch, feature)。norm_first (bool) – 如果
True，編碼器和解碼器層會在其他 attention 和 feedforward 運算之前執行 LayerNorm，否則在之後執行。預設值：False(之後)。bias (bool) – 如果設定為
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)[原始碼][原始碼]¶
接收並處理帶遮罩的來源/目標序列。
注意
如果為任何 [src/tgt/memory]_mask 參數提供布林 tensor，則具有
True值的位點不允許參與 attention，這與torch.nn.functional.scaled_dot_product_attention()中attn_mask的定義相反。- 參數
src (Tensor) – 要傳遞給編碼器的序列 (必填)。
tgt (Tensor) – 解碼器的輸入序列（必要）。
src_key_padding_mask (Optional[Tensor]) – 每個批次的 src 鍵的 Tensor 遮罩（可選）。
tgt_key_padding_mask (Optional[Tensor]) – 每個批次的 tgt 鍵的 Tensor 遮罩（可選）。
memory_key_padding_mask (Optional[Tensor]) – 每個批次的 memory 鍵的 Tensor 遮罩（可選）。
src_is_causal (Optional[bool]) – 如果指定，則將因果遮罩應用為
src_mask。預設值：None；嘗試偵測因果遮罩。警告：src_is_causal提供src_mask是因果遮罩的提示。 提供不正確的提示可能會導致不正確的執行，包括正向和反向相容性。tgt_is_causal (Optional[bool]) – 如果指定，則將因果遮罩應用為
tgt_mask。預設值：None；嘗試偵測因果遮罩。警告：tgt_is_causal提供tgt_mask是因果遮罩的提示。 提供不正確的提示可能會導致不正確的執行，包括正向和反向相容性。memory_is_causal (bool) – 如果指定，則將因果遮罩應用為
memory_mask。預設值：False。警告：memory_is_causal提供memory_mask是因果遮罩的提示。 提供不正確的提示可能會導致不正確的執行，包括正向和反向相容性。
- 回傳類型
- 形狀
src: 用於非批次輸入， 如果 batch_first=False 或 (N, S, E) 如果 batch_first=True。
tgt: 用於非批次輸入， 如果 batch_first=False 或 (N, T, E) 如果 batch_first=True。
src_mask: 或 。
tgt_mask: 或 。
memory_mask: 。
src_key_padding_mask: 若為非批次輸入，則為 ，否則為 。
tgt_key_padding_mask: 若為非批次輸入，則為 ，否則為 。
memory_key_padding_mask: 若為非批次輸入，則為 ，否則為 。
注意：[src/tgt/memory]_mask 確保位置 可以關注到未遮罩的位置。如果提供了 BoolTensor，則
True的位置不允許關注，而False值將保持不變。如果提供了 FloatTensor，它將被添加到 attention 權重中。[src/tgt/memory]_key_padding_mask 提供了 key 中要被 attention 忽略的特定元素。如果提供了 BoolTensor，則值為True的位置將被忽略，而值為False的位置將保持不變。輸出：針對未批次處理的輸入為 ，如果 batch_first=False 則為 ，如果 batch_first=True 則為 (N, T, E)。
注意：由於 Transformer 模型中的多頭注意力架構，Transformer 的輸出序列長度與解碼器的輸入序列（即目標）長度相同。
其中 是來源序列長度， 是目標序列長度， 是批次大小， 是特徵數量
範例
>>> output = transformer_model(src, tgt, src_mask=src_mask, tgt_mask=tgt_mask)
