Transformers

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]

引數

token_ids_0 (List[int]) — 將要新增特殊詞元的 ID 列表。
token_ids_1 (List[int], optional) — 可選的用於序列對的第二個 ID 列表。

List[int]

帶有適當特殊標記的輸入ID列表。

透過連線和新增特殊標記，從一個序列或一對序列構建用於序列分類任務的模型輸入。BERT 序列的格式如下：

單個序列：[CLS] X [SEP]
序列對：[CLS] A [SEP] B [SEP]

get_special_tokens_mask

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]

引數

token_ids_0 (List[int]) — ID 列表。
token_ids_1 (List[int], optional) — 可選的用於序列對的第二個 ID 列表。
already_has_special_tokens (bool, optional, 預設為 False) — 詞元列表是否已經為模型格式化了特殊詞元。

List[int]

一個範圍為 [0, 1] 的整數列表：1 表示特殊標記，0 表示序列標記。

從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。

create_token_type_ids_from_sequences

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]

引數

token_ids_0 (list[int]) — ID 列表。
token_ids_1 (list[int], optional) — 可選的用於序列對的第二個 ID 列表。

list[int]

根據給定序列的 token type IDs 列表。

根據傳入的兩個序列建立一個掩碼，用於序列對分類任務。一個 Funnel

Transformer 序列對掩碼具有以下格式

2 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1 為 None，則此方法僅返回掩碼的第一部分（0s）。

save_vocabulary

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

FunnelTokenizerFast

class transformers.FunnelTokenizerFast

( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '<unk>' sep_token = '<sep>' pad_token = '<pad>' cls_token = '<cls>' mask_token = '<mask>' bos_token = '<s>' eos_token = '</s>' clean_text = True tokenize_chinese_chars = True strip_accents = None wordpieces_prefix = '##' **kwargs )

引數

vocab_file (str) — 包含詞彙表的檔案。
do_lower_case (bool, optional, 預設為 True) — 是否在分詞時將輸入轉換為小寫。
unk_token (str, optional, 預設為 "<unk>") — 未知詞元。不在詞彙表中的詞元無法轉換成 ID，將被設定為此詞元。
sep_token (str, optional, 預設為 "<sep>") — 分隔符詞元，用於從多個序列構建一個序列時使用，例如用於序列分類的兩個序列，或用於問答的文字和問題。它也用作使用特殊詞元構建的序列的最後一個詞元。
pad_token (str, optional, 預設為 "<pad>") — 用於填充的詞元，例如在批處理不同長度的序列時使用。
cls_token (str, optional, 預設為 "<cls>") — 分類器詞元，用於序列分類（對整個序列進行分類，而不是按詞元分類）。當使用特殊詞元構建序列時，它是序列的第一個詞元。
mask_token (str, optional, 預設為 "<mask>") — 用於掩碼值的詞元。在使用掩碼語言模型訓練此模型時使用此詞元。模型將嘗試預測此詞元。
clean_text (bool, optional, 預設為 True) — 是否在分詞前透過移除任何控制字元並將所有空白替換為經典空格來清理文字。
tokenize_chinese_chars (bool, optional, 預設為 True) — 是否對中文字元進行分詞。對於日語，這可能應該停用（參見此問題）。
bos_token (str, optional, 預設為 "<s>") — 句子開始詞元。
eos_token (str, optional, 預設為 "</s>") — 句子結束詞元。
strip_accents (bool, optional) — 是否移除所有重音符號。如果未指定此選項，則將由 lowercase 的值決定（與原始 BERT 中一樣）。
wordpieces_prefix (str, optional, 預設為 "##") — 子詞的字首。

構建一個“快速”的 Funnel Transformer 分詞器（由 HuggingFace 的 *tokenizers* 庫支援）。基於 WordPiece。

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

build_inputs_with_special_tokens

( token_ids_0 token_ids_1 = None ) → List[int]

引數

token_ids_0 (List[int]) — 將要新增特殊詞元的 ID 列表。
token_ids_1 (List[int], optional) — 可選的用於序列對的第二個 ID 列表。

List[int]

帶有適當特殊標記的輸入ID列表。

透過連線和新增特殊詞元，從一個序列或一對序列構建模型輸入，用於序列分類任務。一個 Funnel 序列具有以下格式

單個序列：[CLS] X [SEP]
序列對：[CLS] A [SEP] B [SEP]

