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 層。

此 Transformer 層實現了《Attention Is All You Need》論文中描述的原始 Transformer 架構。該層的目的是作為基礎理解的參考實現，因此與較新的 Transformer 架構相比，它僅包含有限的功能。鑑於 Transformer 類架構的快速創新步伐，我們建議探索此教程，以使用核心構建塊或 PyTorch 生態系統中的高階庫來構建高效的 Transformer 層。

引數

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)

注意：有關將 nn.Transformer 模組應用於詞語言模型的完整示例，請參閱 pytorch/examples

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]) – 源序列的加法掩碼（可選）。
tgt_mask (Optional[Tensor]) – 目標序列的加法掩碼（可選）。
memory_mask (Optional[Tensor]) – 編碼器輸出的加法掩碼（可選）。
src_key_padding_mask (Optional[Tensor]) – 每個批次源鍵的張量掩碼（可選）。
tgt_key_padding_mask (Optional[Tensor]) – 每個批次目標鍵的張量掩碼（可選）。
memory_key_padding_mask (Optional[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：對於未批次的輸入，為 $(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 的位置將保持不變。

output：對於未批次的輸入，為 $(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)[原始碼]#

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

掩碼位置填充為 float(‘-inf’)。未掩碼位置填充為 float(0.0)。

返回型別: 張量

Transformer#

文件

教程

資源