Transformers 文件
FlauBERT
並獲得增強的文件體驗
開始使用
FlauBERT
概述
FlauBERT 模型由 Hang Le 等人在論文 《FlauBERT: Unsupervised Language Model Pre-training for French》 中提出。它是一個使用掩碼語言建模（MLM）目標（如 BERT）進行預訓練的 Transformer 模型。
論文摘要如下：
語言模型已成為在許多不同自然語言處理 (NLP) 任務中取得最新成果的關鍵步驟。利用當今可用的大量未標記文字，它們提供了一種有效的方法來預訓練連續詞表示，這些表示可以為下游任務進行微調，並在句子層面進行情境化。這一點已在英語中透過情境化表示得到了廣泛證明 (Dai and Le, 2015; Peters et al., 2018; Howard and Ruder, 2018; Radford et al., 2018; Devlin et al., 2019; Yang et al., 2019b)。在本文中，我們介紹並分享了 FlauBERT，這是一個在非常龐大且異構的法語語料庫上學習的模型。不同大小的模型使用新的 CNRS（法國國家科學研究中心）Jean Zay 超級計算機進行訓練。我們將我們的法語語言模型應用於各種 NLP 任務（文字分類、釋義、自然語言推理、解析、詞義消歧），並表明它們在大多數情況下優於其他預訓練方法。不同版本的 FlauBERT 以及一個名為 FLUE (French Language Understanding Evaluation) 的統一下游任務評估協議已與研究社群共享，以便在法語 NLP 中進行進一步的可復現實驗。
技巧
- 與 RoBERTa 類似，但沒有句子順序預測（因此僅在 MLM 目標上進行訓練）。
資源
FlaubertConfig
class transformers.FlaubertConfig
< 來源 >( pre_norm = False layerdrop = 0.0 vocab_size = 30145 emb_dim = 2048 n_layers = 12 n_heads = 16 dropout = 0.1 attention_dropout = 0.1 gelu_activation = True sinusoidal_embeddings = False causal = False asm = False n_langs = 1 use_lang_emb = True max_position_embeddings = 512 embed_init_std = 0.02209708691207961 layer_norm_eps = 1e-12 init_std = 0.02 bos_index = 0 eos_index = 1 pad_index = 2 unk_index = 3 mask_index = 5 is_encoder = True summary_type = 'first' summary_use_proj = True summary_activation = None summary_proj_to_labels = True summary_first_dropout = 0.1 start_n_top = 5 end_n_top = 5 mask_token_id = 0 lang_id = 0 pad_token_id = 2 bos_token_id = 0 **kwargs )
引數
- pre_norm (
bool, 可選, 預設為False) — 是否在每層的注意力之後的（Vaswani et al., Tensor2Tensor for Neural Machine Translation. 2018）前饋層之前或之後應用層歸一化。 - layerdrop (
float, 可選, 預設為 0.0) — 在訓練期間丟棄層的機率（Fan et al., Reducing Transformer Depth on Demand with Structured Dropout. ICLR 2020）。 - vocab_size (
int, 可選, 預設為 30145) — FlauBERT 模型的詞彙表大小。定義了在呼叫 FlaubertModel 或 TFFlaubertModel 時，可以透過inputs_ids表示的不同詞元數量。 - emb_dim (
int, 可選, 預設為 2048) — 編碼器層和池化層的維度。 - n_layer (
int, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數。 - n_head (
int, 可選, 預設為 16) — Transformer 編碼器中每個注意力層的注意力頭數。 - dropout (
float, 可選, 預設為 0.1) — 嵌入層、編碼器和池化層中所有全連線層的丟棄機率。 - attention_dropout (
float, 可選, 預設為 0.1) — 注意力機制的丟棄機率。 - gelu_activation (
bool, 可選, 預設為True) — 是否使用 gelu 啟用函式而不是 relu。 - sinusoidal_embeddings (
bool, 可選, 預設為False) — 是否使用正弦位置嵌入而不是絕對位置嵌入。 - causal (
bool, 可選, 預設為False) — 模型是否應以因果方式執行。因果模型使用三角形注意力掩碼，以便只關注左側上下文，而不是雙向上下文。 - asm (
bool, 可選, 預設為False) — 是否使用自適應對數 softmax 投影層，而不是線性層作為預測層。 - n_langs (
int, 可選, 預設為 1) — 模型處理的語言數量。對於單語模型，設定為 1。 - use_lang_emb (
bool, 可選, 預設為True) — 是否使用語言嵌入。一些模型使用額外的語言嵌入，有關如何使用它們的資訊，請參閱多語言模型頁面。 - max_position_embeddings (
int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常將其設定為較大的值，以防萬一（例如，512、1024 或 2048）。 - embed_init_std (
float, 可選, 預設為 2048^-0.5) — 用於初始化嵌入矩陣的 truncated_normal_initializer 的標準差。 - init_std (
int, 可選, 預設為 50257) — 用於初始化除嵌入矩陣外的所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - bos_index (
int, 可選, 預設為 0) — 詞彙表中句子開頭詞元的索引。 - eos_index (
int, 可選, 預設為 1) — 詞彙表中句子結尾詞元的索引。 - pad_index (
int, 可選, 預設為 2) — 詞彙表中填充標記的索引。 - unk_index (
int, 可選, 預設為 3) — 詞彙表中未知標記的索引。 - mask_index (
int, 可選, 預設為 5) — 詞彙表中掩碼標記的索引。 - is_encoder(
bool, 可選, 預設為True) — 初始化的模型是否應為 Vaswani 等人論文中描述的 Transformer 編碼器或解碼器。 - summary_type (
string, 可選, 預設為 “first”) — 用於序列摘要的引數。在序列分類和多項選擇模型中使用。必須是以下選項之一：
"last": 取最後一個標記的隱藏狀態（類似 XLNet）。"first": 取第一個標記的隱藏狀態（類似 BERT）。"mean": 取所有標記隱藏狀態的平均值。"cls_index": 提供一個分類標記位置的張量（類似 GPT/GPT-2）。"attn": 目前未實現，使用多頭注意力。
- summary_use_proj (
bool, 可選, 預設為True) — 用於序列摘要的引數。在序列分類和多項選擇模型中使用。是否在向量提取後新增投影。
- summary_activation (
str, 可選) — 用於序列摘要的引數。在序列分類和多項選擇模型中使用。傳遞
"tanh"以對輸出應用 tanh 啟用函式，任何其他值都將導致不應用啟用函式。 - summary_proj_to_labels (
bool, 可選, 預設為True) — 在序列分類和多項選擇模型中使用。投影輸出應具有
config.num_labels個類還是config.hidden_size個類。 - summary_first_dropout (
float, 可選, 預設為 0.1) — 在序列分類和多項選擇模型中使用。在投影和啟用後使用的丟棄率。
- start_n_top (
int, 可選, 預設為 5) — 在 SQuAD 評估指令碼中使用。 - end_n_top (
int, 可選, 預設為 5) — 在 SQuAD 評估指令碼中使用。 - mask_token_id (
int, 可選, 預設為 0) — 與具體模型無關的引數，用於在 MLM 上下文中生成文字時識別被掩碼的標記。 - lang_id (
int, 可選, 預設為 1) — 模型使用的語言 ID。此引數用於在給定語言中生成文字。
這是用於儲存 FlaubertModel 或 TFFlaubertModel 配置的配置類。它用於根據指定的引數例項化一個 FlauBERT 模型，定義模型架構。使用預設值例項化配置將產生與 FlauBERT flaubert/flaubert_base_uncased 架構類似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。
FlaubertTokenizer
class transformers.FlaubertTokenizer
< 源 >( vocab_file merges_file do_lowercase = False unk_token = '<unk>' bos_token = '<s>' sep_token = '</s>' pad_token = '<pad>' cls_token = '</s>' mask_token = '<special1>' additional_special_tokens = ['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>'] lang2id = None id2lang = None **kwargs )
引數
- vocab_file (
str) — 詞彙表文件。 - merges_file (
str) — 合併檔案。 - do_lowercase (
bool, 可選, 預設為False) — 控制是否轉為小寫。 - unk_token (
str, 可選, 預設為"<unk>") — 未知標記。詞彙表中不存在的標記無法轉換為 ID，將被設定為此標記。 - bos_token (
str, 可選, 預設為"<s>") — 預訓練期間使用的序列開始標記。可用作序列分類器標記。當使用特殊標記構建序列時，這不是用於序列開始的標記。使用的標記是
cls_token。 - sep_token (
str, 可選, 預設為"</s>") — 分隔符標記，用於從多個序列構建一個序列，例如用於序列分類的兩個序列，或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。 - pad_token (
str, 可選, 預設為"<pad>") — 用於填充的標記，例如當批處理不同長度的序列時。 - cls_token (
str, 可選, 預設為"</s>") — 分類器標記，用於序列分類（對整個序列進行分類，而不是逐個標記分類）。當使用特殊標記構建時，它是序列的第一個標記。 - mask_token (
str, 可選, 預設為"<special1>") — 用於掩碼值的標記。這是使用掩碼語言建模訓練此模型時使用的標記。這是模型將嘗試預測的標記。 - additional_special_tokens (
List[str], 可選, 預設為['<special0>', '<special1>', '<special2>', '<special3>', '<special4>', '<special5>', '<special6>', '<special7>', '<special8>', '<special9>']) — 附加特殊標記列表。 - lang2id (
Dict[str, int], 可選) — 將語言字串識別符號對映到其 ID 的字典。 - id2lang (
Dict[int, str], 可選) — 將語言 ID 對映到其字串識別符號的字典。
構建一個 Flaubert 分詞器。基於位元組對編碼（Byte-Pair Encoding）。分詞過程如下：
- Moses 預處理和分詞。
- 對所有輸入文字進行規範化。
- 引數 `special_tokens` 和函式 `set_special_tokens` 可用於向詞彙表新增額外的符號（如 “classify”）。
- 引數 `do_lowercase` 控制是否轉為小寫（對於預訓練詞彙表會自動設定）。
此分詞器繼承自 PreTrainedTokenizer，其中包含大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線和新增特殊詞元，為序列分類任務從一個序列或一對序列構建模型輸入。XLM 序列具有以下格式
- 單個序列：
<s> X </s> - 序列對：
<s> A </s> B </s>
將標記序列（字串）轉換為單個字串。
get_special_tokens_mask
< 源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。
FlaubertModel
class transformers.FlaubertModel
< 源 >( config )
引數
- config (FlaubertModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
原始的 Flaubert 模型，輸出原始的隱藏狀態，沒有任何特定的頭部。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch Module 一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None lengths: typing.Optional[torch.LongTensor] = None cache: typing.Optional[dict[str, torch.FloatTensor]] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length), 可選) — 掩碼，用於避免對填充標記索引執行注意力操作。掩碼值在 `[0, 1]` 中選擇：- 1 表示標記未被掩碼,
- 0 表示標記被掩碼。
- langs (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 一個並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映（僅為多語言模型提供）從語言名稱中獲取。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id（一個字串到整數的字典）中，而 語言 ID 到語言名稱 的對映在model.config.id2lang（一個整數到字串的字典）中。請參閱 多語言文件 中詳細的用法示例。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 `[0, 1]` 中選擇：- 0 對應於 句子 A 的標記,
- 1 對應於 句子 B 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列標記的位置索引。在 `[0, config.n_positions - 1]` 範圍內選擇。 - lengths (
torch.LongTensor，形狀為(batch_size,), 可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力操作。您也可以使用 `attention_mask` 達到同樣的效果（見上文），此處保留是為了相容性。索引在 `[0, ..., input_ids.size(-1)]` 中選擇： - cache (
dict[str, torch.FloatTensor], 可選) — 包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）的字串到 `torch.FloatTensor` 的字典（請參閱下面的 `cache` 輸出）。可用於加速順序解碼。字典物件將在前向傳遞期間就地修改以新增新計算的隱藏狀態。 - 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` 索引轉換為關聯向量，這將非常有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（FlaubertConfig）和輸入包含各種元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaubertModel 的前向方法，覆蓋了 `__call__` 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
FlaubertWithLMHeadModel
class transformers.FlaubertWithLMHeadModel
< source >( config )
引數
- config (FlaubertWithLMHeadModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert Transformer 模型，其頂部帶有一個語言建模頭（一個權重與輸入嵌入繫結的線性層）。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch Module 一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力機制的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記被掩碼。
- langs (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 一個並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲取（僅為多語言模型提供）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id中（這是一個字串到整數的字典），而語言 ID 到語言名稱的對映在model.config.id2lang中（這是一個整數到字串的字典）。請參閱多語言文件中詳細的使用示例。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於句子 A 的標記，
- 1 對應於句子 B 的標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在範圍[0, config.n_positions - 1]內選擇。 - lengths (
torch.LongTensor，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力機制。你也可以使用attention_mask達到相同的結果（見上文），此處保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇： - cache (
dict[str, torch.FloatTensor]，可選) — 字串到torch.FloatTensor的字典，其中包含模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（請參閱下面的cache輸出）。可用於加速順序解碼。字典物件將在前向傳遞期間被就地修改，以新增新計算的隱藏狀態。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭被掩碼。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為關聯向量，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 語言建模的標籤。請注意，標籤在模型內部會被移位，即你可以設定labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中選擇。所有設定為-100的標籤都會被忽略（掩碼），損失僅針對[0, ..., config.vocab_size]中的標籤計算。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MaskedLMOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（FlaubertConfig）和輸入，包含各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 掩碼語言建模 (MLM) 損失。 -
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時返回) — `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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaubertWithLMHeadModel 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertWithLMHeadModel
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertWithLMHeadModel.from_pretrained("flaubert/flaubert_base_uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logitsFlaubertForSequenceClassification
class transformers.FlaubertForSequenceClassification
< source >( config )
引數
- config (FlaubertForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert 模型，其頂部帶有一個序列分類/迴歸頭（一個在池化輸出之上的線性層），例如用於 GLUE 任務。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch Module 一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力機制的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記被掩碼。
- langs (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 一個並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲取（僅為多語言模型提供）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id中（這是一個字串到整數的字典），而語言 ID 到語言名稱的對映在model.config.id2lang中（這是一個整數到字串的字典）。請參閱多語言文件中詳細的使用示例。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於句子 A 的標記，
- 1 對應於句子 B 的標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在範圍[0, config.n_positions - 1]內選擇。 - lengths (
torch.LongTensor，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力機制。你也可以使用 attention_mask 達到相同的結果（見上文），此處保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇。 - cache (
dict[str, torch.FloatTensor]，可選) — 字串到torch.FloatTensor的字典，其中包含模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（請參閱下面的cache輸出）。可用於加速順序解碼。字典物件將在前向傳遞期間被就地修改，以新增新計算的隱藏狀態。
- head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭被掩碼。
- inputs_embeds (
torch.Tensor，形狀為(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，則計算分類損失（交叉熵）。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（FlaubertConfig）和輸入，包含各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaubertForSequenceClassification 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_uncased")
>>> 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 = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_uncased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, FlaubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_uncased", 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 = FlaubertForSequenceClassification.from_pretrained(
... "flaubert/flaubert_base_uncased", 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).lossFlaubertForMultipleChoice
class transformers.FlaubertForMultipleChoice
< source >( config *inputs **kwargs )
引數
- config (FlaubertForMultipleChoice) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert 模型，其頂部帶有一個多項選擇分類頭（一個在池化輸出之上的線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch Module 一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力機制的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記被掩碼。
- langs (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 一個並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲取（僅為多語言模型提供）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id中（這是一個字串到整數的字典），而語言 ID 到語言名稱的對映在model.config.id2lang中（這是一個整數到字串的字典）。請參閱多語言文件中詳細的使用示例。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 句子 A 的標記，
- 1 對應於 句子 B 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - lengths (
torch.LongTensor，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力計算。您也可以使用 attention_mask 達到同樣的效果（見上文），此處保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇。 - cache (
dict[str, torch.FloatTensor]，可選) — 從字串到torch.FloatTensor的字典，包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（請參閱下文的cache輸出）。可用於加速順序解碼。該字典物件將在前向傳播過程中被就地修改，以新增新計算的隱藏狀態。
- head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示該頭未被遮蔽，
- 0 表示該頭被遮蔽。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, num_choices, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算多項選擇分類損失的標籤。索引應在[0, ..., num_choices-1]範圍內，其中num_choices是輸入張量第二維度的大小。（參見上文的input_ids） - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。更多詳情請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MultipleChoiceModelOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（FlaubertConfig）和輸入的不同元素。
-
loss (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（SoftMax 之前）。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaubertForMultipleChoice 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaubertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForMultipleChoice.from_pretrained("flaubert/flaubert_base_uncased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsFlaubertForTokenClassification
class transformers.FlaubertForTokenClassification
< 原始碼 >( config )
引數
- config (FlaubertForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert Transformer 模型，其頂部帶有一個標記分類頭（一個在隱藏狀態輸出之上的線性層），例如用於命名實體識別（NER）任務。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch Module 一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = 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.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
- langs (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 與輸入並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩種轉換對映（僅為多語言模型提供）從語言名稱中獲取。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id（這是一個字串到整數的字典）中，而 語言 ID 到語言名稱 的對映在model.config.id2lang（整數到字串的字典）中。請參閱多語言文件中詳細的用法示例。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 句子 A 的標記，
- 1 對應於 句子 B 的標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - lengths (
torch.LongTensor，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力計算。您也可以使用 attention_mask 達到同樣的效果（見上文），此處保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇。 - cache (
dict[str, torch.FloatTensor]，可選) — 從字串到torch.FloatTensor的字典，包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（請參閱下文的cache輸出）。可用於加速順序解碼。該字典物件將在前向傳播過程中被就地修改，以新增新計算的隱藏狀態。
- head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示該頭未被遮蔽，
- 0 表示該頭被遮蔽。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算標記分類損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。 - 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），包含根據配置（FlaubertConfig）和輸入的不同元素。
-
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時返回) — `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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaubertForTokenClassification 的 forward 方法重寫了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaubertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForTokenClassification.from_pretrained("flaubert/flaubert_base_uncased")
>>> 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)
...FlaubertForQuestionAnsweringSimple
class transformers.FlaubertForQuestionAnsweringSimple
< 原始碼 >( config )
引數
- config (FlaubertForQuestionAnsweringSimple) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert 模型，頂部帶有一個片段分類頭，用於像 SQuAD 這樣的抽取式問答任務（一個在隱藏狀態輸出之上的線性層，用於計算 span start logits 和 span end logits）。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch Module 一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = 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.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
- langs (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 與輸入並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩種轉換對映（僅為多語言模型提供）從語言名稱中獲取。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id（這是一個字串到整數的字典）中，而 語言 ID 到語言名稱 的對映在model.config.id2lang（整數到字串的字典）中。請參閱多語言文件中詳細的用法示例。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 句子 A 的標記，
- 1 對應於 句子 B 的標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - lengths (
torch.LongTensor，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力計算。您也可以使用 attention_mask 達到同樣的效果（見上文），此處保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇。 - cache (
dict[str, torch.FloatTensor]，可選) — 從字串到torch.FloatTensor的字典，包含由模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（請參閱下文的cache輸出）。可用於加速順序解碼。該字典物件將在前向傳播過程中被就地修改，以新增新計算的隱藏狀態。
- head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示該頭未被遮蔽，
- 0 表示該頭被遮蔽。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這將非常有用。 - start_positions (
torch.Tensor，形狀為(batch_size,)，可選) — 標記的片段開始位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不予考慮。 - end_positions (
torch.Tensor，形狀為(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），包含根據配置（FlaubertConfig）和輸入的不同元素。
-
loss (
torch.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
The FlaubertForQuestionAnsweringSimple forward method, overrides the __call__ special method.
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaubertForQuestionAnsweringSimple
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_uncased")
>>> model = FlaubertForQuestionAnsweringSimple.from_pretrained("flaubert/flaubert_base_uncased")
>>> 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)
...FlaubertForQuestionAnswering
class transformers.FlaubertForQuestionAnswering
< 原始碼 >( config )
引數
- config (FlaubertForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有一個用於抽取式問答任務（如 SQuAD）的片段分類頭部的 Flaubert transformer（在隱藏狀態輸出之上新增一個線性層，用於計算 `片段開始 logits` 和 `片段結束 logits`）。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch Module 一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None langs: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None lengths: typing.Optional[torch.Tensor] = None cache: typing.Optional[dict[str, torch.Tensor]] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None is_impossible: typing.Optional[torch.Tensor] = None cls_index: typing.Optional[torch.Tensor] = None p_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- langs (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 與輸入並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲得（僅適用於多語言模型）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id（一個字串到整數的字典）中，而語言 ID 到語言名稱 的對映在model.config.id2lang（一個整數到字串的字典）中。有關用法示例，請參閱多語言文件。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 *A 句* 標記，
- 1 對應於 *B 句* 標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - lengths (
torch.LongTensor，形狀為(batch_size,), 可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力。你也可以使用 *attention_mask* 達到同樣的效果（見上文），這裡保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇。 - cache (
dict[str, torch.FloatTensor], 可選) — 字串到 `torch.FloatTensor` 的字典，包含模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（見下文 `cache` 輸出）。可用於加速順序解碼。該字典物件將在前向傳播期間就地修改，以新增新計算的隱藏狀態。
- head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以不傳遞 `input_ids`，而是直接傳遞一個嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為關聯向量，這會很有用。 - start_positions (
torch.Tensor，形狀為(batch_size,), 可選) — 標記片段開始位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（`sequence_length`）內。序列外的位置在計算損失時不予考慮。 - end_positions (
torch.Tensor，形狀為(batch_size,), 可選) — 標記片段結束位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（`sequence_length`）內。序列外的位置在計算損失時不予考慮。 - is_impossible (
torch.LongTensor，形狀為(batch_size,), 可選) — 標記問題是否有答案（SQuAD 2.0） - cls_index (
torch.LongTensor，形狀為(batch_size,), 可選) — 分類標記的位置（索引）標籤，用作計算答案合理性的輸入。 - p_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length), 可選) — 不可能出現在答案中的標記的可選掩碼（例如 [CLS], [PAD], …）。1.0 表示標記應被遮蓋。0.0 表示標記未被遮蓋。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的 `attentions`。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的 `hidden_states`。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
一個 transformers.models.flaubert.modeling_flaubert.FlaubertForQuestionAnsweringOutput 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（FlaubertConfig）和輸入，包含各種元素。
-
loss (
torch.FloatTensor，形狀為(1,), 可選, 如果同時提供了 `start_positions` 和 `end_positions`，則返回) — 分類損失，為開始標記、結束標記（以及如果提供，則為 is_impossible）分類損失的總和。 -
start_top_log_probs (
torch.FloatTensor，形狀為(batch_size, config.start_n_top), 可選, 如果未提供 `start_positions` 或 `end_positions`，則返回) — top config.start_n_top 個開始標記可能性的對數機率（束搜尋）。 -
start_top_index (
torch.LongTensor，形狀為(batch_size, config.start_n_top), 可選, 如果未提供 `start_positions` 或 `end_positions`，則返回) — top config.start_n_top 個開始標記可能性的索引（束搜尋）。 -
end_top_log_probs (
torch.FloatTensor，形狀為(batch_size, config.start_n_top * config.end_n_top), 可選, 如果未提供 `start_positions` 或 `end_positions`，則返回) — top `config.start_n_top * config.end_n_top` 個結束標記可能性的對數機率（束搜尋）。 -
end_top_index (
torch.LongTensor，形狀為(batch_size, config.start_n_top * config.end_n_top), 可選, 如果未提供 `start_positions` 或 `end_positions`，則返回) — top `config.start_n_top * config.end_n_top` 個結束標記可能性的索引（束搜尋）。 -
cls_logits (
torch.FloatTensor，形狀為(batch_size,), 可選, 如果未提供 `start_positions` 或 `end_positions`，則返回) — 答案的 `is_impossible` 標籤的對數機率。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaubertForQuestionAnswering 的前向方法，重寫了 `__call__` 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FlaubertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> model = FlaubertForQuestionAnswering.from_pretrained("FacebookAI/xlm-mlm-en-2048")
>>> input_ids = torch.tensor(tokenizer.encode("Hello, my dog is cute", add_special_tokens=True)).unsqueeze(
... 0
... ) # Batch size 1
>>> start_positions = torch.tensor([1])
>>> end_positions = torch.tensor([3])
>>> outputs = model(input_ids, start_positions=start_positions, end_positions=end_positions)
>>> loss = outputs.lossTFFlaubertModel
class transformers.TFFlaubertModel
< 原始碼 >( config *inputs **kwargs )
引數
- config (FlaubertConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
裸 Flaubert 模型 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: np.ndarray | tf.Tensor | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: tf.Tensor | None = 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.TFBaseModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy 陣列或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 陣列或tf.Tensor，形狀為(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：1表示標記未被遮蓋，0表示標記被遮蓋。
- langs (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length), 可選) — 與輸入並行的標記序列，用於指示輸入中每個標記的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲得（僅適用於多語言模型）。更準確地說，語言名稱到語言 ID 的對映在 `model.config.lang2id`（一個字串到整數的字典）中，而語言 ID 到語言名稱 的對映在 `model.config.id2lang`（一個整數到字串的字典）中。有關用法示例，請參閱多語言文件。
- token_type_ids (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length), 可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：0對應於 *A 句* 標記，1對應於 *B 句* 標記。
- position_ids (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - lengths (
tf.Tensor或Numpy 陣列，形狀為(batch_size,), 可選) — 每個句子的長度，可用於避免對填充標記索引執行注意力。你也可以使用 *attention_mask* 達到同樣的效果（見上文），這裡保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇： - cache (
dict[str, tf.Tensor], 可選) — 字串到 `tf.FloatTensor` 的字典，包含模型計算的預計算隱藏狀態（注意力塊中的鍵和值）（見下文 `cache` 輸出）。可用於加速順序解碼。該字典物件將在前向傳播期間就地修改，以新增新計算的隱藏狀態。
- head_mask (
Numpy 陣列或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在[0, 1]中選擇：1表示頭未被遮蓋，0表示頭被遮蓋。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以不傳遞 `input_ids`，而是直接傳遞一個嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為關聯向量，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的 `attentions`。此引數只能在 eager 模式下使用，在 graph 模式下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的 `hidden_states`。此引數只能在 eager 模式下使用，在 graph 模式下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在 eager 模式下使用，在 graph 模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為 `False`) — 是否將模型用於訓練模式（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFBaseModelOutput 或一個 `tf.Tensor` 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（FlaubertConfig）和輸入，包含各種元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFFlaubertModel 的前向方法，重寫了 `__call__` 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFFlaubertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertModel.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFFlaubertWithLMHeadModel
class transformers.TFFlaubertWithLMHeadModel
< 原始碼 >( config *inputs **kwargs )
引數
- config (FlaubertConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert 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: np.ndarray | tf.Tensor | None = None attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值選自[0, 1]：1表示詞元未被遮蓋，0表示詞元被遮蓋。
- langs (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 一個並行的詞元序列，用於指示輸入中每個詞元的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲得（僅提供給多語言模型）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id中（這是一個字串到整數的字典），而 語言 ID 到語言名稱 的對映在model.config.id2lang中（這是一個整數到字串的字典）。請參閱多語言文件中詳細的用法示例。
- token_type_ids (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 片段詞元索引，用於指示輸入的第一部分和第二部分。索引選自[0, 1]：0對應於一個 句子 A 的詞元，1對應於一個 句子 B 的詞元。
- position_ids (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - lengths (
tf.Tensor或Numpy array，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充詞元索引執行注意力操作。你也可以使用 attention_mask 達到相同的結果（見上文），這裡保留是為了相容性。索引選自[0, ..., input_ids.size(-1)]： - cache (
dict[str, tf.Tensor]，可選) — 包含預計算隱藏狀態（注意力塊中的鍵和值）的字串到tf.FloatTensor的字典，由模型計算得出（見下文cache輸出）。可用於加速序列解碼。該字典物件將在前向傳播過程中被就地修改，以新增新計算的隱藏狀態。
- head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自[0, 1]：1表示頭未被遮蓋，0表示頭被遮蓋。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關聯的向量，這會非常有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool，可選，預設為False) — 是否在訓練模式下使用模型（某些模組，如 dropout 模組，在訓練和評估之間的行為不同）。
返回
transformers.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput 或 tuple(tf.Tensor)
一個 transformers.models.flaubert.modeling_tf_flaubert.TFFlaubertWithLMHeadModelOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置 (FlaubertConfig) 和輸入。
-
logits (
tf.Tensorof 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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFFlaubertWithLMHeadModel 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFFlaubertWithLMHeadModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertWithLMHeadModel.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFFlaubertForSequenceClassification
class transformers.TFFlaubertForSequenceClassification
< 來源 >( config *inputs **kwargs )
引數
- config (FlaubertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert 模型，其頂部帶有一個序列分類/迴歸頭（一個在池化輸出之上的線性層），例如用於 GLUE 任務。
該模型繼承自 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 attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = 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: bool = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值選自[0, 1]：1表示詞元未被遮蓋，0表示詞元被遮蓋。
- langs (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 一個並行的詞元序列，用於指示輸入中每個詞元的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲得（僅提供給多語言模型）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id中（這是一個字串到整數的字典），而 語言 ID 到語言名稱 的對映在model.config.id2lang中（這是一個整數到字串的字典）。請參閱多語言文件中詳細的用法示例。
- token_type_ids (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 片段詞元索引，用於指示輸入的第一部分和第二部分。索引選自[0, 1]：0對應於一個 句子 A 的詞元，1對應於一個 句子 B 的詞元。
- position_ids (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - lengths (
tf.Tensor或Numpy array，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充詞元索引執行注意力操作。你也可以使用 attention_mask 達到相同的結果（見上文），這裡保留是為了相容性。索引選自[0, ..., input_ids.size(-1)]： - cache (
dict[str, tf.Tensor]，可選) — 包含預計算隱藏狀態（注意力塊中的鍵和值）的字串到tf.FloatTensor的字典，由模型計算得出（見下文cache輸出）。可用於加速序列解碼。該字典物件將在前向傳播過程中被就地修改，以新增新計算的隱藏狀態。
- head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自[0, 1]：1表示頭未被遮蓋，0表示頭被遮蓋。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關聯的向量，這會非常有用。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool，可選，預設為False) — 是否在訓練模式下使用模型（某些模組，如 dropout 模組，在訓練和評估之間的行為不同）。 - labels (
tf.Tensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置 (FlaubertConfig) 和輸入。
-
loss (
tf.Tensor，形狀為(batch_size, )，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (
tf.Tensor，形狀為(batch_size, config.num_labels)) — 分類（或迴歸，如果 config.num_labels==1）分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFFlaubertForSequenceClassification 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_cased")
>>> 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 = TFFlaubertForSequenceClassification.from_pretrained("flaubert/flaubert_base_cased", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFFlaubertForMultipleChoice
class transformers.TFFlaubertForMultipleChoice
< 來源 >( config *inputs **kwargs )
引數
- config (FlaubertConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有多項選擇分類頭的 Flaubert 模型（在池化輸出之上有一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 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 attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = 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: bool = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值選自[0, 1]：1表示詞元未被遮蓋，0表示詞元被遮蓋。
- langs (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 一個並行的詞元序列，用於指示輸入中每個詞元的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲得（僅提供給多語言模型）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id中（這是一個字串到整數的字典），而 語言 ID 到語言名稱 的對映在model.config.id2lang中（這是一個整數到字串的字典）。請參閱多語言文件中詳細的用法示例。
- token_type_ids (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 片段詞元索引，用於指示輸入的第一部分和第二部分。索引選自[0, 1]：0對應於一個 句子 A 的詞元，1對應於一個 句子 B 的詞元。
- position_ids (
tf.Tensor或Numpy array，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。選自範圍[0, config.max_position_embeddings - 1]。 - lengths (
tf.Tensor或Numpy array，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充詞元索引執行注意力操作。你也可以使用 attention_mask 達到相同的結果（見上文），這裡保留是為了相容性。索引選自[0, ..., input_ids.size(-1)]： - cache (
dict[str, tf.Tensor]，可選) — 包含預計算隱藏狀態（注意力塊中的鍵和值）的字串到tf.FloatTensor的字典，由模型計算得出（見下文cache輸出）。可用於加速序列解碼。該字典物件將在前向傳播過程中被就地修改，以新增新計算的隱藏狀態。
- head_mask (
Numpy array或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自[0, 1]：1表示頭未被遮蓋，0表示頭被遮蓋。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關聯的向量，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式（eager mode）下使用，在圖模式（graph mode）下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（FlaubertConfig）和輸入而不同的各種元素。
-
loss (
tf.Tensor，形狀為 (batch_size, )，可選，當提供labels時返回) — 分類損失。 -
logits (
tf.Tensor，形狀為(batch_size, num_choices)) — num_choices 是輸入張量的第二維。（參見上面的 input_ids）。分類分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFFlaubertForMultipleChoice 的前向方法會覆蓋 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForMultipleChoice.from_pretrained("flaubert/flaubert_base_cased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFFlaubertForTokenClassification
class transformers.TFFlaubertForTokenClassification
< 原始碼 >( config *inputs **kwargs )
引數
- config (FlaubertConfig) — 包含模型所有引數的模型配置類。用配置檔案初始化並不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert 模型，其頂部帶有一個詞元分類頭（在隱藏狀態輸出之上加一個線性層），例如用於命名實體識別（NER）任務。
該模型繼承自 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 attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = 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: bool = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy 陣列或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 陣列或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：1表示詞元未被遮蔽，0表示詞元已被遮蔽。
- langs (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length)，可選) — 一個並行的詞元序列，用於指示輸入中每個詞元的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲得（僅為多語言模型提供）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id（這是一個字串到整數的字典）中，而 語言 ID 到語言名稱 的對映在model.config.id2lang（一個整數到字串的字典）中。請參閱 多語言文件 中詳細的使用示例。
- token_type_ids (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length)，可選) — 段詞元索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：0對應於一個 句子 A 的詞元，1對應於一個 句子 B 的詞元。
- position_ids (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - lengths (
tf.Tensor或Numpy 陣列，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充詞元索引執行注意力。你也可以使用 attention_mask 達到相同的結果（見上文），這裡保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇： - cache (
dict[str, tf.Tensor], 可選) — 字串到tf.FloatTensor的字典，其中包含由模型計算的預計算的隱藏狀態（注意力塊中的鍵和值）（見下文cache輸出）。可用於加速順序解碼。在前向傳播過程中，字典物件將被就地修改以新增新計算的隱藏狀態。
- head_mask (
Numpy 陣列或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：1表示頭未被遮蔽，0表示頭已被遮蔽。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關聯的向量，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式（eager mode）下使用，在圖模式（graph mode）下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。 - labels (
tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於計算詞元分類損失的標籤。索引應在[0, ..., config.num_labels - 1]之間。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（FlaubertConfig）和輸入而不同的各種元素。
-
loss (
tf.Tensor，形狀為(n,)，可選，其中 n 是未被掩蓋的標籤數量，當提供labels時返回) — 分類損失。 -
logits (
tf.Tensor，形狀為(batch_size, sequence_length, config.num_labels)) — 分類分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFFlaubertForTokenClassification 的前向方法會覆蓋 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForTokenClassification.from_pretrained("flaubert/flaubert_base_cased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-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] for t in predicted_token_class_ids[0].numpy().tolist()]TFFlaubertForQuestionAnsweringSimple
class transformers.TFFlaubertForQuestionAnsweringSimple
< 原始碼 >( config *inputs **kwargs )
引數
- config (FlaubertConfig) — 包含模型所有引數的模型配置類。用配置檔案初始化並不會載入與模型關聯的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Flaubert 模型，頂部帶有一個區間分類頭，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出之上加一個線性層，用於計算 `span start logits` 和 `span end logits`）。
該模型繼承自 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 attention_mask: np.ndarray | tf.Tensor | None = None langs: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None lengths: np.ndarray | tf.Tensor | None = None cache: Optional[dict[str, tf.Tensor]] = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
引數
- input_ids (
Numpy 陣列或tf.Tensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 陣列或tf.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：1表示詞元未被遮蔽，0表示詞元已被遮蔽。
- langs (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length)，可選) — 一個並行的詞元序列，用於指示輸入中每個詞元的語言。索引是語言 ID，可以透過使用模型配置中提供的兩個轉換對映從語言名稱中獲得（僅為多語言模型提供）。更準確地說，語言名稱到語言 ID 的對映在model.config.lang2id（這是一個字串到整數的字典）中，而 語言 ID 到語言名稱 的對映在model.config.id2lang（一個整數到字串的字典）中。請參閱 多語言文件 中詳細的使用示例。
- token_type_ids (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length)，可選) — 段詞元索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：0對應於一個 句子 A 的詞元，1對應於一個 句子 B 的詞元。
- position_ids (
tf.Tensor或Numpy 陣列，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列詞元在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - lengths (
tf.Tensor或Numpy 陣列，形狀為(batch_size,)，可選) — 每個句子的長度，可用於避免對填充詞元索引執行注意力。你也可以使用 attention_mask 達到相同的結果（見上文），這裡保留是為了相容性。索引在[0, ..., input_ids.size(-1)]中選擇： - cache (
dict[str, tf.Tensor], 可選) — 字串到tf.FloatTensor的字典，其中包含由模型計算的預計算的隱藏狀態（注意力塊中的鍵和值）（見下文cache輸出）。可用於加速順序解碼。在前向傳播過程中，字典物件將被就地修改以新增新計算的隱藏狀態。
- head_mask (
Numpy 陣列或tf.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：1表示頭未被遮蔽，0表示頭已被遮蔽。
- inputs_embeds (
tf.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關聯的向量，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。此引數只能在即時模式（eager mode）下使用，在圖模式（graph mode）下將使用配置中的值。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可以在即時模式（eager mode）下使用，在圖模式（graph mode）下該值將始終設定為 True。 - training (
bool, 可選, 預設為False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。 - start_positions (
tf.Tensor，形狀為(batch_size,)，可選) — 標記區間開始位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（sequence_length）之內。序列之外的位置不計入損失計算。 - end_positions (
tf.Tensor，形狀為(batch_size,)，可選) — 標記區間結束位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（sequence_length）之內。序列之外的位置不計入損失計算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一個 tf.Tensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（FlaubertConfig）和輸入而不同的各種元素。
-
loss (
tf.Tensor，形狀為(batch_size, )，可選，當提供了start_positions和end_positions時返回) — 總的區間提取損失是開始和結束位置的交叉熵之和。 -
start_logits (形狀為
(batch_size, sequence_length)的tf.Tensor) — 跨度起始分數（SoftMax 之前）。 -
end_logits (形狀為
(batch_size, sequence_length)的tf.Tensor) — 跨度結束分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFFlaubertForQuestionAnsweringSimple 的前向方法會覆蓋 __call__ 特殊方法。
雖然前向傳遞的配方需要在此函式內定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, TFFlaubertForQuestionAnsweringSimple
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("flaubert/flaubert_base_cased")
>>> model = TFFlaubertForQuestionAnsweringSimple.from_pretrained("flaubert/flaubert_base_cased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]