create_token_type_ids_from_sequences

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]

引數

token_ids_0 (list[int]) — ID 列表。
token_ids_1 (list[int], optional) — 可選的用於序列對的第二個 ID 列表。

list[int]

根據給定序列的 token type IDs 列表。

根據傳入的兩個序列建立一個掩碼，用於序列對分類任務。一個 Funnel

Transformer 序列對掩碼具有以下格式

2 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1 為 None，則此方法僅返回掩碼的第一部分（0s）。

Funnel 特定輸出

class transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput

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

引數

loss (*optional*, 當提供 labels 時返回, torch.FloatTensor 形狀為 (1,)) — ELECTRA 式目標的總損失。
logits (torch.FloatTensor 形狀為 (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 之後的注意力權重，用於在自注意力頭中計算加權平均值。

FunnelForPreTraining 的輸出型別。

class transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput

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

引數

logits (tf.Tensor，形狀為 (batch_size, sequence_length)) — 頭的預測分數（在 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 之後的注意力權重，用於在自注意力頭中計算加權平均值。

FunnelForPreTraining 的輸出型別。

Pytorch

隱藏 Pytorch 內容

FunnelBaseModel

class transformers.FunnelBaseModel

( config: FunnelConfig )

引數

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

基礎的 Funnel Transformer 模型，輸出原始的隱藏狀態，沒有上取樣頭（也稱為解碼器）或任何任務特定的頭。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: 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.BaseModelOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。

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

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

什麼是位置 ID？
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 索引轉換為相關向量，這會很有用。
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），根據配置 (FunnelConfig) 和輸入包含不同的元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

FunnelBaseModel 的前向方法，重寫了 `__call__` 特殊方法。

雖然前向傳遞的邏輯需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

示例

>>> from transformers import AutoTokenizer, FunnelBaseModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelBaseModel.from_pretrained("funnel-transformer/small")

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

>>> last_hidden_states = outputs.last_hidden_state

FunnelModel

class transformers.FunnelModel

( config: FunnelConfig )

引數

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

基礎的 Funnel 模型，輸出原始的隱藏狀態，沒有任何特定的頭。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: 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.BaseModelOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。

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

什麼是輸入 ID？
attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
什麼是注意力掩碼？
token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (torch.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 而不是一個普通的元組。

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

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

FunnelModel 的前向方法，重寫了 `__call__` 特殊方法。

FunnelModelForPreTraining

class transformers.FunnelForPreTraining

( config: FunnelConfig )

引數

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

帶有二元分類頭的 Funnel Transformer 模型，用於在預訓練期間識別生成的詞元。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或 tuple(torch.FloatTensor)

引數

input_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。

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

什麼是輸入 ID？
attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
什麼是注意力掩碼？
token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你想比模型的內部嵌入查詢矩陣有更多控制權來將 input_ids 索引轉換為相關向量，這會很有用。
labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算 ELECTRA 風格損失的標籤。輸入應該是一個詞元序列（請參閱 `input_ids` 文件字串）。索引應在 `[0, 1]` 中：
- 0 表示詞元是原始詞元，
- 1 表示詞元被替換。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。
return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或 tuple(torch.FloatTensor)

一個 transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），根據配置 (FunnelConfig) 和輸入包含不同的元素。

loss (可選，當提供 labels 時返回，torch.FloatTensor，形狀為 (1,)) — ELECTRA 風格目標函式的總損失。
logits (torch.FloatTensor，形狀為 (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 後的注意力權重，用於計算自注意力頭中的加權平均值。

FunnelForPreTraining 的 forward 方法覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FunnelForPreTraining
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForPreTraining.from_pretrained("funnel-transformer/small")

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

FunnelForMaskedLM

class transformers.FunnelForMaskedLM

( config: FunnelConfig )

引數

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

帶有“語言建模”頭的 Funnel 模型。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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()。

什麼是輸入 ID？
attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力機制的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示未被掩碼的詞元，
- 0 表示被掩碼的詞元。
什麼是注意力掩碼？
token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一和第二部分的片段詞元索引。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A*的詞元，
- 1 對應於*句子 B*的詞元。
什麼是詞元型別 ID？
inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想對如何將 input_ids 索引轉換為關聯向量進行更多控制，而不是使用模型內部的嵌入查詢矩陣，這會很有用。
labels (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 範圍內（參見 input_ids 文件）。索引設定為 -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），包含根據配置 (FunnelConfig) 和輸入的不同元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

FunnelForMaskedLM 的 forward 方法覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FunnelForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForMaskedLM.from_pretrained("funnel-transformer/small")

>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")

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

>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]

>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
...

>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

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

FunnelForSequenceClassification

class transformers.FunnelForSequenceClassification

( config: FunnelConfig )

引數

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

Funnel Transformer 模型，帶有一個序列分類/迴歸頭（在最後一個隱藏狀態的第一個時間步上新增兩個線性層），例如用於 GLUE 任務。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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()。

什麼是輸入 ID？
attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力機制的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示未被掩碼的詞元，
- 0 表示被掩碼的詞元。
什麼是注意力掩碼？
token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一和第二部分的片段詞元索引。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A*的詞元，
- 1 對應於*句子 B*的詞元。
什麼是詞元型別 ID？
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），包含根據配置 (FunnelConfig) 和輸入的不同元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

FunnelForSequenceClassification 的 forward 方法覆蓋了 __call__ 特殊方法。

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, FunnelForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small")

>>> 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 = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, FunnelForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small", 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 = FunnelForSequenceClassification.from_pretrained(
...     "funnel-transformer/small", 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

FunnelForMultipleChoice

class transformers.FunnelForMultipleChoice

( config: FunnelConfig )

引數

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

Funnel 模型，帶有一個多項選擇分類頭（在池化輸出上加一個線性層和 softmax），例如用於 RocStories/SWAG 任務。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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.Tensor，形狀為 (batch_size, sequence_length), 可選) — 輸入序列詞元在詞彙表中的索引。預設情況下，填充將被忽略。

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

什麼是輸入 ID？
attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力機制的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示未被掩碼的詞元，
- 0 表示被掩碼的詞元。
什麼是注意力掩碼？
token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一和第二部分的片段詞元索引。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A*的詞元，
- 1 對應於*句子 B*的詞元。
什麼是詞元型別 ID？
inputs_embeds (torch.Tensor，形狀為 (batch_size, 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），包含根據配置 (FunnelConfig) 和輸入的不同元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

FunnelForMultipleChoice 的 forward 方法覆蓋了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FunnelForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForMultipleChoice.from_pretrained("funnel-transformer/small")

>>> 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.logits

FunnelForTokenClassification

class transformers.FunnelForTokenClassification

( config: FunnelConfig )

引數

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

Funnel Transformer，帶有一個詞元分類頭（在隱藏狀態輸出上加一個線性層），例如用於命名實體識別 (NER) 任務。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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()。

什麼是輸入 ID？
attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力機制的掩碼。掩碼值在 [0, 1] 中選擇：
- 1 表示未被掩碼的詞元，
- 0 表示被掩碼的詞元。
什麼是注意力掩碼？
token_type_ids (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於指示輸入的第一和第二部分的片段詞元索引。索引在 [0, 1] 中選擇：
- 0 對應於*句子 A*的詞元，
- 1 對應於*句子 B*的詞元。
什麼是詞元型別 ID？
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`），包含的各種元素取決於配置（`FunnelConfig`）和輸入。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

`FunnelForTokenClassification` 的 forward 方法重寫了 `__call__` 特殊方法。

示例

>>> from transformers import AutoTokenizer, FunnelForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForTokenClassification.from_pretrained("funnel-transformer/small")

>>> 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)
...

FunnelForQuestionAnswering

class transformers.FunnelForQuestionAnswering

( config: FunnelConfig )

引數

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

Funnel Transformer 模型，在其頂部增加了一個片段分類頭，用於抽取式問答任務，如 SQuAD（在隱藏狀態輸出之上增加一個線性層，以計算 `span start logits` 和 `span end logits`）。

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

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

forward

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 (形狀為 `(batch_size, sequence_length)` 的 `torch.Tensor`，可選) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。

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

什麼是 input ID？
attention_mask (形狀為 `(batch_size, sequence_length)` 的 `torch.Tensor`，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 `[0, 1]` 中選擇：
- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
什麼是注意力掩碼？
token_type_ids (形狀為 `(batch_size, sequence_length)` 的 `torch.Tensor`，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 `[0, 1]` 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `torch.Tensor`，可選) — 可選地，你可以不傳遞 `input_ids`，而是直接傳遞嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關聯的向量，這很有用。
start_positions (形狀為 `(batch_size,)` 的 `torch.Tensor`，可選) — 標記片段開始位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（`sequence_length`）內。序列之外的位置不計入損失計算。
end_positions (形狀為 `(batch_size,)` 的 `torch.Tensor`，可選) — 標記片段結束位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（`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`），包含的各種元素取決於配置（`FunnelConfig`）和輸入。

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 時返回) — 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

`FunnelForQuestionAnswering` 的 forward 方法重寫了 `__call__` 特殊方法。

示例

>>> from transformers import AutoTokenizer, FunnelForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForQuestionAnswering.from_pretrained("funnel-transformer/small")

>>> 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)
...

TensorFlow

隱藏 TensorFlow 內容

TFFunnelBaseModel

class transformers.TFFunnelBaseModel

( config: FunnelConfig *inputs **kwargs )

引數

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

基礎的 Funnel Transformer 模型，輸出原始的隱藏狀態，沒有上取樣頭（也稱為解碼器）或任何任務特定的頭。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 token_type_ids: 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 training: bool = False ) → `transformers.modeling_tf_outputs.TFBaseModelOutput` 或 `tuple(tf.Tensor)`

引數

input_ids (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`) — 詞彙表中輸入序列詞元的索引。

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

什麼是 input ID？
attention_mask (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 `[0, 1]` 中選擇：
- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
什麼是注意力掩碼？
token_type_ids (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 `[0, 1]` 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `tf.Tensor`，可選) — 可選地，你可以不傳遞 `input_ids`，而是直接傳遞嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關聯的向量，這很有用。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回的張量下的 `attentions`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的 `hidden_states`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, 可選) — 是否返回`ModelOutput`而非普通元組。此引數可在即時模式下使用，在圖模式下，該值將始終設定為 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`），包含的各種元素取決於配置（`FunnelConfig`）和輸入。

last_hidden_state (tf.Tensor of 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

`TFFunnelBaseModel` 的 forward 方法重寫了 `__call__` 特殊方法。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = TFFunnelBaseModel.from_pretrained("funnel-transformer/small-base")

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

>>> last_hidden_states = outputs.last_hidden_state

TFFunnelModel

class transformers.TFFunnelModel

( config: FunnelConfig *inputs **kwargs )

引數

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

基礎的 Funnel Transformer 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`) — 詞彙表中輸入序列詞元的索引。

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

什麼是 input ID？
attention_mask (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 `[0, 1]` 中選擇：
- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
什麼是注意力掩碼？
token_type_ids (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 `[0, 1]` 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `tf.Tensor`，可選) — 可選地，你可以不傳遞 `input_ids`，而是直接傳遞嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關聯的向量，這很有用。
output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回的張量下的 `attentions`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的 `hidden_states`。此引數只能在即時模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, 可選) — 是否返回`ModelOutput`而非普通元組。此引數可在即時模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, 可選, 預設為 `False`) — 是否以訓練模式使用模型（某些模組，如 dropout 模組，在訓練和評估之間有不同的行為）。

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

last_hidden_state (tf.Tensor of 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

`TFFunnelModel` 的 forward 方法重寫了 `__call__` 特殊方法。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelModel.from_pretrained("funnel-transformer/small")

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

>>> last_hidden_states = outputs.last_hidden_state

TFFunnelModelForPreTraining

class transformers.TFFunnelForPreTraining

( config: FunnelConfig **kwargs )

引數

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

帶有二元分類頭的 Funnel 模型，用於在預訓練期間識別生成的詞元。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: 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 training: bool = False **kwargs ) → `transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput` 或 `tuple(tf.Tensor)`

引數

input_ids (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`) — 詞彙表中輸入序列詞元的索引。

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

什麼是 input ID？
attention_mask (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`，可選) — 用於避免對填充詞元索引執行注意力操作的掩碼。掩碼值在 `[0, 1]` 中選擇：
- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
什麼是注意力掩碼？
token_type_ids (`Numpy 陣列`或形狀為 `(batch_size, sequence_length)` 的 `tf.Tensor`，可選) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 `[0, 1]` 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `tf.Tensor`，可選) — 可選地，你可以不傳遞 `input_ids`，而是直接傳遞嵌入表示。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關聯的向量，這很有用。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, optional, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。

transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput 或 tuple(tf.Tensor)

一個 transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput 或一個 tf.Tensor 的元組（如果傳遞了 `return_dict=False` 或當 `config.return_dict=False` 時），包含各種元素，具體取決於配置 (FunnelConfig) 和輸入。

logits (tf.Tensor, 形狀為 (batch_size, sequence_length)) — 預測頭的預測分數（SoftMax 之前的每個詞元的分數）。
hidden_states (tuple(tf.Tensor), optional, 當傳遞 `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 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

示例

>>> from transformers import AutoTokenizer, TFFunnelForPreTraining
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelForPreTraining.from_pretrained("funnel-transformer/small")

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

TFFunnelForMaskedLM

class transformers.TFFunnelForMaskedLM

( config: FunnelConfig *inputs **kwargs )

引數

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

頂部帶有 `語言建模` 頭的 Funnel 模型。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: 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.TFMaskedLMOutput 或 tuple(tf.Tensor)

引數

input_ids (Numpy 陣列 或 tf.Tensor, 形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。

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

什麼是輸入 ID？
attention_mask (Numpy 陣列 或 tf.Tensor, 形狀為 (batch_size, sequence_length), optional) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在 `[0, 1]` 中選擇：
- 1 表示**未被遮蔽**的詞元，
- 0 表示**被遮蔽**的詞元。
什麼是注意力掩碼？
token_type_ids (Numpy 陣列 或 tf.Tensor, 形狀為 (batch_size, sequence_length), optional) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 `[0, 1]` 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (tf.Tensor, 形狀為 (batch_size, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為相關聯的向量，這會很有用。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, optional, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
labels (tf.Tensor, 形狀為 (batch_size, sequence_length), optional) — 用於計算掩碼語言建模損失的標籤。索引應在 `[-100, 0, ..., config.vocab_size]` 範圍內（參見 `input_ids` 文件字串）。索引設定為 `-100` 的詞元將被忽略（遮蔽），損失僅對標籤在 `[0, ..., config.vocab_size]` 範圍內的詞元進行計算。

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

一個 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一個 tf.Tensor 的元組（如果傳遞了 `return_dict=False` 或當 `config.return_dict=False` 時），包含各種元素，具體取決於配置 (FunnelConfig) 和輸入。

loss (tf.Tensor of shape (n,), 可選, 其中 n 是非掩碼標籤的數量，當提供 labels 時返回) — 掩碼語言模型 (MLM) 損失。
logits (tf.Tensor of shape (batch_size, sequence_length, config.vocab_size)) — 語言模型頭部的預測分數（SoftMax 之前每個詞彙標記的分數）。
hidden_states (tuple(tf.Tensor), optional, 當傳遞 `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 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelForMaskedLM.from_pretrained("funnel-transformer/small")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="tf")
>>> logits = model(**inputs).logits

>>> # retrieve index of [MASK]
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)

>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)

>>> labels = tokenizer("The capital of France is Paris.", return_tensors="tf")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = tf.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

>>> outputs = model(**inputs, labels=labels)

TFFunnelForSequenceClassification

class transformers.TFFunnelForSequenceClassification

( config: FunnelConfig *inputs **kwargs )

引數

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

頂部帶有一個序列分類/迴歸頭的 Funnel 模型轉換器（池化輸出之上是一個線性層），例如用於 GLUE 任務。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: 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 陣列 或 tf.Tensor, 形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列詞元的索引。

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

什麼是輸入 ID？
attention_mask (Numpy 陣列 或 tf.Tensor, 形狀為 (batch_size, sequence_length), optional) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在 `[0, 1]` 中選擇：
- 1 表示**未被遮蔽**的詞元，
- 0 表示**被遮蔽**的詞元。
什麼是注意力掩碼？
token_type_ids (Numpy 陣列 或 tf.Tensor, 形狀為 (batch_size, sequence_length), optional) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 `[0, 1]` 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (tf.Tensor, 形狀為 (batch_size, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為相關聯的向量，這會很有用。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, optional, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
labels (tf.Tensor, 形狀為 (batch_size,), optional) — 用於計算序列分類/迴歸損失的標籤。索引應在 `[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` 時），包含各種元素，具體取決於配置 (FunnelConfig) 和輸入。

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), optional, 當傳遞 `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 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = TFFunnelForSequenceClassification.from_pretrained("funnel-transformer/small-base")

>>> 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 = TFFunnelForSequenceClassification.from_pretrained("funnel-transformer/small-base", num_labels=num_labels)

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

TFFunnelForMultipleChoice

class transformers.TFFunnelForMultipleChoice

( config: FunnelConfig *inputs **kwargs )

引數

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

頂部帶有多項選擇分類頭的 Funnel 模型（池化輸出之上是一個線性層和一個 softmax 層），例如用於 RocStories/SWAG 任務。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: 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 陣列 或 tf.Tensor, 形狀為 (batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列詞元的索引。

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

什麼是輸入 ID？
attention_mask (Numpy 陣列 或 tf.Tensor, 形狀為 (batch_size, num_choices, sequence_length), optional) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在 `[0, 1]` 中選擇：
- 1 表示**未被遮蔽**的詞元，
- 0 表示**被遮蔽**的詞元。
什麼是注意力掩碼？
token_type_ids (Numpy 陣列 或 tf.Tensor, 形狀為 (batch_size, num_choices, sequence_length), optional) — 用於指示輸入的第一部分和第二部分的片段詞元索引。索引在 `[0, 1]` 中選擇：
- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
什麼是詞元型別 ID？
inputs_embeds (tf.Tensor, 形狀為 (batch_size, num_choices, sequence_length, hidden_size), optional) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為相關聯的向量，這會很有用。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。此引數只能在 Eager 模式下使用，在圖模式下將使用配置中的值。
return_dict (bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。此引數可在 Eager 模式下使用，在圖模式下，該值將始終設定為 True。
training (bool, optional, 預設為 False) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間有不同的行為）。
labels (tf.Tensor, 形狀為 (batch_size,), optional) — 用於計算多項選擇分類損失的標籤。索引應在 `[0, ..., num_choices]` 範圍內，其中 `num_choices` 是輸入張量第二維的大小。（參見上面的 `input_ids`）

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

一個 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一個 tf.Tensor 的元組（如果傳遞了 `return_dict=False` 或當 `config.return_dict=False` 時），包含各種元素，具體取決於配置 (FunnelConfig) 和輸入。

loss (tf.Tensor，形狀為 (batch_size, )，可選，當提供 labels 時返回) — 分類損失。
logits (tf.Tensor，形狀為 (batch_size, num_choices)) — num_choices 是輸入張量的第二維。（參見上面的 input_ids）。

分類分數（SoftMax 之前）。
hidden_states (tuple(tf.Tensor), optional, 當傳遞 `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 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = TFFunnelForMultipleChoice.from_pretrained("funnel-transformer/small-base")

>>> 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.logits

TFFunnelForTokenClassification

class transformers.TFFunnelForTokenClassification

( config: FunnelConfig *inputs **kwargs )

引數

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

頂部帶有一個詞元分類頭的 Funnel 模型（隱藏狀態輸出之上是一個線性層），例如用於命名實體識別（NER）任務。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: 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 array 或 tf.Tensor，形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

什麼是輸入 ID？
attention_mask (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：
- 1 表示標記未被遮蓋，
- 0 表示標記已被遮蓋。
什麼是注意力掩碼？
token_type_ids (Numpy array 或 tf.Tensor，形狀為 (batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引選自 [0, 1]：
- 0 對應於 *A 句子* 的標記，
- 1 對應於 *B 句子* 的標記。
什麼是標記型別 ID？
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, 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 時），包含各種元素，具體取決於配置（FunnelConfig）和輸入。

loss (tf.Tensor，形狀為 (n,)，可選，其中 n 是未被掩蓋的標籤數量，當提供 labels 時返回) — 分類損失。
logits (tf.Tensor，形狀為 (batch_size, sequence_length, config.num_labels)) — 分類分數（SoftMax 之前）。
hidden_states (tuple(tf.Tensor), optional, 當傳遞 `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 後的注意力權重，用於計算自注意力頭中的加權平均值。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelForTokenClassification.from_pretrained("funnel-transformer/small")

>>> 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()]

>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)

TFFunnelForQuestionAnswering

class transformers.TFFunnelForQuestionAnswering

( config: FunnelConfig *inputs **kwargs )

引數

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

Funnel 模型在頂部帶有一個片段分類頭，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出的頂部有一個線性層，用於計算 span start logits 和 span end logits）。

Funnel Transformer 模型在論文《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。

該模型繼承自 `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 函式一樣傳遞輸入！

呼叫