Transformers

( vocab_size = 50257 n_positions = 1024 n_embd = 768 n_layer = 12 n_head = 12 n_inner = None activation_function = 'gelu_new' resid_pdrop = 0.1 embd_pdrop = 0.1 attn_pdrop = 0.1 layer_norm_epsilon = 1e-05 initializer_range = 0.02 summary_type = 'cls_index' summary_use_proj = True summary_activation = None summary_proj_to_labels = True summary_first_dropout = 0.1 scale_attn_weights = True use_cache = True bos_token_id = 50256 eos_token_id = 50256 scale_attn_by_inverse_layer_idx = False reorder_and_upcast_attn = False **kwargs )

引數

vocab_size (int，可選，預設為 50257) — GPT-2 模型的詞彙表大小。定義了呼叫 GPT2Model 或 TFGPT2Model 時傳遞的 inputs_ids 可以表示的不同詞元的數量。
n_positions (int，可選，預設為 1024) — 該模型可能使用的最大序列長度。通常將其設定為一個較大的值以備不時之需（例如 512、1024 或 2048）。
n_embd (int，可選，預設為 768) — 嵌入和隱藏狀態的維度。
n_layer (int，可選，預設為 12) — Transformer 編碼器中的隱藏層數量。
n_head (int，可選，預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。
n_inner (int，可選) — 內部前饋層的維度。None 將其設定為 4 倍的 n_embd
activation_function (str，可選，預設為 "gelu_new") — 啟用函式，可選列表為 ["relu", "silu", "gelu", "tanh", "gelu_new"]。
resid_pdrop (float，可選，預設為 0.1) — 嵌入、編碼器和池化層中所有全連線層的丟棄（dropout）機率。
embd_pdrop (float，可選，預設為 0.1) — 嵌入層的丟棄率。
attn_pdrop (float，可選，預設為 0.1) — 注意力層的丟棄率。
layer_norm_epsilon (float，可選，預設為 1e-05) — 層歸一化層中使用的 epsilon 值。
initializer_range (float，可選，預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
summary_type (string，可選，預設為 "cls_index") — 用於序列摘要的引數，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

必須是以下選項之一：
- "last": 取最後一個詞元（token）的隱藏狀態（類似 XLNet）。
- "first": 取第一個詞元（token）的隱藏狀態（類似 BERT）。
- "mean": 取所有詞元（token）隱藏狀態的平均值。
- "cls_index": 提供一個分類詞元位置的張量（類似 GPT/GPT-2）。
- "attn": 暫未實現，使用多頭注意力。
summary_use_proj (bool，可選，預設為 True) — 用於序列摘要的引數，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

是否在向量提取後新增一個投影層。
summary_activation (str，可選) — 用於序列摘要的引數。用於 GPT2DoubleHeadsModel 中的多項選擇頭。

傳遞 "tanh" 表示對輸出使用 tanh 啟用函式，任何其他值都將導致不使用啟用函式。
summary_proj_to_labels (bool，可選，預設為 True) — 用於序列摘要的引數，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

投影層的輸出是應該有 config.num_labels 個類別還是 config.hidden_size 個類別。
summary_first_dropout (float，可選，預設為 0.1) — 用於序列摘要的引數，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

在投影和啟用之後使用的丟棄率。
scale_attn_weights (bool，可選，預設為 True) — 透過除以 sqrt(hidden_size) 來縮放注意力權重。
use_cache (bool，可選，預設為 True) — 模型是否應返回最後的鍵/值注意力（並非所有模型都使用）。
bos_token_id (int，可選，預設為 50256) — 詞彙表中句子開頭詞元（token）的 ID。
eos_token_id (int, 可選, 預設為 50256) — 詞彙表中句子結束標記的 ID。
scale_attn_by_inverse_layer_idx (bool, 可選, 預設為 False) — 是否額外透過 1 / layer_idx + 1 縮放注意力權重。
reorder_and_upcast_attn (bool, 可選, 預設為 False) — 是否在計算注意力（點積）之前縮放鍵（K），並在使用混合精度訓練時將注意力點積/softmax提升為 float()。

這是一個配置類，用於儲存 GPT2Model 或 TFGPT2Model 的配置。它用於根據指定的引數例項化一個 GPT-2 模型，定義模型架構。使用預設值例項化配置將產生與 GPT-2 openai-community/gpt2 架構相似的配置。

配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。

示例

>>> from transformers import GPT2Config, GPT2Model

>>> # Initializing a GPT2 configuration
>>> configuration = GPT2Config()

>>> # Initializing a model (with random weights) from the configuration
>>> model = GPT2Model(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

GPT2Tokenizer

class transformers.GPT2Tokenizer

引數

vocab_file (str) — 詞彙表文件的路徑。
merges_file (str) — 合併檔案的路徑。
errors (str, 可選, 預設為 "replace") — 將位元組解碼為 UTF-8 時遵循的正規化。更多資訊請參閱 bytes.decode。
unk_token (str, 可選, 預設為 "<|endoftext|>") — 未知標記。不在詞彙表中的標記無法轉換為 ID，將被設定為此標記。
bos_token (str, 可選, 預設為 "<|endoftext|>") — 序列開始標記。
eos_token (str, 可選, 預設為 "<|endoftext|>") — 序列結束標記。
pad_token (str, 可選) — 用於填充的標記，例如在批處理不同長度的序列時使用。
add_prefix_space (bool, 可選, 預設為 False) — 是否在輸入前新增一個初始空格。這允許將開頭的單詞像其他單詞一樣處理。（GPT2 分詞器透過前面的空格來檢測單詞的開頭）。
add_bos_token (bool, 可選, 預設為 False) — 是否在輸入前新增一個初始的句子開始標記。這允許將開頭的單詞像其他單詞一樣處理。

構建一個 GPT-2 分詞器。基於位元組級的位元組對編碼（Byte-Pair-Encoding）。

這個分詞器經過訓練，將空格視為詞元的一部分（有點像 sentencepiece），所以一個詞會

無論是否在句子開頭（無空格），編碼方式都會不同

>>> from transformers import GPT2Tokenizer

>>> tokenizer = GPT2Tokenizer.from_pretrained("openai-community/gpt2")
>>> tokenizer("Hello world")["input_ids"]
[15496, 995]

>>> tokenizer(" Hello world")["input_ids"]
[18435, 995]

您可以透過在例項化此分詞器時或在對某些文字呼叫它時傳遞 add_prefix_space=True 來繞過此行為，但由於模型並非以這種方式進行預訓練，這可能會導致效能下降。

當與 is_split_into_words=True 一起使用時，此分詞器會在每個詞（甚至是第一個詞）之前新增一個空格。

此分詞器繼承自 PreTrainedTokenizer，該類包含大多數主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。

save_vocabulary

( save_directory: str filename_prefix: typing.Optional[str] = None )

GPT2TokenizerFast

class transformers.GPT2TokenizerFast

引數

vocab_file (str, 可選) — 詞彙表文件的路徑。
merges_file (str, 可選) — 合併檔案的路徑。
tokenizer_file (str, 可選) — tokenizers 檔案的路徑（通常具有 .json 副檔名），其中包含載入分詞器所需的一切。
unk_token (str, 可選, 預設為 "<|endoftext|>") — 未知標記。不在詞彙表中的標記無法轉換為 ID，將被設定為此標記。
bos_token (str, 可選, 預設為 "<|endoftext|>") — 序列開始標記。
eos_token (str, 可選, 預設為 "<|endoftext|>") — 序列結束標記。
add_prefix_space (bool, 可選, 預設為 False) — 是否在輸入前新增一個初始空格。這允許將開頭的單詞像其他單詞一樣處理。（GPT2 分詞器透過前面的空格來檢測單詞的開頭）。

構建一個“快速”的 GPT-2 分詞器（由 HuggingFace 的 *tokenizers* 庫支援）。基於位元組級的位元組對編碼（Byte-Pair-Encoding）。

這個分詞器經過訓練，將空格視為詞元的一部分（有點像 sentencepiece），所以一個詞會

無論是否在句子開頭（無空格），編碼方式都會不同

>>> from transformers import GPT2TokenizerFast

>>> tokenizer = GPT2TokenizerFast.from_pretrained("openai-community/gpt2")
>>> tokenizer("Hello world")["input_ids"]
[15496, 995]

>>> tokenizer(" Hello world")["input_ids"]
[18435, 995]

您可以透過在例項化此分詞器時傳遞 add_prefix_space=True 來繞過此行為，但由於模型並非以此方式進行預訓練，這可能會導致效能下降。

當與 is_split_into_words=True 一起使用時，此分詞器需要以 add_prefix_space=True 進行例項化。

此分詞器繼承自 PreTrainedTokenizerFast，該類包含大多數主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。

GPT2 特定輸出

class transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput

( loss: typing.Optional[torch.FloatTensor] = None mc_loss: typing.Optional[torch.FloatTensor] = None logits: typing.Optional[torch.FloatTensor] = None mc_logits: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )

引數

loss (torch.FloatTensor，形狀為 (1,), 可選，在提供了 labels 時返回) — 語言建模損失。
mc_loss (torch.FloatTensor，形狀為 (1,), 可選，在提供了 mc_labels 時返回) — 多項選擇分類損失。
logits (torch.FloatTensor，形狀為 (batch_size, num_choices, sequence_length, config.vocab_size)) — 語言建模頭的預測分數（在 SoftMax 之前的每個詞彙標記的分數）。
mc_logits (torch.FloatTensor，形狀為 (batch_size, num_choices)) — 多項選擇分類頭的預測分數（在 SoftMax 之前的每個選項的分數）。
past_key_values (tuple[tuple[torch.Tensor]], 可選，當傳遞 use_cache=True 或 config.use_cache=True 時返回) — 長度為 config.n_layers 的元組，包含形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量元組。

包含預計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple[torch.FloatTensor], 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（如果模型有嵌入層，則一個用於嵌入層的輸出，+ 每個層的輸出一個），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每層輸出處的隱藏狀態，以及可選的初始嵌入輸出。
attentions (tuple[torch.FloatTensor], 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — torch.FloatTensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 之後的注意力權重，用於計算自注意力頭中的加權平均值。

用於預測兩個句子是否連續的模型輸出的基類。

class transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput

( logits: Optional[tf.Tensor] = None mc_logits: Optional[tf.Tensor] = None past_key_values: list[tf.Tensor] | None = None hidden_states: tuple[tf.Tensor] | None = None attentions: tuple[tf.Tensor] | None = None )

引數

logits (tf.Tensor，形狀為 (batch_size, num_choices, sequence_length, config.vocab_size)) — 語言建模頭的預測分數（在 SoftMax 之前的每個詞彙標記的分數）。
mc_logits (tf.Tensor，形狀為 (batch_size, num_choices)) — 多項選擇分類頭的預測分數（在 SoftMax 之前的每個選項的分數）。
past_key_values (list[tf.Tensor], 可選，當傳遞 use_cache=True 或 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tf.Tensor 列表，每個張量的形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head)。

包含預計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(tf.Tensor), 可選，當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — tf.Tensor 的元組（一個用於嵌入層的輸出 + 每個層的輸出一個），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每層輸出處的隱藏狀態，以及初始嵌入輸出。
attentions (tuple(tf.Tensor), 可選，當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 之後的注意力權重，用於計算自注意力頭中的加權平均值。

用於預測兩個句子是否連續的模型輸出的基類。

Pytorch

隱藏 Pytorch 內容

GPT2Model

class transformers.GPT2Model

( config )

引數

config (GPT2Model) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

裸 Gpt2 模型，輸出原始的隱藏狀態，沒有任何特定的頭在其之上。

該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[tuple[tuple[torch.Tensor]], transformers.cache_utils.Cache, NoneType] = None cache_position: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, input_ids_length)) — 如果 past_key_values 為 None，則 input_ids_length = sequence_length，否則為 past_key_values[0][0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列標記的索引。

如果使用 past_key_values，則只有那些沒有計算過其過去狀態的 input_ids 才應作為 input_ids 傳遞。

索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
past_key_values (Union[tuple[tuple[torch.Tensor]], ~cache_utils.Cache, NoneType]) — 預計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括在解碼的先前階段，當 use_cache=True 或 config.use_cache=True 時由模型返回的 past_key_values。

允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為 config.n_layers 的 tuple(torch.FloatTensor) 的元組，每個元組有兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也被稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳遞 past_key_values，將返回舊版快取格式。

如果使用 past_key_values，使用者可以選擇只輸入最後的 input_ids（那些沒有向該模型提供其過去鍵值狀態的 ID），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
cache_position (torch.LongTensor，形狀 (sequence_length)，可選) — 描述輸入序列詞元在序列中位置的索引。與 position_ids 相反，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。
attention_mask (torch.FloatTensor，形狀 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力計算的掩碼。掩碼值選自 [0, 1]：
- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀 (batch_size, sequence_length)，可選) — 片段詞元索引，用於指示輸入的第一和第二部分。索引選自 [0, 1]：
- 0 對應於 *句子 A* 的詞元，
- 1 對應於 *句子 B* 的詞元。
什麼是詞元型別 ID？
position_ids (torch.LongTensor，形狀 (batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選值範圍為 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示該頭未被遮蔽，
- 0 表示該頭已被遮蔽。
inputs_embeds (torch.FloatTensor，形狀 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入式表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這會非常有用。
encoder_hidden_states (torch.Tensor，形狀 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。
encoder_attention_mask (torch.FloatTensor，形狀 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充詞元索引執行注意力計算的掩碼。如果模型被配置為解碼器，則此掩碼用於交叉注意力。掩碼值選自 [0, 1]：
- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
use_cache (bool，可選) — 如果設定為 True，則返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

last_hidden_state (torch.FloatTensor, 形狀為 (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。

如果使用了 past_key_values，則只輸出形狀為 (batch_size, 1, hidden_size) 的序列的最後一個隱藏狀態。
past_key_values (Cache，可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 這是一個 Cache 例項。更多詳情，請參閱我們的 kv 快取指南。

包含預先計算的隱藏狀態（自注意力塊中的鍵和值，如果 config.is_encoder_decoder=True，則可選地包含交叉注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(torch.FloatTensor)，可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每層輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
cross_attentions (tuple(torch.FloatTensor)，可選，當傳遞 output_attentions=True 且 config.add_cross_attention=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

GPT2Model 的前向方法，覆蓋了 __call__ 特殊方法。

儘管前向傳播的流程需要在此函式內定義，但之後應呼叫 Module 例項而不是這個函式，因為前者會負責執行前處理和後處理步驟，而後者會靜默地忽略它們。

GPT2LMHeadModel

class transformers.GPT2LMHeadModel

( config )

引數

config (GPT2LMHeadModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

GPT2 Transformer 模型，頂部帶有一個語言建模頭（線性層，權重與輸入嵌入繫結）。

該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None cache_position: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀 (batch_size, input_ids_length)) — 如果 past_key_values 為 None，則 input_ids_length = sequence_length；否則為 past_key_values[0][0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列詞元的索引。

如果使用 past_key_values，則只有那些過去未計算的 input_ids 才應作為 input_ids 傳遞。

索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常由模型在解碼的先前階段返回的 past_key_values 組成，當 use_cache=True 或 config.use_cache=True 時。

允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為傳統快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞 past_key_values，將返回傳統快取格式。

如果使用 past_key_values，使用者可以選擇只輸入最後的 input_ids（那些沒有向該模型提供其過去鍵值狀態的詞元），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
cache_position (torch.LongTensor，形狀 (sequence_length)，可選) — 描述輸入序列詞元在序列中位置的索引。與 position_ids 相反，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。
attention_mask (torch.FloatTensor，形狀 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力計算的掩碼。掩碼值選自 [0, 1]：
- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀 (batch_size, sequence_length)，可選) — 片段詞元索引，用於指示輸入的第一和第二部分。索引選自 [0, 1]：
- 0 對應於 *句子 A* 的詞元，
- 1 對應於 *句子 B* 的詞元。
什麼是詞元型別 ID？
position_ids (torch.LongTensor，形狀 (batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選值範圍為 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示該頭未被遮蔽，
- 0 表示該頭已被遮蔽。
inputs_embeds (torch.FloatTensor，形狀 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入式表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這會非常有用。
encoder_hidden_states (torch.Tensor，形狀 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。
encoder_attention_mask (torch.FloatTensor，形狀 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充詞元索引執行注意力計算的掩碼。如果模型被配置為解碼器，則此掩碼用於交叉注意力。掩碼值選自 [0, 1]：
- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
labels (torch.LongTensor，形狀 (batch_size, input_ids_length)，可選) — 語言建模的標籤。請注意，標籤在模型內部會被移動，即你可以設定 labels = input_ids。索引選自 [-100, 0, ..., config.vocab_size]。所有設定為 -100 的標籤都會被忽略（遮蔽），損失只對 [0, ..., config.vocab_size] 範圍內的標籤進行計算。
use_cache (bool，可選) — 如果設定為 True，則返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
logits_to_keep (Union[int, torch.Tensor]，預設為 0) — 如果是 int，則計算最後 logits_to_keep 個詞元的 logits。如果為 0，則計算所有 input_ids 的 logits（特殊情況）。對於生成任務，只需要最後一個詞元的 logits，僅為該詞元計算 logits 可以節省記憶體，這對於長序列或大詞彙表來說非常重要。如果是一個 torch.Tensor，則必須是一維的，對應於要在序列長度維度中保留的索引。這在使用打包張量格式（批處理和序列長度使用單一維度）時非常有用。

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。
logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。
hidden_states (tuple(torch.FloatTensor)，可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每層輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
cross_attentions (tuple(torch.FloatTensor)，可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
past_key_values (Cache，可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 這是一個 Cache 例項。更多詳情，請參閱我們的 kv 快取指南。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

GPT2LMHeadModel 的前向方法，覆蓋了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2LMHeadModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2LMHeadModel.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

GPT2DoubleHeadsModel

class transformers.GPT2DoubleHeadsModel

( config )

引數

config (GPT2DoubleHeadsModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

GPT2 Transformer 模型，頂部帶有一個語言建模頭和一個多項選擇分類頭，例如用於 RocStories/SWAG 任務。這兩個頭是兩個線性層。語言建模頭的權重與輸入嵌入繫結，分類頭將輸入序列中指定分類詞元索引的輸入作為輸入）。

該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None cache_position: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None mc_token_ids: typing.Optional[torch.LongTensor] = None labels: typing.Optional[torch.LongTensor] = None mc_labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀 (batch_size, input_ids_length)) — 如果 past_key_values 為 None，則 input_ids_length = sequence_length；否則為 past_key_values[0][0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列詞元的索引。

如果使用 past_key_values，則只有那些過去未計算的 input_ids 才應作為 input_ids 傳遞。

索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常由模型在解碼的先前階段返回的 past_key_values 組成，當 use_cache=True 或 config.use_cache=True 時。

允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為傳統快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞 past_key_values，將返回傳統快取格式。

如果使用 past_key_values，使用者可以選擇只輸入最後的 input_ids（那些沒有向該模型提供其過去鍵值狀態的詞元），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
cache_position (torch.LongTensor，形狀 (sequence_length)，可選) — 描述輸入序列詞元在序列中位置的索引。與 position_ids 相反，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。
attention_mask (torch.FloatTensor，形狀 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力計算的掩碼。掩碼值選自 [0, 1]：
- 1 表示詞元未被遮蔽，
- 0 表示詞元已被遮蔽。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀 (batch_size, sequence_length)，可選) — 片段詞元索引，用於指示輸入的第一和第二部分。索引選自 [0, 1]：
- 0 對應於 *句子 A* 的詞元，
- 1 對應於 *句子 B* 的詞元。
什麼是詞元型別 ID？
position_ids (torch.LongTensor，形狀 (batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選值範圍為 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示該頭未被遮蔽，
- 0 表示該頭已被遮蔽。
inputs_embeds (torch.FloatTensor，形狀 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入式表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為關聯向量，這會非常有用。
mc_token_ids (torch.LongTensor，形狀 (batch_size, num_choices)，可選，預設為輸入最後一個詞元的索引) — 每個輸入序列中分類詞元的索引。選值範圍為 [0, input_ids.size(-1) - 1]。
labels (torch.LongTensor，形狀 (batch_size, input_ids_length)，可選) — 語言建模的標籤。請注意，標籤在模型內部會被移動，即你可以設定 labels = input_ids。索引選自 [-100, 0, ..., config.vocab_size - 1]。所有設定為 -100 的標籤都會被忽略（遮蔽），損失只對 [0, ..., config.vocab_size - 1] 範圍內的標籤進行計算。
mc_labels (torch.LongTensor，形狀為 (batch_size)，可選) — 用於計算多項選擇分類損失的標籤。索引應在 [0, ..., num_choices] 範圍內，其中 num_choices 是輸入張量第二個維度的大小。（參見上面的 input_ids）
use_cache (bool，可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。更多細節請參閱返回張量下的 attentions。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。更多細節請參閱返回張量下的 hidden_states。
return_dict (bool，可選) — 是否返回一個 ModelOutput 物件，而不是一個普通的元組。

transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或 tuple(torch.FloatTensor)

一個 transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

loss (torch.FloatTensor，形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失。
mc_loss (torch.FloatTensor，形狀為 (1,)，可選，當提供了 mc_labels 時返回) — 多項選擇分類損失。
logits (torch.FloatTensor，形狀為 (batch_size, num_choices, sequence_length, config.vocab_size)) — 語言建模頭的預測分數（SoftMax 之前的每個詞彙標記的分數）。
mc_logits (torch.FloatTensor，形狀為 (batch_size, num_choices)) — 多項選擇分類頭的預測分數（SoftMax 之前的每個選項的分數）。
past_key_values (tuple[tuple[torch.Tensor]]，可選，當傳遞了 use_cache=True 或當 config.use_cache=True 時返回) — 長度為 config.n_layers 的元組，包含形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量的元組。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple[torch.FloatTensor]，可選，當傳遞了 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（如果模型有嵌入層，一個是嵌入層的輸出，加上每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple[torch.FloatTensor]，可選，當傳遞了 output_attentions=True 或當 config.output_attentions=True 時返回) — torch.FloatTensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

GPT2DoubleHeadsModel 的 forward 方法，覆蓋了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2DoubleHeadsModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2DoubleHeadsModel.from_pretrained("openai-community/gpt2")

>>> # Add a [CLS] to the vocabulary (we should train it also!)
>>> num_added_tokens = tokenizer.add_special_tokens({"cls_token": "[CLS]"})
>>> # Update the model embeddings with the new vocabulary size
>>> embedding_layer = model.resize_token_embeddings(len(tokenizer))

>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> encoded_choices = [tokenizer.encode(s) for s in choices]
>>> cls_token_location = [tokens.index(tokenizer.cls_token_id) for tokens in encoded_choices]

>>> input_ids = torch.tensor(encoded_choices).unsqueeze(0)  # Batch size: 1, number of choices: 2
>>> mc_token_ids = torch.tensor([cls_token_location])  # Batch size: 1

>>> outputs = model(input_ids, mc_token_ids=mc_token_ids)
>>> lm_logits = outputs.logits
>>> mc_logits = outputs.mc_logits

GPT2ForQuestionAnswering

class transformers.GPT2ForQuestionAnswering

( config )

引數

config (GPT2ForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Gpt2 Transformer 模型，頂部帶有一個區間分類頭，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出之上新增一個線性層來計算 span start logits 和 span end logits）。

該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 為 None；否則為 past_key_values[0][0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列標記的索引。

如果使用了 past_key_values，則只應將尚未計算其過去狀態的 input_ids 作為 input_ids 傳入。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於指示輸入的第一和第二部分的段標記索引。索引選自 [0, 1]：
- 0 對應於一個 句子 A 標記，
- 1 對應於一個 句子 B 標記。
什麼是標記型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
start_positions (torch.LongTensor，形狀為 (batch_size,)，可選) — 用於計算標記分類損失的標記區間的起始位置（索引）標籤。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不被考慮。
end_positions (torch.LongTensor，形狀為 (batch_size,)，可選) — 用於計算標記分類損失的標記區間的結束位置（索引）標籤。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不被考慮。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。更多細節請參閱返回張量下的 attentions。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。更多細節請參閱返回張量下的 hidden_states。
return_dict (bool，可選) — 是否返回一個 ModelOutput 物件，而不是一個普通的元組。

transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

loss (torch.FloatTensor of shape (1,), 可選, 當提供 labels 時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。
start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。
end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor)，可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每層輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

GPT2ForQuestionAnswering 的 forward 方法，覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, GPT2ForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForQuestionAnswering.from_pretrained("openai-community/gpt2")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...

>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...

GPT2ForSequenceClassification

class transformers.GPT2ForSequenceClassification

( config )

引數

config (GPT2ForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

GPT2 模型 Transformer，頂部帶有一個序列分類頭（線性層）。

GPT2ForSequenceClassification 使用最後一個標記來進行分類，就像其他因果模型（例如 GPT-1）一樣。

由於它對最後一個標記進行分類，因此需要知道最後一個標記的位置。如果在配置中定義了 pad_token_id，它會找到每行中不是填充標記的最後一個標記。如果未定義 pad_token_id，它會簡單地取每行批次中的最後一個值。由於當傳遞 inputs_embeds 而不是 input_ids 時，它無法猜測填充標記，因此它會做同樣的操作（取每行批次中的最後一個值）。

該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 為 None；否則為 past_key_values[0][0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列標記的索引。

如果使用了 past_key_values，則只應將尚未計算其過去狀態的 input_ids 作為 input_ids 傳入。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼的先前階段返回的 past_key_values，當 use_cache=True 或 config.use_cache=True 時。

允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為 config.n_layers 的 tuple(torch.FloatTensor) 的元組，每個元組有兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也被稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳遞 past_key_values，將返回舊版快取格式。

如果使用了 past_key_values，使用者可以選擇只輸入最後一個 input_ids（那些沒有為其提供過去鍵值狀態的標記），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於指示輸入的第一和第二部分的段標記索引。索引選自 [0, 1]：
- 0 對應於一個 句子 A 標記，
- 1 對應於一個 句子 B 標記。
什麼是標記型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍 [0, config.n_positions - 1]。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
labels (torch.LongTensor，形狀為 (batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels == 1，則計算迴歸損失（均方損失），如果 config.num_labels > 1，則計算分類損失（交叉熵）。
use_cache (bool，可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。更多細節請參閱返回張量下的 attentions。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。更多細節請參閱返回張量下的 hidden_states。
return_dict (bool，可選) — 是否返回一個 ModelOutput 物件，而不是一個普通的元組。

transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

loss (形狀為 (1,) 的 torch.FloatTensor，可選，當提供 labels 時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。
logits (形狀為 (batch_size, config.num_labels) 的 torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。
past_key_values (Cache，可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 這是一個 Cache 例項。更多詳情，請參閱我們的 kv 快取指南。

包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(torch.FloatTensor)，可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每層輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

GPT2ForSequenceClassification 的 forward 方法，覆蓋了 __call__ 特殊方法。

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2ForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForSequenceClassification.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = GPT2ForSequenceClassification.from_pretrained("openai-community/gpt2", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2ForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForSequenceClassification.from_pretrained("openai-community/gpt2", problem_type="multi_label_classification")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = GPT2ForSequenceClassification.from_pretrained(
...     "openai-community/gpt2", num_labels=num_labels, problem_type="multi_label_classification"
... )

>>> labels = torch.sum(
...     torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss

GPT2ForTokenClassification

class transformers.GPT2ForTokenClassification

( config )

引數

config (GPT2ForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Gpt2 Transformer 模型，頂部帶有一個標記分類頭（在隱藏狀態輸出之上新增一個線性層），例如用於命名實體識別（NER）任務。

該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 為 None；否則為 past_key_values[0][0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列標記的索引。

如果使用了 past_key_values，則只應將尚未計算其過去狀態的 input_ids 作為 input_ids 傳入。

可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼的先前階段返回的 past_key_values，當 use_cache=True 或 config.use_cache=True 時。

允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為 config.n_layers 的 tuple(torch.FloatTensor) 的元組，每個元組有兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也被稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳遞 past_key_values，將返回舊版快取格式。

如果使用了 past_key_values，使用者可以選擇只輸入最後一個 input_ids（那些沒有為其提供過去鍵值狀態的標記），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。
attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
什麼是注意力掩碼？
token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 片段詞元索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 句子 A 的詞元，
- 1 對應於 句子 B 的詞元。
什麼是詞元型別 ID？
position_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.n_positions - 1] 範圍內選擇。

什麼是位置 ID？
head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示頭 未被遮蔽，
- 0 表示頭 被遮蔽。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
labels (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels == 1，則計算迴歸損失（均方損失）；如果 config.num_labels > 1，則計算分類損失（交叉熵）。
use_cache (bool, 可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

loss (形狀為 (1,) 的 torch.FloatTensor，可選，當提供 labels 時返回) — 分類損失。
logits (形狀為 (batch_size, sequence_length, config.num_labels) 的 torch.FloatTensor) — 分類分數（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor)，可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — 形狀為 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 一個用於每層輸出）。

模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
attentions (tuple(torch.FloatTensor)，可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

GPT2ForTokenClassification 的前向方法，會覆蓋 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, GPT2ForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForTokenClassification.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer(
...     "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_token_class_ids = logits.argmax(-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

TensorFlow

隱藏 TensorFlow 內容

TFGPT2Model

class transformers.TFGPT2Model

( config *inputs **kwargs )

引數

config (GPT2Config) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

這是一個基礎的 GPT2 模型 Transformer，它輸出原始的隱藏狀態，頂部沒有任何特定的頭。

此模型繼承自 TFPreTrainedModel。請檢視超類的文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

這個模型也是 keras.Model 的子類。可以像使用常規的 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

支援第二種格式的原因是，Keras 方法在向模型和層傳遞輸入時更傾向於使用這種格式。由於這種支援，當使用像 model.fit() 這樣的方法時，一切應該“自然而然”地為你工作——只需以 model.fit() 支援的任何格式傳遞你的輸入和標籤！然而，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，有三種可能性可以用來將所有輸入張量收集到第一個位置引數中。

只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心這些問題，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

( input_ids: TFModelInputType | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)

引數

input_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, input_ids_length)) — input_ids_length = 如果 past_key_values 為 None，則為 sequence_length，否則為 past_key_values[0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列詞元的索引。

如果使用了 past_key_values，則只有那些尚未計算過其過去狀態的輸入 ID 才應作為 input_ids 傳遞。

索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什麼是輸入 ID？
past_key_values (list[tf.Tensor]，長度為 config.n_layers) — 包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（參見下面的 past_key_values 輸出）。可用於加速順序解碼。那些過去狀態已提供給此模型的詞元 ID 不應作為輸入 ID 傳遞，因為它們已經被計算過了。
attention_mask (tf.Tensor 或 Numpy array，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示詞元 未被遮蔽，
- 0 表示詞元 被遮蔽。
如果使用了 past_key_values，attention_mask 需要包含用於 past_key_values 的掩碼策略。換句話說，attention_mask 的長度必須始終為：len(past_key_values) + len(input_ids)

什麼是注意力掩碼？
token_type_ids (tf.Tensor 或 Numpy array，形狀為 (batch_size, input_ids_length), 可選) — 片段詞元索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 句子 A 的詞元，
- 1 對應於 句子 B 的詞元。
什麼是詞元型別 ID？
position_ids (tf.Tensor 或 Numpy array，形狀為 (batch_size, input_ids_length), 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。

什麼是位置 ID？
head_mask (Numpy array 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示頭 未被遮蔽，
- 0 表示頭 被遮蔽。
inputs_embeds (tf.Tensor，形狀為 (batch_size, input_ids_length, hidden_size), 可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, 可選，預設為 False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
encoder_hidden_states (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則在交叉注意力中使用。
encoder_attention_mask (tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對編碼器輸入的填充詞元索引執行注意力的掩碼。如果模型配置為解碼器，此掩碼將在交叉注意力中使用。掩碼值在 [0, 1] 中選擇：
- 1 表示詞元 未被遮蔽，
- 0 表示詞元 被遮蔽。
past_key_values (tuple[tuple[tf.Tensor]]，長度為 config.n_layers) — 包含預先計算的注意力塊的鍵和值隱藏狀態。可用於加速解碼。如果使用 past，使用者可以選擇只輸入最後的 decoder_input_ids（那些沒有為其提供過去鍵值狀態的 ID），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 decoder_input_ids。
use_cache (bool, 可選，預設為 True) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past）。在訓練期間設定為 False，在生成期間設定為 True。

transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或一個 tf.Tensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

last_hidden_state (tf.Tensor of shape (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。

如果使用了 past_key_values，則只輸出形狀為 (batch_size, 1, hidden_size) 的序列的最後一個隱藏狀態。
past_key_values (list[tf.Tensor], 可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tf.Tensor 列表，每個張量的形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(tf.FloatTensor), 可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — tf.Tensor 的元組（一個用於嵌入層的輸出 + 每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(tf.Tensor), 可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
cross_attentions (tuple(tf.Tensor), 可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

TFGPT2Model 的前向方法，會覆蓋 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFGPT2Model
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2Model.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)

>>> last_hidden_states = outputs.last_hidden_state

TFGPT2LMHeadModel

class transformers.TFGPT2LMHeadModel

( config *inputs **kwargs )

引數

config (GPT2Config) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

GPT2 Transformer 模型，頂部帶有一個語言建模頭（線性層，權重與輸入嵌入繫結）。

此模型繼承自 TFPreTrainedModel。請檢視超類的文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

這個模型也是 keras.Model 的子類。可以像使用常規的 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心這些問題，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

( input_ids: TFModelInputType | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)

引數

input_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, input_ids_length)) — input_ids_length = 如果 past_key_values 為 None，則為 sequence_length，否則為 past_key_values[0].shape[-2]（輸入過去鍵值狀態的 sequence_length）。詞彙表中輸入序列詞元的索引。

如果使用了 past_key_values，則只有那些尚未計算過其過去狀態的輸入 ID 才應作為 input_ids 傳遞。

索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什麼是輸入 ID？
past_key_values (list[tf.Tensor]，長度為 config.n_layers) — 包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（參見下面的 past_key_values 輸出）。可用於加速順序解碼。那些過去狀態已提供給此模型的詞元 ID 不應作為輸入 ID 傳遞，因為它們已經被計算過了。
attention_mask (tf.Tensor 或 Numpy array，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示詞元 未被遮蔽，
- 0 表示詞元 被遮蔽。
如果使用了 past_key_values，attention_mask 需要包含用於 past_key_values 的掩碼策略。換句話說，attention_mask 的長度必須始終為：len(past_key_values) + len(input_ids)

什麼是注意力掩碼？
token_type_ids (tf.Tensor 或 Numpy array，形狀為 (batch_size, input_ids_length), 可選) — 片段詞元索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：
- 0 對應於 句子 A 的詞元，
- 1 對應於 句子 B 的詞元。
什麼是詞元型別 ID？
position_ids (tf.Tensor 或 Numpy array，形狀為 (batch_size, input_ids_length), 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在 [0, config.max_position_embeddings - 1] 範圍內選擇。

什麼是位置 ID？
head_mask (Numpy array 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示頭 未被遮蔽，
- 0 表示頭 被遮蔽。
inputs_embeds (tf.Tensor，形狀為 (batch_size, input_ids_length, hidden_size), 可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, 可選，預設為 False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
encoder_hidden_states (tf.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則在交叉注意力中使用。
encoder_attention_mask (tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對編碼器輸入的填充詞元索引執行注意力的掩碼。如果模型配置為解碼器，此掩碼將在交叉注意力中使用。掩碼值在 [0, 1] 中選擇：
- 1 表示詞元 未被遮蔽，
- 0 表示詞元 被遮蔽。
past_key_values (tuple[tuple[tf.Tensor]]，長度為 config.n_layers) — 包含預先計算的注意力塊的鍵和值隱藏狀態。可用於加速解碼。如果使用 past，使用者可以選擇只輸入最後的 decoder_input_ids（那些沒有為其提供過去鍵值狀態的 ID），形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 decoder_input_ids。
use_cache (bool, 可選，預設為 True) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past）。在訓練期間設定為 False，在生成期間設定為 True。
labels (tf.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於計算交叉熵分類損失的標籤。索引應在 [0, ..., config.vocab_size - 1] 範圍內。

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一個 tf.Tensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GPT2Config）和輸入，包含各種元素。

loss (形狀為(n,)的tf.Tensor，可選，其中n是非掩碼標籤的數量，當提供了labels時返回) — 語言建模損失（用於下一標記預測）。
logits (tf.Tensor of shape (batch_size, sequence_length, config.vocab_size)) — 語言模型頭部的預測分數（SoftMax 之前每個詞彙標記的分數）。
hidden_states (tuple(tf.Tensor), 可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — tf.Tensor 的元組（一個用於嵌入層的輸出 + 每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(tf.Tensor), 可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
cross_attentions (tuple(tf.Tensor), 可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
past_key_values (list[tf.Tensor], 可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tf.Tensor 列表，每個張量的形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

TFGPT2LMHeadModel 的前向方法，會覆蓋 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFGPT2LMHeadModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2LMHeadModel.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logits

TFGPT2DoubleHeadsModel

class transformers.TFGPT2DoubleHeadsModel

( config *inputs **kwargs )

引數

config (GPT2Config) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

此模型繼承自 TFPreTrainedModel。請檢視超類的文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

這個模型也是 keras.Model 的子類。可以像使用常規的 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心這些問題，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

( input_ids: TFModelInputType | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None mc_token_ids: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或 tuple(tf.Tensor)

引數

input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 為 None，否則為 past_key_values[0].shape[-2] (輸入過去鍵值狀態的 sequence_length)。詞彙表中輸入序列標記的索引。

如果使用了 past_key_values，則只有那些沒有計算過其過去狀態的輸入 ID 才應作為 input_ids 傳遞。

索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什麼是輸入 ID？
past_key_values (list[tf.Tensor]，長度為 config.n_layers) — 包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（參見下面的 past_key_values 輸出）。可用於加速順序解碼。已將過去狀態提供給該模型的標記 ID 不應作為輸入 ID 傳遞，因為它們已經被計算過。
attention_mask (tf.Tensor 或 Numpy 陣列，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
如果使用 past_key_values，attention_mask 需要包含用於 past_key_values 的掩碼策略。換句話說，attention_mask 的長度必須始終為：len(past_key_values) + len(input_ids)

什麼是注意力掩碼？
token_type_ids (tf.Tensor 或 Numpy 陣列，形狀為 (batch_size, input_ids_length)，可選) — 用於指示輸入的第一和第二部分的片段標記索引。索引選自 [0, 1]：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
什麼是標記型別 ID？
position_ids (tf.Tensor 或 Numpy 陣列，形狀為 (batch_size, input_ids_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍 [0, config.max_position_embeddings - 1]。

什麼是位置 ID？
head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
inputs_embeds (tf.Tensor，形狀為 (batch_size, input_ids_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為相關向量，這將非常有用。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在 Eager 模式下使用，在圖模式下該值將始終設定為 True。
training (bool，可選，預設為 False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
mc_token_ids (tf.Tensor 或 Numpy 陣列，形狀為 (batch_size, num_choices)，可選，預設為輸入最後一個標記的索引) — 每個輸入序列中分類標記的索引。選自範圍 [0, input_ids.size(-1) - 1]。

transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或 tuple(tf.Tensor)

一個 transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (GPT2Config) 和輸入而定的各種元素。

logits (tf.Tensor，形狀為 (batch_size, num_choices, sequence_length, config.vocab_size)) — 語言建模頭的預測分數（SoftMax 之前的每個詞彙標記的分數）。
mc_logits (tf.Tensor，形狀為 (batch_size, num_choices)) — 多項選擇分類頭的預測分數（SoftMax 之前的每個選項的分數）。
past_key_values (list[tf.Tensor], 可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tf.Tensor 列表，每個張量的形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(tf.Tensor), 可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — tf.Tensor 的元組（一個用於嵌入層的輸出 + 每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(tf.Tensor), 可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

TFGPT2DoubleHeadsModel 的前向方法重寫了 __call__ 特殊方法。

示例

>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFGPT2DoubleHeadsModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2DoubleHeadsModel.from_pretrained("openai-community/gpt2")

>>> # Add a [CLS] to the vocabulary (we should train it also!)
>>> num_added_tokens = tokenizer.add_special_tokens({"cls_token": "[CLS]"})

>>> embedding_layer = model.resize_token_embeddings(
...     len(tokenizer)
... )  # Update the model embeddings with the new vocabulary size

>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> encoded_choices = [tokenizer.encode(s) for s in choices]
>>> cls_token_location = [tokens.index(tokenizer.cls_token_id) for tokens in encoded_choices]

>>> input_ids = tf.constant(encoded_choices)[None, :]  # Batch size: 1, number of choices: 2
>>> mc_token_ids = tf.constant([cls_token_location])  # Batch size: 1

>>> outputs = model(input_ids, mc_token_ids=mc_token_ids)
>>> lm_prediction_scores, mc_prediction_scores = outputs[:2]

TFGPT2ForSequenceClassification

class transformers.TFGPT2ForSequenceClassification

( config *inputs **kwargs )

引數

config (GPT2Config) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

GPT2 模型 Transformer，頂部帶有一個序列分類頭（線性層）。

TFGPT2ForSequenceClassification 使用最後一個標記進行分類，與其他因果模型（例如 GPT-1）的做法相同。

此模型繼承自 TFPreTrainedModel。請檢視超類的文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭等）。

這個模型也是 keras.Model 的子類。可以像使用常規的 TF 2.0 Keras 模型一樣使用它，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。

transformers 中的 TensorFlow 模型和層接受兩種輸入格式

所有輸入作為關鍵字引數（如 PyTorch 模型），或
所有輸入作為第一個位置引數中的列表、元組或字典。

只有一個 input_ids 的單個張量，沒有其他：model(input_ids)
長度可變的列表，包含一個或多個輸入張量，按文件字串中給出的順序：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
一個字典，其中包含一個或多個與文件字串中給出的輸入名稱關聯的輸入張量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

請注意，當使用子類化建立模型和層時，您無需擔心這些問題，因為您可以像呼叫任何其他 Python 函式一樣傳遞輸入！

呼叫

( input_ids: TFModelInputType | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或 tuple(tf.Tensor)

引數

input_ids (Numpy 陣列 或 tf.Tensor，形狀為 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 為 None，否則為 past_key_values[0].shape[-2] (輸入過去鍵值狀態的 sequence_length)。詞彙表中輸入序列標記的索引。

如果使用了 past_key_values，則只有那些沒有計算過其過去狀態的輸入 ID 才應作為 input_ids 傳遞。

索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什麼是輸入 ID？
past_key_values (list[tf.Tensor]，長度為 config.n_layers) — 包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（參見下面的 past_key_values 輸出）。可用於加速順序解碼。已將過去狀態提供給該模型的標記 ID 不應作為輸入 ID 傳遞，因為它們已經被計算過。
attention_mask (tf.Tensor 或 Numpy 陣列，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
如果使用 past_key_values，attention_mask 需要包含用於 past_key_values 的掩碼策略。換句話說，attention_mask 的長度必須始終為：len(past_key_values) + len(input_ids)

什麼是注意力掩碼？
token_type_ids (tf.Tensor 或 Numpy 陣列，形狀為 (batch_size, input_ids_length)，可選) — 用於指示輸入的第一和第二部分的片段標記索引。索引選自 [0, 1]：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
什麼是標記型別 ID？
position_ids (tf.Tensor 或 Numpy 陣列，形狀為 (batch_size, input_ids_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍 [0, config.max_position_embeddings - 1]。

什麼是位置 ID？
head_mask (Numpy 陣列 或 tf.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：
- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
inputs_embeds (tf.Tensor，形狀為 (batch_size, input_ids_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為相關向量，這將非常有用。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在 Eager 模式下使用，在圖模式下該值將始終設定為 True。
training (bool，可選，預設為 False) — 是否在訓練模式下使用模型（一些模組如 dropout 模組在訓練和評估之間有不同的行為）。
labels (tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算交叉熵分類損失的標籤。索引應在 [0, ..., config.vocab_size - 1] 範圍內。

transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或 tuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (GPT2Config) 和輸入而定的各種元素。

loss (tf.Tensor，形狀為 (batch_size, )，可選，當提供 labels 時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。
logits (tf.Tensor，形狀為 (batch_size, config.num_labels)) — 分類（或迴歸，如果 config.num_labels==1）分數（SoftMax 之前）。
past_key_values (list[tf.Tensor], 可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tf.Tensor 列表，每個張量的形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(tf.Tensor), 可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — tf.Tensor 的元組（一個用於嵌入層的輸出 + 每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(tf.Tensor), 可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

TFGPT2ForSequenceClassification 的前向方法重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFGPT2ForSequenceClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/DialogRPT-updown")
>>> model = TFGPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")

>>> logits = model(**inputs).logits

>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = TFGPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss

TFSequenceClassifierOutputWithPast

class transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast

( loss: tf.Tensor | None = None logits: Optional[tf.Tensor] = None past_key_values: list[tf.Tensor] | None = None hidden_states: tuple[tf.Tensor] | None = None attentions: tuple[tf.Tensor] | None = None )

引數

loss (tf.Tensor，形狀為 (batch_size, )，可選，當提供 labels 時返回) — 分類（如果 config.num_labels==1，則為迴歸）損失。
logits (tf.Tensor，形狀為 (batch_size, config.num_labels)) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。
past_key_values (list[tf.Tensor]，可選，當傳遞 use_cache=True 或當 config.use_cache=True 時返回) — tf.Tensor 列表，長度為 config.n_layers，每個張量的形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

包含預計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(tf.Tensor)，可選，當傳遞 output_hidden_states=True 或當 config.output_hidden_states=True 時返回) — tf.Tensor 的元組（一個用於嵌入的輸出 + 一個用於每層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每層輸出處的隱藏狀態以及初始嵌入輸出。
attentions (tuple(tf.Tensor)，可選，當傳遞 output_attentions=True 或當 config.output_attentions=True 時返回) — tf.Tensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 之後的注意力權重，用於計算自注意力頭中的加權平均值。

句子分類模型輸出的基類。

TFGPT2Tokenizer

class transformers.TFGPT2Tokenizer

( vocab: dict merges: list max_length: typing.Optional[int] = None pad_token_id: typing.Optional[int] = None )

引數

vocab (dict[str, int]) — 用於位元組對編碼器的詞彙字典
merges (list[str]) — 用於位元組對編碼器的合併列表

這是一個用於 GPT2 的圖內分詞器。它應該像其他分詞器一樣，使用 from_pretrained() 方法進行初始化。它也可以使用 from_tokenizer() 方法進行初始化，該方法從現有的標準分詞器物件匯入設定。

圖內分詞器與其他 Hugging Face 分詞器不同，它們實際上是 Keras 層，設計用於在呼叫模型時執行，而不是在預處理期間。因此，它們的選項比標準分詞器類要有限。當您想建立一個從 tf.string 輸入直接到輸出的端到端模型時，它們最有用。

from_config

( config )

引數

config (Dict) — 包含鍵的字典，如 `get_config` 中所述。

從配置建立 TFGPT2Tokenizer

from_pretrained

( pretrained_model_name_or_path: typing.Union[str, os.PathLike] *init_inputs **kwargs )

引數

pretrained_model_name_or_path (Union[str, os.PathLike]) — 預訓練模型的路徑

從預訓練的 GPT2Tokenizer 建立 TFGPT2Tokenizer

示例

from transformers import TFGPT2Tokenizer

tf_tokenizer = TFGPT2Tokenizer.from_pretrained("openai-community/gpt2")

from_tokenizer

( tokenizer: GPT2Tokenizer *args **kwargs )

引數

tokenizer (GPT2Tokenizer) —

從 GPT2Tokenizer 建立 TFGPT2Tokenizer

示例

from transformers import AutoTokenizer, TFGPT2Tokenizer

tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
tf_tokenizer = TFGPT2Tokenizer.from_tokenizer(tokenizer)

JAX

隱藏 JAX 內容

FlaxGPT2Model

class transformers.FlaxGPT2Model

( config: GPT2Config input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

引數

config (GPT2Config) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32、jax.numpy.float16（在 GPU 上）和 jax.numpy.bfloat16（在 TPU 上）之一。

這可用於在 GPU 或 TPU 上啟用混合精度訓練或半精度推理。如果指定，所有計算都將使用給定的 `dtype` 執行。

請注意，這僅指定計算的 dtype，不影響模型引數的 dtype。

如果你希望更改模型引數的 dtype，請參閱 to_fp16() 和 to_bf16()。

這是一個基礎的 GPT2 模型 Transformer，它輸出原始的隱藏狀態，頂部沒有任何特定的頭。

該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 Flax Linen flax.nn.Module 的子類。可以像常規 Flax 模組一樣使用它，並參考 Flax 文件瞭解所有與常規用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call

( input_ids attention_mask = None position_ids = None encoder_hidden_states: typing.Optional[jax.Array] = None encoder_attention_mask: typing.Optional[jax.Array] = None params: typing.Optional[dict] = None past_key_values: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

引數

input_ids (numpy.ndarray，形狀為 (batch_size, input_ids_length)) — input_ids_length = sequence_length。詞彙表中輸入序列標記的索引。

索引可以使用 AutoTokenizer 獲得。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是輸入 ID？
attention_mask (numpy.ndarray，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：
- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
什麼是注意力掩碼？
position_ids (numpy.ndarray，形狀為 (batch_size, input_ids_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選值範圍為 [0, config.max_position_embeddings - 1]。
past_key_values (dict[str, np.ndarray], 可選, 由 init_cache 返回或在傳遞先前的 past_key_values 時返回) — 包含預計算的隱藏狀態（注意力塊中的鍵和值）的字典，可用於快速自迴歸解碼。預計算的鍵和值隱藏狀態的形狀為 [batch_size, max_length]。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多細節請參閱返回張量下的 attentions。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多細節請參閱返回張量下的 hidden_states。
return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置（GPT2Config）和輸入。

last_hidden_state (形狀為 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray) — 模型最後一層輸出的隱藏狀態序列。

如果使用了 past_key_values，則只輸出形狀為 (batch_size, 1, hidden_size) 的序列的最後一個隱藏狀態。
past_key_values (tuple(tuple(jnp.ndarray)), 可選, 當傳遞 use_cache=True 或 config.use_cache=True 時返回) — 長度為 config.n_layers 的 tuple(jnp.ndarray) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量，並且如果 config.is_encoder_decoder=True，則可選地包含 2 個形狀為 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加張量。

包含預先計算的隱藏狀態（自注意力塊中的鍵和值，如果 config.is_encoder_decoder=True，則可選地包含交叉注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。
hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — jnp.ndarray 元組（一個用於嵌入層的輸出，一個用於每個層的輸出），形狀為 (batch_size, sequence_length, hidden_size)。

模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — jnp.ndarray 元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
cross_attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=True 且 config.add_cross_attention=True 或 config.output_attentions=True 時返回) — jnp.ndarray 元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

FlaxGPT2PreTrainedModel 的前向方法會覆蓋 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxGPT2Model

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = FlaxGPT2Model.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

FlaxGPT2LMHeadModel

class transformers.FlaxGPT2LMHeadModel

( config: GPT2Config input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

引數

config (GPT2Config) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32、jax.numpy.float16（在 GPU 上）和 jax.numpy.bfloat16（在 TPU 上）之一。

這可用於在 GPU 或 TPU 上啟用混合精度訓練或半精度推理。如果指定，所有計算都將使用給定的 `dtype` 執行。

請注意，這僅指定計算的 dtype，不影響模型引數的 dtype。

如果你希望更改模型引數的 dtype，請參閱 to_fp16() 和 to_bf16()。

GPT2 Transformer 模型，頂部帶有一個語言建模頭（線性層，權重與輸入嵌入繫結）。

該模型繼承自 FlaxPreTrainedModel。請檢視超類文件，瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

該模型也是 Flax Linen flax.nn.Module 的子類。可以像常規 Flax 模組一樣使用它，並參考 Flax 文件瞭解所有與常規用法和行為相關的事項。

最後，此模型支援固有的 JAX 功能，例如

call