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。

引數

d_model (int) – 編碼器/解碼器輸入中預期的特徵數量（預設值=512）。
nhead (int) – 多頭注意力模型中的頭數量（預設值=8）。
num_encoder_layers (int) – 編碼器中的子編碼器層數量（預設值=6）。
num_decoder_layers (int) – 解碼器中的子解碼器層數量（預設值=6）。
dim_feedforward (int) – 前饋網路模型的維度（預設值=2048）。
dropout (float) – dropout 值（預設值=0.1）。
activation (Union[str, Callable[[Tensor], Tensor]]) – 編碼器/解碼器中間層的啟用函式，可以是字串（“relu”或“gelu”）或一元可呼叫物件。預設值：relu
custom_encoder (Optional[Any]) – 自定義編碼器（預設值=None）。
custom_decoder (Optional[Any]) – 自定義解碼器（預設值=None）。
layer_norm_eps (float) – 層歸一化元件中的 eps 值（預設值=1e-5）。
batch_first (bool) – 如果為 True，則輸入和輸出張量的形狀為 (batch, seq, feature)。預設值：False (seq, batch, feature)。
norm_first (bool) – 如果為 True，編碼器和解碼器層將在其他注意力層和前饋操作之前執行 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 引數提供了布林張量，則值為 True 的位置不允許參與注意力計算，這與 torch.nn.functional.scaled_dot_product_attention() 中 attn_mask 的定義相反。

引數

src (Tensor) – 編碼器輸入的序列（必需）。
tgt (Tensor) – 解碼器輸入的序列（必需）。
src_mask (Optional[Tensor]) – src 序列的加性掩碼（可選）。
tgt_mask (Optional[Tensor]) – tgt 序列的加性掩碼（可選）。
memory_mask (Optional[Tensor]) – 編碼器輸出的加性掩碼（可選）。
src_key_padding_mask (Optional[Tensor]) – src 鍵的張量掩碼，按批次劃分（可選）。
tgt_key_padding_mask (Optional[Tensor]) – tgt 鍵的張量掩碼，按批次劃分（可選）。
memory_key_padding_mask (Optional[Tensor]) – memory 鍵的張量掩碼，按批次劃分（可選）。
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 是因果掩碼。提供不正確的提示可能導致執行錯誤，包括前向和後向相容性問題。

返回型別

Tensor

形狀

src: 對於非批次輸入為 $(S, E)$ ，如果 batch_first=False 則為 $(S, N, E)$ ，如果 batch_first=True 則為 (N, S, E)。
tgt: 對於非批次輸入為 $(T, E)$ ，如果 batch_first=False 則為 $(T, N, E)$ ，如果 batch_first=True 則為 (N, T, E)。
src_mask: $(S, S)$ 或 $(N\cdot\text{num\_heads}, S, S)$ 。
tgt_mask: $(T, T)$ 或 $(N\cdot\text{num\_heads}, T, T)$ 。
memory_mask: $(T, S)$ 。
src_key_padding_mask: 對於非批次輸入為 $(S)$ ，否則為 $(N, S)$ 。
tgt_key_padding_mask: 對於非批次輸入為 $(T)$ ，否則為 $(N, T)$ 。
memory_key_padding_mask: 對於非批次輸入為 $(S)$ ，否則為 $(N, S)$ 。

注意：[src/tgt/memory]_mask 確保位置 $i$ 允許關注未被掩碼的位置。如果提供了 BoolTensor，則值為 True 的位置不允許關注，而值為 False 的位置將保持不變。如果提供了 FloatTensor，則它將被新增到注意力權重中。[src/tgt/memory]_key_padding_mask 提供鍵中特定元素，這些元素將被注意力忽略。如果提供了 BoolTensor，則值為 True 的位置將被忽略，而值為 False 的位置將保持不變。

輸出：未批處理輸入為 $(T, E)$ ，如果 batch_first=False 則為 $(T, N, E)$ ，如果 batch_first=True 則為 (N, T, E)。

注意：由於 Transformer 模型中的多頭注意力架構，Transformer 的輸出序列長度與解碼器的輸入序列（即目標）長度相同。

其中 $S$ 是源序列長度， $T$ 是目標序列長度， $N$ 是批次大小， $E$ 是特徵數量

示例

>>> output = transformer_model(src, tgt, src_mask=src_mask, tgt_mask=tgt_mask)

static generate_square_subsequent_mask(sz, device=None, dtype=None)[source][source]¶

為序列生成一個方形的因果掩碼。

被掩碼的位置填充 float('–inf')。未被掩碼的位置填充 float(0.0)。

返回型別: Tensor

Transformer¶

文件

教程

資源