Transformers 文件

BERT

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

PyTorch TensorFlow Flax SDPA

BERT

BERT 是一種雙向 Transformer 模型,透過對無標籤文字進行預訓練,用於預測句子中被遮蔽的詞元以及判斷一個句子是否緊跟在另一個句子之後。其主要思想是透過隨機遮蔽一些詞元,模型可以在左右兩側的文字上進行訓練,從而獲得更全面的理解。BERT 也非常通用,因為其學習到的語言表徵可以透過微調額外的層或頭部來適應其他 NLP 任務。

您可以在 BERT 集合中找到所有原始 BERT 檢查點。

點選右側邊欄中的 BERT 模型,獲取更多如何將 BERT 應用於不同語言任務的示例。

下面的示例演示瞭如何使用 PipelineAutoModel 和命令列預測 [MASK] 詞元。

流水線
自動模型
Transformers CLI
import torch
from transformers import pipeline

pipeline = pipeline(
    task="fill-mask",
    model="google-bert/bert-base-uncased",
    torch_dtype=torch.float16,
    device=0
)
pipeline("Plants create [MASK] through a process known as photosynthesis.")

注意事項

  • 輸入應在右側進行填充,因為 BERT 使用絕對位置嵌入。

BertConfig

class transformers.BertConfig

< >

( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )

引數

  • vocab_size (int, 可選, 預設為 30522) — BERT 模型的詞彙量大小。定義了呼叫 BertModelTFBertModel 時傳遞的 inputs_ids 可以表示的不同詞元數量。
  • hidden_size (int, 可選, 預設為 768) — 編碼器層和池化層的維度。
  • num_hidden_layers (int, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數量。
  • num_attention_heads (int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • intermediate_size (int, 可選, 預設為 3072) — Transformer 編碼器中“中間”(通常稱為前饋)層的維度。
  • hidden_act (strCallable, 可選, 預設為 "gelu") — 編碼器和池化器中的非線性啟用函式(函式或字串)。如果是字串,支援 "gelu""relu""silu""gelu_new"
  • hidden_dropout_prob (float, 可選, 預設為 0.1) — 嵌入層、編碼器和池化器中所有全連線層的 dropout 機率。
  • attention_probs_dropout_prob (float, 可選, 預設為 0.1) — 注意力機率的 dropout 比率。
  • max_position_embeddings (int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常為了以防萬一,將其設定為較大的值(例如 512 或 1024 或 2048)。
  • type_vocab_size (int, 可選, 預設為 2) — 呼叫 BertModelTFBertModel 時傳遞的 token_type_ids 的詞彙量大小。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。
  • layer_norm_eps (float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。
  • position_embedding_type (str, 可選, 預設為 "absolute") — 位置嵌入型別。選擇 "absolute""relative_key""relative_key_query" 之一。對於位置嵌入,使用 "absolute"。有關 "relative_key" 的更多資訊,請參閱 《帶有相對位置表示的自注意力》(Shaw 等人)。有關 "relative_key_query" 的更多資訊,請參閱 《透過更好的相對位置嵌入改進 Transformer 模型》(Huang 等人)中的方法 4
  • is_decoder (bool, 可選, 預設為 False) — 模型是否用作解碼器。如果為 False,模型則用作編碼器。
  • use_cache (bool, 可選, 預設為 True) — 模型是否應該返回最後一個鍵/值注意力(並非所有模型都使用)。僅在 config.is_decoder=True 時相關。
  • classifier_dropout (float, 可選) — 分類頭部的 dropout 比率。

這是用於儲存 BertModelTFBertModel 配置的配置類。它用於根據指定引數例項化 BERT 模型,定義模型架構。使用預設值例項化配置將生成與 BERT google-bert/bert-base-uncased 架構類似的配置。

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

示例

>>> from transformers import BertConfig, BertModel

>>> # Initializing a BERT google-bert/bert-base-uncased style configuration
>>> configuration = BertConfig()

>>> # Initializing a model (with random weights) from the google-bert/bert-base-uncased style configuration
>>> model = BertModel(configuration)

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

BertTokenizer

class transformers.BertTokenizer

< >

( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **kwargs )

引數

  • vocab_file (str) — 包含詞彙表的檔案。
  • do_lower_case (bool, 可選, 預設為 True) — 標記化時是否將輸入轉換為小寫。
  • do_basic_tokenize (bool, 可選, 預設為 True) — 在 WordPiece 之前是否進行基本分詞。
  • never_split (Iterable, 可選) — 標記化過程中永不拆分的標記集合。僅當 do_basic_tokenize=True 時有效。
  • unk_token (str, 可選, 預設為 "[UNK]") — 未知標記。不在詞彙表中的標記不能轉換為 ID,而是設定為此標記。
  • sep_token (str, 可選, 預設為 "[SEP]") — 分隔符標記,用於從多個序列構建序列時,例如用於序列分類的兩個序列或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。
  • pad_token (str, 可選, 預設為 "[PAD]") — 用於填充的標記,例如在批處理不同長度的序列時。
  • cls_token (str, 可選, 預設為 "[CLS]") — 分類器標記,用於序列分類(整個序列的分類而非逐標記分類)時。使用特殊標記構建序列時,它是序列的第一個標記。
  • mask_token (str, 可選, 預設為 "[MASK]") — 用於掩碼值的標記。這是使用掩碼語言建模訓練此模型時使用的標記。這是模型將嘗試預測的標記。
  • tokenize_chinese_chars (bool, 可選, 預設為 True) — 是否對中文字元進行分詞。

    對於日語,這可能需要停用(請參閱此問題)。

  • strip_accents (bool, 可選) — 是否去除所有重音。如果未指定此選項,則將由 lowercase 的值決定(如原始 BERT 中所示)。
  • clean_up_tokenization_spaces (bool, 可選, 預設為 True) — 解碼後是否清理空格,清理包括移除可能存在的額外空格等人工痕跡。

構建 BERT 分詞器。基於 WordPiece。

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

build_inputs_with_special_tokens

< >

( 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], 可選) — 序列對的可選第二組 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], 可選) — 序列對的可選第二組 ID 列表。
  • already_has_special_tokens (bool, 可選, 預設為 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]) — 第一個分詞序列。
  • token_ids_1 (list[int], 可選) — 第二個分詞序列。

返回

list[int]

標記型別 ID。

建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID?

如果模型有特殊的構建方式,應在子類中重寫此方法。

save_vocabulary

< >

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

BertTokenizerFast

class transformers.BertTokenizerFast

< >

( 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]' tokenize_chinese_chars = True strip_accents = None **kwargs )

引數

  • vocab_file (str) — 包含詞彙表的檔案。
  • do_lower_case (bool, 可選, 預設為 True) — 標記化時是否將輸入轉換為小寫。
  • unk_token (str, 可選, 預設為 "[UNK]") — 未知標記。不在詞彙表中的標記不能轉換為 ID,而是設定為此標記。
  • sep_token (str, 可選, 預設為 "[SEP]") — 分隔符標記,用於從多個序列構建序列時,例如用於序列分類的兩個序列或用於問答的文字和問題。它也用作使用特殊標記構建的序列的最後一個標記。
  • pad_token (str, 可選, 預設為 "[PAD]") — 用於填充的標記,例如在批處理不同長度的序列時。
  • cls_token (str, 可選, 預設為 "[CLS]") — 分類器標記,用於序列分類(整個序列的分類而非逐標記分類)時。使用特殊標記構建序列時,它是序列的第一個標記。
  • mask_token (str, 可選, 預設為 "[MASK]") — 用於掩碼值的標記。這是使用掩碼語言建模訓練此模型時使用的標記。這是模型將嘗試預測的標記。
  • clean_text (bool, 可選, 預設為 True) — 在標記化之前是否透過刪除任何控制字元並將所有空白替換為經典空白來清理文字。
  • tokenize_chinese_chars (bool, 可選, 預設為 True) — 是否對中文字元進行分詞。對於日語,這可能需要停用(請參閱此問題)。
  • strip_accents (bool, 可選) — 是否去除所有重音。如果未指定此選項,則將由 lowercase 的值決定(如原始 BERT 中所示)。
  • wordpieces_prefix (str, 可選, 預設為 "##") — 子詞的字首。

構建一個“快速”BERT 分詞器(由 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], 可選) — 序列對的可選第二組 ID 列表。

返回

List[int]

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

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

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

BertModel

class transformers.BertModel

< >

( config add_pooling_layer = True )

引數

  • config (BertModel) — 模型配置類,包含模型的所有引數。用配置檔案初始化不會載入與模型相關的權重,只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
  • add_pooling_layer (bool, 可選, 預設為 True) — 是否新增池化層

該模型可以作為編碼器(僅有自注意力機制)或解碼器,在這種情況下,在自注意力層之間新增一個交叉注意力層,遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架構。

要作為解碼器,模型需要使用 is_decoder 引數設定為 True 的配置進行初始化。要在 Seq2Seq 模型中使用,模型需要使用 is_decoder 引數和 add_cross_attention 都設定為 True 進行初始化;此時,前向傳播需要 encoder_hidden_states 作為輸入。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentionstuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 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?

  • position_ids (形狀為 (batch_size, sequence_length)torch.Tensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

  • head_mask (形狀為 (num_heads,)(num_layers, num_heads)torch.Tensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示頭部未被掩碼
    • 0 表示頭部被掩碼
  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size)torch.Tensor, 可選) — 可選地,您可以直接傳入嵌入表示,而不是傳入 input_ids。如果您希望對 input_ids 索引如何轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制,這將很有用。
  • encoder_hidden_states (形狀為 (batch_size, sequence_length, hidden_size)torch.Tensor, 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器,則用於交叉注意力。
  • encoder_attention_mask (形狀為 (batch_size, sequence_length)torch.Tensor, 可選) — 掩碼,用於避免在編碼器輸入中的填充標記索引上執行注意力。如果模型配置為解碼器,則此掩碼用於交叉注意力。掩碼值選擇在 [0, 1] 之間:

    • 1 表示未被掩碼的標記,
    • 0 表示被掩碼的標記。
  • past_key_values (list[torch.FloatTensor], 可選) — 預先計算的隱藏狀態(自注意力塊和交叉注意力塊中的鍵和值),可用於加速順序解碼。這通常包括模型在解碼上一階段返回的 past_key_values,當 use_cache=Trueconfig.use_cache=True 時。

    允許兩種格式:

    • 一個 Cache 例項,請參閱我們的 kv 快取指南
    • 長度為 config.n_layerstuple(torch.FloatTensor) 元組,每個元組包含兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量)。這也稱為舊版快取格式。

    模型將輸出與作為輸入饋入的快取格式相同的快取格式。如果未傳入 past_key_values,則將返回舊版快取格式。

    如果使用 past_key_values,使用者可以選擇只輸入形狀為 (batch_size, 1) 的最後一個 input_ids(那些沒有將其過去的鍵值狀態提供給此模型的輸入),而不是形狀為 (batch_size, sequence_length) 的所有 input_ids

  • use_cache (bool, 可選) — 如果設定為 True,則返回 past_key_values 鍵值狀態,可用於加速解碼(請參閱 past_key_values)。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的 attentions
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的 hidden_states
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 物件而不是普通的元組。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentionstuple(torch.FloatTensor)

一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 物件或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置 (BertConfig) 和輸入的不同元素。

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

  • pooler_output (torch.FloatTensor 形狀為 (batch_size, hidden_size)) — 序列第一個 token(分類 token)經過用於輔助預訓練任務的層進一步處理後的最後一層隱藏狀態。例如,對於 BERT 系列模型,這會返回分類 token 經過線性層和 tanh 啟用函式處理後的結果。線性層權重在預訓練期間透過下一句預測(分類)目標進行訓練。

  • hidden_states (tuple(torch.FloatTensor), 可選, 當傳入 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.add_cross_attention=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • past_key_values (Cache, 可選, 當傳入 use_cache=Trueconfig.use_cache=True 時返回) — 這是一個 Cache 例項。更多詳情,請參閱我們的 kv cache 指南

    包含預計算的隱藏狀態(自注意力塊中的鍵和值,如果 config.is_encoder_decoder=True,則可選地包含交叉注意力塊中的鍵和值),可用於加速序列解碼(參見 past_key_values 輸入)。

BertModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

BertForPreTraining

class transformers.BertForPreTraining

< >

( config )

引數

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

Bert 模型在預訓練期間在頂部帶有兩個頭:一個 masked language modeling(掩碼語言建模)頭和一個 next sentence prediction (classification)(下一句預測(分類))頭。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 labels: typing.Optional[torch.Tensor] = None next_sentence_label: 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.bert.modeling_bert.BertForPreTrainingOutputtuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID?

  • attention_mask (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 掩碼,用於避免對填充 token 索引執行注意力。掩碼值選擇在 [0, 1] 之間:

    • 1 表示 未被掩碼 的 token,
    • 0 表示 被掩碼 的 token。

    什麼是注意力掩碼?

  • token_type_ids (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 段落 token 索引,用於指示輸入的第一個和第二個部分。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A token,
    • 1 對應於 句子 B token。

    什麼是 token 型別 ID?

  • position_ids (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為 [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 索引如何轉換為相關向量有更多控制,而不是模型內部的嵌入查詢矩陣,這會很有用。
  • labels (torch.LongTensor 形狀為 (batch_size, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 範圍內(參見 input_ids 文件字串)。索引設定為 -100 的 token 將被忽略(掩碼),損失只為標籤在 [0, ..., config.vocab_size] 範圍內的 token 計算。
  • next_sentence_label (torch.LongTensor 形狀為 (batch_size,), 可選) — 用於計算下一序列預測(分類)損失的標籤。輸入應為序列對(參見 input_ids 文件字串)。索引應在 [0, 1] 之間:

    • 0 表示序列 B 是序列 A 的延續,
    • 1 表示序列 B 是隨機序列。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的 attentions
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的 hidden_states
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 物件而不是普通的元組。

返回

transformers.models.bert.modeling_bert.BertForPreTrainingOutputtuple(torch.FloatTensor)

一個 transformers.models.bert.modeling_bert.BertForPreTrainingOutput 物件或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置 (BertConfig) 和輸入的不同元素。

  • loss (*可選*, 當提供 labels 時返回, torch.FloatTensor 形狀為 (1,)) — 總損失,是掩碼語言建模損失和下一序列預測(分類)損失之和。

  • prediction_logits (torch.FloatTensor 形狀為 (batch_size, sequence_length, config.vocab_size)) — 語言建模頭的預測分數(SoftMax 之前的每個詞彙 token 的分數)。

  • seq_relationship_logits (torch.FloatTensor 形狀為 (batch_size, 2)) — 下一序列預測(分類)頭的預測分數(SoftMax 之前的 True/False 延續分數)。

  • hidden_states (tuple[torch.FloatTensor], 可選, 當傳入 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple[torch.FloatTensor], 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForPreTraining 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, BertForPreTraining
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForPreTraining.from_pretrained("google-bert/bert-base-uncased")

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

>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logits

BertLMHeadModel

class transformers.BertLMHeadModel

< >

( config )

引數

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

Bert 模型頂部帶有一個用於 CLM 微調的 language modeling 頭。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.Tensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **loss_kwargs ) transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID?

  • attention_mask (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 掩碼,用於避免對填充 token 索引執行注意力。掩碼值選擇在 [0, 1] 之間:

    • 1 表示 未被掩碼 的 token,
    • 0 表示 被掩碼 的 token。

    什麼是注意力掩碼?

  • token_type_ids (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 段落 token 索引,用於指示輸入的第一個和第二個部分。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A token,
    • 1 對應於 句子 B token。

    什麼是 token 型別 ID?

  • position_ids (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為 [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 索引如何轉換為相關向量有更多控制,而不是模型內部的嵌入查詢矩陣,這會很有用。
  • encoder_hidden_states (torch.Tensor 形狀為 (batch_size, sequence_length, hidden_size), 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器,則用於交叉注意力。
  • encoder_attention_mask (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 掩碼,用於避免對編碼器輸入的填充 token 索引執行注意力。如果模型配置為解碼器,則此掩碼用於交叉注意力。掩碼值選擇在 [0, 1] 之間:

    • 1 表示 未被掩碼 的 token,
    • 0 表示 被掩碼 的 token。
  • labels (torch.LongTensor 形狀為 (batch_size, sequence_length), 可選) — 用於計算從左到右語言建模損失(下一詞預測)的標籤。索引應在 [-100, 0, ..., config.vocab_size] 範圍內(參見 input_ids 文件字串)。索引設定為 -100 的 token 將被忽略(掩碼),損失只為標籤在 [0, ..., config.vocab_size] 範圍內的 token 計算。
  • past_key_values (list[torch.Tensor], 可選) — 預計算的隱藏狀態(自注意力塊和交叉注意力塊中的鍵和值),可用於加速序列解碼。這通常包括模型在解碼上一階段返回的 past_key_values,當 use_cache=Trueconfig.use_cache=True 時。

    允許兩種格式:

    • 一個 Cache 例項,請參閱我們的 kv cache 指南
    • 一個 config.n_layers 長度的 tuple(torch.FloatTensor) 元組,每個元組包含兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也被稱為傳統快取格式。

    模型將輸出與輸入相同格式的快取。如果未傳入 past_key_values,則將返回傳統快取格式。

    如果使用 past_key_values,使用者可以可選地只輸入最後 input_ids(那些沒有將過去的鍵值狀態提供給該模型的輸入)形狀為 (batch_size, 1),而不是所有 input_ids 形狀為 (batch_size, sequence_length)

  • use_cache (bool, 可選) — 如果設定為 True,則返回 past_key_values 鍵值狀態,可用於加速解碼(參見 past_key_values)。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的 attentions
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的 hidden_states
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 物件而不是普通的元組。

返回

transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 物件或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置 (BertConfig) 和輸入的不同元素。

  • loss (torch.FloatTensor 形狀為 (1,)可選,當提供 labels 時返回) — 語言建模損失(用於下一個 token 預測)。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 語言建模頭部的預測分數(SoftMax 之前的每個詞彙標記的分數)。

  • hidden_states (tuple(torch.FloatTensor), 可選, 當傳入 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 後的交叉注意力權重,用於計算交叉注意力頭中的加權平均。

  • past_key_values (Cache, 可選, 當傳入 use_cache=Trueconfig.use_cache=True 時返回) — 這是一個 Cache 例項。更多詳情,請參閱我們的 kv cache 指南

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

BertLMHeadModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> import torch
>>> from transformers import AutoTokenizer, BertLMHeadModel

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertLMHeadModel.from_pretrained("google-bert/bert-base-uncased")

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

BertForMaskedLM

class transformers.BertForMaskedLM

< >

( config )

引數

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

Bert 模型頂部帶有一個 language modeling 頭。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: 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.MaskedLMOutputtuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID?

  • attention_mask (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 掩碼,用於避免對填充 token 索引執行注意力。掩碼值選擇在 [0, 1] 之間:

    • 1 表示 未被掩碼 的 token,
    • 0 表示 被掩碼 的 token。

    什麼是注意力掩碼?

  • token_type_ids (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 段落 token 索引,用於指示輸入的第一個和第二個部分。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A token,
    • 1 對應於 句子 B token。

    什麼是 token 型別 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 索引轉換為相關向量擁有比模型內部嵌入查詢矩陣更多的控制權,這將非常有用。
  • encoder_hidden_states (torch.Tensor,形狀為 (batch_size, sequence_length, hidden_size)可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器,則用於交叉注意力。
  • encoder_attention_mask (torch.Tensor,形狀為 (batch_size, sequence_length)可選) — 避免在編碼器輸入中對填充令牌索引執行注意力的掩碼。如果模型被配置為解碼器,則此掩碼用於交叉注意力。掩碼值選擇範圍為 [0, 1]

    • 1 表示令牌未被掩碼
    • 0 表示令牌被掩碼
  • 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.MaskedLMOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.MaskedLMOutputtorch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForMaskedLM 的前向方法,覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, BertForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")

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

BertForNextSentencePrediction

class transformers.BertForNextSentencePrediction

< >

( config )

引數

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

Bert 模型,頂部帶有 下一個句子預測(分類) 頭。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 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 **kwargs ) transformers.modeling_outputs.NextSentencePredictorOutputtuple(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 索引轉換為相關向量擁有比模型內部嵌入查詢矩陣更多的控制權,這將非常有用。
  • labels (torch.LongTensor,形狀為 (batch_size,)可選) — 用於計算下一個序列預測(分類)損失的標籤。輸入應該是一個序列對(參見 input_ids 文件字串)。索引應在 [0, 1] 範圍內:

    • 0 表示序列 B 是序列 A 的延續,
    • 1 表示序列 B 是一個隨機序列。
  • output_attentions (bool可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量中的 attentions
  • output_hidden_states (bool可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量中的 hidden_states
  • return_dict (bool可選) — 是否返回 ModelOutput 而不是普通的元組。

返回

transformers.modeling_outputs.NextSentencePredictorOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.NextSentencePredictorOutputtorch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • loss (torch.FloatTensor,形狀為 (1,)可選,當提供 next_sentence_label 時返回) — 下一個序列預測(分類)損失。

  • logits (torch.FloatTensor,形狀為 (batch_size, 2)) — 下一個序列預測(分類)頭的預測分數(SoftMax 之前的真/假延續分數)。

  • hidden_states (tuple(torch.FloatTensor), 可選, 當傳入 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForNextSentencePrediction 的前向方法,覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, BertForNextSentencePrediction
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="pt")

>>> outputs = model(**encoding, labels=torch.LongTensor([1]))
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1]  # next sentence was random

BertForSequenceClassification

class transformers.BertForSequenceClassification

< >

( config )

引數

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

Bert 模型轉換器,頂部帶有一個序列分類/迴歸頭(在池化輸出之上有一個線性層),例如用於 GLUE 任務。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 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.SequenceClassifierOutputtuple(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 索引轉換為相關向量擁有比模型內部嵌入查詢矩陣更多的控制權,這將非常有用。
  • 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.SequenceClassifierOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.SequenceClassifierOutputtorch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForSequenceClassification 的前向方法,覆蓋了 __call__ 特殊方法。

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

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, BertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForSequenceClassification.from_pretrained("google-bert/bert-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 = BertForSequenceClassification.from_pretrained("google-bert/bert-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, BertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForSequenceClassification.from_pretrained("google-bert/bert-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 = BertForSequenceClassification.from_pretrained(
...     "google-bert/bert-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).loss

BertForMultipleChoice

class transformers.BertForMultipleChoice

< >

( config )

引數

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

Bert 模型,頂部帶有多個選擇分類頭(在池化輸出之上有一個線性層和 softmax),例如用於 RocStories/SWAG 任務。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 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.MultipleChoiceModelOutputtuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor,形狀為 (batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列令牌的索引。

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

    什麼是輸入ID?

  • attention_mask (torch.Tensor,形狀為 (batch_size, sequence_length)可選) — 避免對填充令牌索引執行注意力的掩碼。掩碼值選擇範圍為 [0, 1]

    • 1 表示令牌未被掩碼
    • 0 表示令牌被掩碼

    什麼是注意力掩碼?

  • token_type_ids (torch.LongTensor,形狀為 (batch_size, num_choices, sequence_length)可選) — 分段令牌索引,用於指示輸入的第一個和第二個部分。索引選擇範圍為 [0, 1]

    • 0 對應於一個句子 A 令牌,
    • 1 對應於一個句子 B 令牌。

    什麼是令牌型別ID?

  • position_ids (torch.LongTensor,形狀為 (batch_size, num_choices, sequence_length)可選) — 每個輸入序列令牌在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置ID?

  • 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, optional) — 是否返回 ModelOutput 物件而非普通元組。

返回

transformers.modeling_outputs.MultipleChoiceModelOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.MultipleChoiceModelOutput 物件或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含取決於配置 (BertConfig) 和輸入的各種元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForMultipleChoice 的 forward 方法,覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, BertForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForMultipleChoice.from_pretrained("google-bert/bert-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.logits

BertForTokenClassification

class transformers.BertForTokenClassification

< >

( config )

引數

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

帶有令牌分類頭(在隱藏狀態輸出之上的一層線性層)的 Bert transformer,例如用於命名實體識別(NER)任務。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 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.TokenClassifierOutputtuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 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?

  • position_ids (形狀為 (batch_size, sequence_length)torch.Tensor可選) — 每個輸入序列令牌在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

  • head_mask (形狀為 (num_heads,)(num_layers, num_heads)torch.Tensor可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在 [0, 1] 中選擇:

    • 1 表示頭部**未被掩碼**,
    • 0 表示頭部**被掩碼**。
  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size)torch.Tensor可選) — 可選地,您可以選擇直接傳遞嵌入表示,而不是傳遞 input_ids。如果您希望對如何將 input_ids 索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制,這會很有用。
  • labels (形狀為 (batch_size, sequence_length)torch.LongTensor可選) — 用於計算令牌分類損失的標籤。索引應在 [0, ..., config.num_labels - 1] 之間。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的 attentions
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的 hidden_states
  • return_dict (bool, 可選) — 是否返回 ModelOutput 物件而非普通元組。

返回

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.TokenClassifierOutput 物件或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含取決於配置 (BertConfig) 和輸入的各種元素。

  • loss (形狀為 (1,)torch.FloatTensor可選,當提供 labels 時返回) — 分類損失。

  • logits (形狀為 (batch_size, sequence_length, config.num_labels)torch.FloatTensor) — 分類分數(SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor), 可選, 當傳入 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForTokenClassification 的 forward 方法,覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, BertForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForTokenClassification.from_pretrained("google-bert/bert-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)
...

BertForQuestionAnswering

class transformers.BertForQuestionAnswering

< >

( config )

引數

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

帶有跨度分類頭(在隱藏狀態輸出之上的一層線性層,用於計算 span start logitsspan end logits)的 Bert transformer,用於 SQuAD 等抽取式問答任務。

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

此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用,並參考 PyTorch 文件中所有與通用用法和行為相關的事項。

前向

< >

( 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 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.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 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?

  • position_ids (形狀為 (batch_size, sequence_length)torch.Tensor可選) — 每個輸入序列令牌在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

  • head_mask (形狀為 (num_heads,)(num_layers, num_heads)torch.Tensor可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在 [0, 1] 中選擇:

    • 1 表示頭部**未被掩碼**,
    • 0 表示頭部**被掩碼**。
  • 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.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 物件或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含取決於配置 (BertConfig) 和輸入的各種元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(一個用於嵌入層的輸出(如果模型有嵌入層),加上每個層的輸出)形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每個層一個)形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForQuestionAnswering 的 forward 方法,覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, BertForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForQuestionAnswering.from_pretrained("google-bert/bert-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)
...

TFBertTokenizer

class transformers.TFBertTokenizer

< >

( vocab_list: list do_lower_case: bool cls_token_id: typing.Optional[int] = None sep_token_id: typing.Optional[int] = None pad_token_id: typing.Optional[int] = None padding: str = 'longest' truncation: bool = True max_length: int = 512 pad_to_multiple_of: typing.Optional[int] = None return_token_type_ids: bool = True return_attention_mask: bool = True use_fast_bert_tokenizer: bool = True **tokenizer_kwargs )

引數

  • vocab_list (list) — 包含詞彙表的列表。
  • do_lower_case (bool, 可選, 預設為 True) — 分詞時是否將輸入轉換為小寫。
  • cls_token_id (str, 可選, 預設為 "[CLS]") — 用於序列分類(對整個序列而非每個令牌進行分類)的分類器令牌。當與特殊令牌一起構建時,它是序列的第一個令牌。
  • sep_token_id (str, 可選, 預設為 "[SEP]") — 分隔符令牌,用於從多個序列構建序列時,例如用於序列分類的兩個序列,或用於問答的文字和問題。它也用作與特殊令牌一起構建的序列的最後一個令牌。
  • pad_token_id (str, 可選, 預設為 "[PAD]") — 用於填充的令牌,例如在批處理不同長度的序列時。
  • padding (str, 預設為 "longest") — 要使用的填充型別。可以是 "longest",僅填充到批次中最長的樣本,也可以是 "max_length",將所有輸入填充到分詞器支援的最大長度。
  • truncation (bool, 可選, 預設為 True) — 是否將序列截斷到最大長度。
  • max_length (int, 可選, 預設為 512) — 序列的最大長度,用於填充(如果 padding 為 “max_length”)和/或截斷(如果 truncationTrue)。
  • pad_to_multiple_of (int, 可選, 預設為 None) — 如果設定,序列將填充到此值的倍數。
  • return_token_type_ids (bool, 可選, 預設為 True) — 是否返回 token_type_ids。
  • return_attention_mask (bool, 可選, 預設為 True) — 是否返回 attention_mask。
  • use_fast_bert_tokenizer (bool, 可選, 預設為 True) — 如果為 True,將使用 Tensorflow Text 中的 FastBertTokenizer 類。如果為 False,將使用 BertTokenizer 類。BertTokenizer 支援一些附加選項,但速度較慢,無法匯出到 TFLite。

這是一個用於 BERT 的圖內分詞器。它應與其他分詞器類似地初始化,使用 from_pretrained() 方法。它也可以使用 from_tokenizer() 方法初始化,該方法從現有標準分詞器物件匯入設定。

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

from_pretrained

< >

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

引數

  • pretrained_model_name_or_path (stros.PathLike) — 預訓練分詞器的名稱或路徑。

從預訓練分詞器例項化一個 TFBertTokenizer

示例

from transformers import TFBertTokenizer

tf_tokenizer = TFBertTokenizer.from_pretrained("google-bert/bert-base-uncased")

from_tokenizer

< >

( tokenizer: PreTrainedTokenizerBase **kwargs )

引數

  • 分詞器 (PreTrainedTokenizerBase) — 用於初始化 TFBertTokenizer 的分詞器。

從現有 Tokenizer 初始化 TFBertTokenizer

示例

from transformers import AutoTokenizer, TFBertTokenizer

tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
tf_tokenizer = TFBertTokenizer.from_tokenizer(tokenizer)

TFBertModel

class transformers.TFBertModel

< >

( config: BertConfig add_pooling_layer: bool = True *inputs **kwargs )

引數

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

原始的 Bert 模型 transformer,輸出原始的隱藏狀態,沒有頂部任何特定的頭部。

此模型繼承自 TFPreTrainedModel。請查閱超類文件,瞭解庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。

此模型也是 keras.Model 子類。將其作為常規的 TF 2.0 Keras 模型使用,並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事項。

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

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

支援第二種格式的原因是,Keras 方法在將輸入傳遞給模型和層時更喜歡這種格式。由於這種支援,當使用 model.fit() 等方法時,一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞輸入和標籤即可!但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二種格式,例如在使用 Keras Functional API 建立自己的層或模型時,有三種可能性可以用來在第一個位置引數中收集所有輸入張量。

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

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

呼叫

< >

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

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],並且每個示例必須具有形狀 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length)可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為 [0, 1]

    • 1 表示未被掩蓋的標記,
    • 0 表示被掩蓋的標記。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length)可選) — 分段標記索引,用於指示輸入的第一個和第二個部分。索引選擇範圍為 [0, 1]

    • 0 對應於句子 A 標記,
    • 1 對應於句子 B 標記。

    什麼是標記型別 ID?

  • position_ids (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length)可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形狀為 (num_heads,)(num_layers, num_heads)可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為 [0, 1]

    • 1 表示頭部未被掩蓋
    • 0 表示頭部被掩蓋
  • inputs_embeds (np.ndarraytf.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 模組在訓練和評估之間的行為不同)。
  • encoder_hidden_states (tf.Tensor,形狀為 (batch_size, sequence_length, hidden_size)可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器,則用於交叉注意力。
  • encoder_attention_mask (tf.Tensor,形狀為 (batch_size, sequence_length)可選) — 用於避免對編碼器輸入的填充標記索引執行注意力操作的掩碼。如果模型被配置為解碼器,則此掩碼用於交叉注意力。掩碼值選擇範圍為 [0, 1]

    • 1 表示未被掩蓋的標記,
    • 0 表示被掩蓋的標記。
  • past_key_values (tuple[tuple[tf.Tensor]],長度為 config.n_layers) — 包含預先計算的注意力塊的鍵和值隱藏狀態。可用於加速解碼。如果使用 past_key_values,使用者可以可選地只輸入形狀為 (batch_size, 1) 的最後 decoder_input_ids(那些沒有將其過去的鍵值狀態提供給此模型的),而不是形狀為 (batch_size, sequence_length) 的所有 decoder_input_ids
  • use_cache (bool可選,預設為 True) — 如果設定為 True,則返回 past_key_values 鍵值狀態,可用於加速解碼(參見 past_key_values)。在訓練期間設定為 False,在生成期間設定為 True

返回

transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentionstuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一個 tf.Tensor 元組(如果傳遞 return_dict=Falseconfig.return_dict=False 時),包含根據配置 (BertConfig) 和輸入的不同元素。

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

  • pooler_output (tf.Tensor,形狀為 (batch_size, hidden_size)) — 序列第一個標記(分類標記)的最後一層隱藏狀態,經線性層和 Tanh 啟用函式進一步處理。線性層權重在預訓練期間透過下一個句子預測(分類)目標進行訓練。

    此輸出通常不是輸入語義內容的良好摘要,通常最好對整個輸入序列的隱藏狀態進行平均或池化。

  • past_key_values (list[tf.Tensor]可選,當傳遞 use_cache=Trueconfig.use_cache=True 時返回) — 長度為 config.n_layerstf.Tensor 列表,每個張量形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

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

  • hidden_states (tuple(tf.Tensor)可選,當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertModel.from_pretrained("google-bert/bert-base-uncased")

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

>>> last_hidden_states = outputs.last_hidden_state

TFBertForPreTraining

class transformers.TFBertForPreTraining

< >

( config: BertConfig *inputs **kwargs )

引數

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

Bert 模型在預訓練期間在頂部帶有兩個頭:一個 masked language modeling(掩碼語言建模)頭和一個 next sentence prediction (classification)(下一句預測(分類))頭。

此模型繼承自 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 position_ids: np.ndarray | tf.Tensor | None = 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 next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutputtuple(tf.Tensor)

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],並且每個示例必須具有形狀 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length)可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為 [0, 1]

    • 1 表示未被掩蓋的標記,
    • 0 表示被掩蓋的標記。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length)可選) — 分段標記索引,用於指示輸入的第一個和第二個部分。索引選擇範圍為 [0, 1]

    • 0 對應於句子 A 標記,
    • 1 對應於句子 B 標記。

    什麼是標記型別 ID?

  • position_ids (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length)可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形狀為 (num_heads,)(num_layers, num_heads)可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為 [0, 1]

    • 1 表示頭部未被掩蓋
    • 0 表示頭部被掩蓋
  • inputs_embeds (np.ndarraytf.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)可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 範圍內(參見 input_ids 文件字串)。索引設定為 -100 的標記將被忽略(掩碼),損失僅針對標籤在 [0, ..., config.vocab_size] 範圍內的標記計算。
  • next_sentence_label (tf.Tensor,形狀為 (batch_size,)可選) — 用於計算下一個序列預測(分類)損失的標籤。輸入應為序列對(參見 input_ids 文件字串)。索引應在 [0, 1] 範圍內:

    • 0 表示序列 B 是序列 A 的延續,
    • 1 表示序列 B 是一個隨機序列。
  • kwargs (dict[str, any]可選,預設為 {}) — 用於隱藏已棄用的舊引數。

返回

transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutputtuple(tf.Tensor)

一個 transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput 或一個 tf.Tensor 元組(如果傳遞 return_dict=Falseconfig.return_dict=False 時),包含根據配置 (BertConfig) 和輸入的不同元素。

  • prediction_logits (tf.Tensor,形狀為 (batch_size, sequence_length, config.vocab_size)) — 語言模型頭部的預測分數(SoftMax 之前的每個詞彙標記的分數)。

  • seq_relationship_logits (tf.Tensor,形狀為 (batch_size, 2)) — 下一個序列預測(分類)頭部的預測分數(SoftMax 之前的 True/False 延續分數)。

  • hidden_states (tuple(tf.Tensor)可選,當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForPreTraining.from_pretrained("google-bert/bert-base-uncased")
>>> input_ids = tokenizer("Hello, my dog is cute", add_special_tokens=True, return_tensors="tf")
>>> # Batch size 1

>>> outputs = model(input_ids)
>>> prediction_logits, seq_relationship_logits = outputs[:2]

TFBertModelLMHeadModel

class transformers.TFBertLMHeadModel

< >

( config: BertConfig *inputs **kwargs )

呼叫

< >

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

返回

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一個 tf.Tensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • loss (形狀為(n,)tf.Tensor可選,其中n是非掩碼標籤的數量,當提供了labels時返回) — 語言建模損失(用於下一標記預測)。

  • logits (tf.Tensor of shape (batch_size, sequence_length, config.vocab_size)) — 語言模型頭部的預測分數(SoftMax 之前每個詞彙標記的分數)。

  • hidden_states (tuple(tf.Tensor)可選,當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • past_key_values (list[tf.Tensor]可選,當傳遞 use_cache=Trueconfig.use_cache=True 時返回) — 長度為 config.n_layerstf.Tensor 列表,每個張量形狀為 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

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

encoder_hidden_states (tf.Tensor 形狀為 (batch_size, sequence_length, hidden_size), 可選): 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器,則用於交叉注意力。encoder_attention_mask (tf.Tensor 形狀為 (batch_size, sequence_length), 可選): 用於避免對編碼器輸入的填充標記索引執行注意力的掩碼。如果模型配置為解碼器,則此掩碼用於交叉注意力。掩碼值選擇在 [0, 1] 之間。

  • 1 表示 未被掩蓋 的標記,
  • 0 代表**被掩碼**的標記。

past_key_values (tuple[tuple[tf.Tensor]] 長度為 config.n_layers) 包含注意力塊的預計算鍵值隱藏狀態。可用於加速解碼。如果使用 past_key_values,使用者可以選擇只輸入最後一個 decoder_input_ids(那些沒有將其過去的鍵值狀態提供給此模型的)形狀為 (batch_size, 1),而不是所有 decoder_input_ids 形狀為 (batch_size, sequence_length)。use_cache (bool, 可選, 預設為 True): 如果設定為 True,則返回 past_key_values 鍵值狀態,並可用於加速解碼(參見 past_key_values)。訓練期間設定為 False,生成期間設定為 True。labels (tf.Tensornp.ndarray 形狀為 (batch_size, sequence_length), 可選): 用於計算交叉熵分類損失的標籤。索引應在 [0, ..., config.vocab_size - 1] 之間。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertLMHeadModel.from_pretrained("google-bert/bert-base-uncased")

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

TFBertForMaskedLM

class transformers.TFBertForMaskedLM

< >

( config: BertConfig *inputs **kwargs )

引數

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

Bert 模型頂部帶有 語言建模 頭。

此模型繼承自 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 position_ids: np.ndarray | tf.Tensor | None = 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: Optional[bool] = False ) transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],每個示例的形狀必須為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示**未被掩碼**的標記,
    • 0 表示**被掩碼**的標記。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 分段標記索引,指示輸入的第一個和第二個部分。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A 標記,
    • 1 對應於 句子 B 標記。

    什麼是標記型別 ID?

  • position_ids (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形狀為 (num_heads,)(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示頭部**未被掩碼**,
    • 0 表示頭部**被掩碼**。
  • inputs_embeds (np.ndarraytf.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.Tensornp.ndarray 形狀為 (batch_size, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 之間(請參閱 input_ids 文件字串)。索引設定為 -100 的標記將被忽略(掩碼),損失只計算標籤在 [0, ..., config.vocab_size] 之間的標記。

返回

transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一個 tf.Tensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • 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)可選,當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")

>>> 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)
>>> tokenizer.decode(predicted_token_id)
'paris'
>>> 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)
>>> round(float(outputs.loss), 2)
0.88

TFBertForNextSentencePrediction

class transformers.TFBertForNextSentencePrediction

< >

( config: BertConfig *inputs **kwargs )

引數

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

Bert 模型,頂部帶有 下一個句子預測(分類) 頭。

此模型繼承自 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 position_ids: np.ndarray | tf.Tensor | None = 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 next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFNextSentencePredictorOutputtuple(tf.Tensor)

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],每個示例的形狀必須為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示**未被掩碼**的標記,
    • 0 表示**被掩碼**的標記。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 分段標記索引,指示輸入的第一個和第二個部分。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A 標記,
    • 1 對應於 句子 B 標記。

    什麼是標記型別 ID?

  • position_ids (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形狀為 (num_heads,)(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示頭部**未被掩碼**,
    • 0 表示頭部**被掩碼**。
  • inputs_embeds (np.ndarraytf.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.modeling_tf_outputs.TFNextSentencePredictorOutputtuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或一個 tf.Tensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • loss (tf.Tensor 形狀為 (n,), 可選, 當提供 next_sentence_label 時返回,其中 n 是非掩碼標籤的數量) — 下一句預測損失。

  • logits (tf.Tensor 形狀為 (batch_size, 2)) — 下一個序列預測(分類)頭的預測分數(SoftMax 之前的 True/False 延續分數)。

  • hidden_states (tuple(tf.Tensor)可選,當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="tf")

>>> logits = model(encoding["input_ids"], token_type_ids=encoding["token_type_ids"])[0]
>>> assert logits[0][0] < logits[0][1]  # the next sentence was random

TFBertForSequenceClassification

class transformers.TFBertForSequenceClassification

< >

( config: BertConfig *inputs **kwargs )

引數

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

Bert 模型轉換器,頂部帶有一個序列分類/迴歸頭(在池化輸出之上有一個線性層),例如用於 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],每個示例的形狀必須為 (batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。

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

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示**未被掩碼**的標記,
    • 0 表示**被掩碼**的標記。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 分段標記索引,指示輸入的第一個和第二個部分。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A 標記,
    • 1 對應於 句子 B 標記。

    什麼是標記型別 ID?

  • position_ids (np.ndarraytf.Tensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形狀為 (num_heads,)(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示頭部**未被掩碼**,
    • 0 表示頭部**被掩碼**。
  • inputs_embeds (np.ndarraytf.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 模組)在訓練和評估之間的行為不同)。
  • labels (tf.Tensornp.ndarray,形狀為 (batch_size,), 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels == 1,則計算迴歸損失(均方損失),如果 config.num_labels > 1,則計算分類損失(交叉熵)。

返回

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一個 tf.Tensor 元組(如果傳入 return_dict=False 或當 config.return_dict=False 時),包含根據配置(BertConfig)和輸入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity")
>>> model = TFBertForSequenceClassification.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity")

>>> 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])
>>> model.config.id2label[predicted_class_id]
'LABEL_1'
>>> # 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 = TFBertForSequenceClassification.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.01

TFBertForMultipleChoice

class transformers.TFBertForMultipleChoice

< >

( config: BertConfig *inputs **kwargs )

引數

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

Bert 模型,頂部帶有多項選擇分類頭(在池化輸出之上有一個線性層和一個 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtuple(tf.Tensor)

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],每個示例的形狀必須為 (batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列 token 的索引。

    索引可以透過 AutoTokenizer 獲取。有關詳細資訊,請參閱 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor,形狀為 (batch_size, num_choices, sequence_length), 可選) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示 未被掩碼 的 token,
    • 0 表示 被掩碼 的 token。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor,形狀為 (batch_size, num_choices, sequence_length), 可選) — 表示輸入第一部分和第二部分的段 token 索引。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A token,
    • 1 對應於 句子 B token。

    什麼是 token 型別 ID?

  • position_ids (np.ndarraytf.Tensor,形狀為 (batch_size, num_choices, sequence_length), 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形狀為 (num_heads,)(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示頭部 未被掩碼
    • 0 表示頭部 被掩碼
  • inputs_embeds (np.ndarraytf.Tensor,形狀為 (batch_size, num_choices, 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 模組)在訓練和評估之間的行為不同)。
  • labels (tf.Tensornp.ndarray,形狀為 (batch_size,), 可選) — 用於計算多項選擇分類損失的標籤。索引應在 [0, ..., num_choices] 範圍內,其中 num_choices 是輸入張量第二維的大小。(請參閱上面的 input_ids

返回

transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一個 tf.Tensor 元組(如果傳入 return_dict=False 或當 config.return_dict=False 時),包含根據配置(BertConfig)和輸入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForMultipleChoice.from_pretrained("google-bert/bert-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."

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

TFBertForTokenClassification

class transformers.TFBertForTokenClassification

< >

( config: BertConfig *inputs **kwargs )

引數

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

Bert 模型,頂部帶有 token 分類頭(在隱藏狀態輸出之上有一個線性層),例如用於命名實體識別(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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFTokenClassifierOutputtuple(tf.Tensor)

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],每個示例的形狀必須為 (batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。

    索引可以透過 AutoTokenizer 獲取。有關詳細資訊,請參閱 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示 未被掩碼 的 token,
    • 0 表示 被掩碼 的 token。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length), 可選) — 表示輸入第一部分和第二部分的段 token 索引。索引選擇在 [0, 1] 之間:

    • 0 對應於 句子 A token,
    • 1 對應於 句子 B token。

    什麼是 token 型別 ID?

  • position_ids (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形狀為 (num_heads,)(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示頭部 未被掩碼
    • 0 表示頭部 被掩碼
  • inputs_embeds (np.ndarraytf.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 模組)在訓練和評估之間的行為不同)。
  • labels (tf.Tensornp.ndarray,形狀為 (batch_size, sequence_length), 可選) — 用於計算 token 分類損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。

返回

transformers.modeling_tf_outputs.TFTokenClassifierOutputtuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一個 tf.Tensor 元組(如果傳入 return_dict=False 或當 config.return_dict=False 時),包含根據配置(BertConfig)和輸入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("dbmdz/bert-large-cased-finetuned-conll03-english")
>>> model = TFBertForTokenClassification.from_pretrained("dbmdz/bert-large-cased-finetuned-conll03-english")

>>> 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()]
>>> predicted_tokens_classes
['O', 'I-ORG', 'I-ORG', 'I-ORG', 'O', 'O', 'O', 'O', 'O', 'I-LOC', 'O', 'I-LOC', 'I-LOC'] 
>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)
>>> round(float(loss), 2)
0.01

TFBertForQuestionAnswering

class transformers.TFBertForQuestionAnswering

< >

( config: BertConfig *inputs **kwargs )

引數

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

Bert 模型,頂部帶有一個用於抽取式問答任務(如 SQuAD)的 span 分類頭(在隱藏狀態輸出之上有一個線性層,用於計算 span start logitsspan 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 token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None 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: Optional[bool] = False ) transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

引數

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor] `dict[str, tf.Tensor]dict[str, np.ndarray],每個示例的形狀必須為 (batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。

    索引可以透過 AutoTokenizer 獲取。有關詳細資訊,請參閱 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什麼是輸入 ID?

  • attention_mask (np.ndarraytf.Tensor,形狀為 (batch_size, sequence_length), 可選) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值選擇在 [0, 1] 之間:

    • 1 表示 未被掩碼 的 token,
    • 0 表示 被掩碼 的 token。

    什麼是注意力掩碼?

  • token_type_ids (np.ndarraytf.Tensor, 形狀為 (batch_size, sequence_length), 可選) — 分段 token 索引,用於指示輸入的第一個和第二個部分。索引值在 [0, 1] 之間選擇:

    • 0 對應於 句子 A 的 token,
    • 1 對應於 句子 B 的 token。

    什麼是 token type ID?

  • position_ids (np.ndarraytf.Tensor, 形狀為 (batch_size, sequence_length), 可選) — 輸入序列中每個 token 在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]

    什麼是 position ID?

  • head_mask (np.ndarraytf.Tensor, 形狀為 (num_heads,)(num_layers, num_heads), 可選) — 用於使自注意力模組中的選定頭部無效的掩碼。掩碼值在 [0, 1] 之間選擇:

    • 1 表示頭部 未被掩蓋
    • 0 表示頭部 被掩蓋
  • inputs_embeds (np.ndarraytf.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 模組在訓練和評估之間有不同的行為)。
  • start_positions (tf.Tensornp.ndarray, 形狀為 (batch_size,), 可選) — 用於計算 token 分類損失的標註 span 起始位置(索引)的標籤。位置將被限制在序列長度(sequence_length)範圍內。序列以外的位置不計入損失計算。
  • end_positions (tf.Tensornp.ndarray, 形狀為 (batch_size,), 可選) — 用於計算 token 分類損失的標註 span 結束位置(索引)的標籤。位置將被限制在序列長度(sequence_length)範圍內。序列以外的位置不計入損失計算。

返回

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

一個 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一個 tf.Tensor 元組(如果傳遞 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • loss (tf.Tensor, 形狀為 (batch_size, ), 可選, 當提供了 start_positionsend_positions 時返回) — 總 span 提取損失,是起始位置和結束位置的交叉熵之和。

  • 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=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入輸出 + 每個層的一個輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(tf.Tensor)可選,當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

TFBertForQuestionAnswering 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/bert-base-cased-squad2")
>>> model = TFBertForQuestionAnswering.from_pretrained("ydshieh/bert-base-cased-squad2")

>>> 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]
>>> tokenizer.decode(predict_answer_tokens)
'a nice puppet'
>>> # target is "nice puppet"
>>> target_start_index = tf.constant([14])
>>> target_end_index = tf.constant([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = tf.math.reduce_mean(outputs.loss)
>>> round(float(loss), 2)
7.41

FlaxBertModel

class transformers.FlaxBertModel

< >

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

引數

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

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32, jax.numpy.float16 (在 GPU 上) 和 jax.numpy.bfloat16 (在 TPU 上) 中的一種。

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

原始的 Bert 模型 transformer,輸出原始的隱藏狀態,沒有頂部任何特定的頭部。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

  • input_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。

    索引可以使用 AutoTokenizer 獲取。更多詳情請參見 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什麼是 input ID?

  • attention_mask (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 避免對填充 token 索引執行注意力操作的掩碼。掩碼值在 [0, 1] 之間選擇:

    • 1 表示 token 未被掩蓋
    • 0 表示 token 被掩蓋

    什麼是注意力掩碼?

  • token_type_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 分段 token 索引,用於指示輸入的第一個和第二個部分。索引值在 [0, 1] 之間選擇:

    • 0 對應於 句子 A 的 token,
    • 1 對應於 句子 B 的 token。

    什麼是 token type ID?

  • position_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 輸入序列中每個 token 在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) -- 用於使注意力模組中選定頭部無效的掩碼。掩碼值在 [0, 1]` 之間選擇:

    • 1 表示頭部 未被掩蓋
    • 0 表示頭部 被掩蓋
  • return_dict (bool, 可選) — 是否返回 ModelOutput 物件,而不是普通的元組。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一個 torch.FloatTensor 元組(如果傳遞 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

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

  • pooler_output (jnp.ndarray, 形狀為 (batch_size, hidden_size)) — 序列第一個 token(分類 token)的最後一層隱藏狀態,經線性層和 Tanh 啟用函式進一步處理。線性層權重在預訓練期間根據下一句預測(分類)目標進行訓練。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertModel

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertModel.from_pretrained("google-bert/bert-base-uncased")

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

>>> last_hidden_states = outputs.last_hidden_state

FlaxBertForPreTraining

class transformers.FlaxBertForPreTraining

< >

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

引數

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

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32, jax.numpy.float16 (在 GPU 上) 和 jax.numpy.bfloat16 (在 TPU 上) 中的一種。

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

Bert 模型在預訓練期間在頂部帶有兩個頭:一個 masked language modeling(掩碼語言建模)頭和一個 next sentence prediction (classification)(下一句預測(分類))頭。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutputtuple(torch.FloatTensor)

引數

  • input_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。

    索引可以使用 AutoTokenizer 獲取。更多詳情請參見 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什麼是 input ID?

  • attention_mask (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 避免對填充 token 索引執行注意力操作的掩碼。掩碼值在 [0, 1] 之間選擇:

    • 1 表示 token 未被掩蓋
    • 0 表示 token 被掩蓋

    什麼是注意力掩碼?

  • token_type_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 分段 token 索引,用於指示輸入的第一個和第二個部分。索引值在 [0, 1] 之間選擇:

    • 0 對應於 句子 A 的 token,
    • 1 對應於 句子 B 的 token。

    什麼是 token type ID?

  • position_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 輸入序列中每個 token 在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) -- 用於使注意力模組中選定頭部無效的掩碼。掩碼值在 [0, 1]` 之間選擇:

    • 1 表示頭部 未被掩蓋
    • 0 表示頭部 被掩蓋
  • return_dict (bool, 可選) — 是否返回 ModelOutput 物件,而不是普通的元組。

返回

transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutputtuple(torch.FloatTensor)

一個 transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput 或一個 torch.FloatTensor 元組(如果傳遞 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • prediction_logits (jnp.ndarray, 形狀為 (batch_size, sequence_length, config.vocab_size)) — 語言建模頭部(SoftMax 之前的每個詞彙 token 的分數)的預測分數。

  • seq_relationship_logits (jnp.ndarray, 形狀為 (batch_size, 2)) — 下一序列預測(分類)頭部(SoftMax 之前 True/False 延續的分數)的預測分數。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForPreTraining

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForPreTraining.from_pretrained("google-bert/bert-base-uncased")

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

>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logits

FlaxBertForCausalLM

class transformers.FlaxBertForCausalLM

< >

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

引數

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

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32, jax.numpy.float16 (在 GPU 上) 和 jax.numpy.bfloat16 (在 TPU 上) 中的一種。

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

Bert 模型頂部帶有語言建模頭部(隱藏狀態輸出頂部的線性層),例如用於自迴歸任務。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

  • input_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。

    索引可以使用 AutoTokenizer 獲取。更多詳情請參見 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什麼是 input ID?

  • attention_mask (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 避免對填充 token 索引執行注意力操作的掩碼。掩碼值在 [0, 1] 之間選擇:

    • 1 表示 token 未被掩蓋
    • 0 表示 token 被掩蓋

    什麼是注意力掩碼?

  • token_type_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 分段 token 索引,用於指示輸入的第一個和第二個部分。索引值在 [0, 1] 之間選擇:

    • 0 對應於 句子 A 的 token,
    • 1 對應於 句子 B 的 token。

    什麼是 token type ID?

  • position_ids (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) — 輸入序列中每個 token 在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray, 形狀為 (batch_size, sequence_length), 可選) -- 用於使注意力模組中選定頭部無效的掩碼。掩碼值在 [0, 1]` 之間選擇:

    • 1 表示頭部 未被掩蓋
    • 0 表示頭部 被掩蓋
  • return_dict (bool, 可選) — 是否返回 ModelOutput 物件,而不是普通的元組。

返回

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 元組(如果傳遞 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size)jnp.ndarray) — 語言建模頭的預測分數(SoftMax 之前每個詞彙 token 的分數)。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 後的交叉注意力權重,用於計算交叉注意力頭中的加權平均。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可選, 當傳遞 use_cache=Trueconfig.use_cache=True 時返回) — 長度為 config.n_layersjnp.ndarray 元組,每個元組包含自注意力和交叉注意力層的快取鍵值狀態(如果模型用於編碼器-解碼器設定)。僅當 config.is_decoder = True 時相關。

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForCausalLM.from_pretrained("google-bert/bert-base-uncased")

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

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]

FlaxBertForMaskedLM

class transformers.FlaxBertForMaskedLM

< >

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

引數

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

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)之一。

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

Bert 模型頂部帶有 語言建模 頭。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID?

  • attention_mask (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]

    • 1 表示標記 未被掩碼,
    • 0 表示標記 已被掩碼.

    什麼是注意力掩碼?

  • token_type_ids (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 分段標記索引,用於指示輸入的第一個和第二個部分。索引選自 [0, 1]

    • 0 對應於 句子 A 標記,
    • 1 對應於 句子 B 標記.

    什麼是標記型別 ID?

  • position_ids (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 用於遮蔽注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]

    • 1 表示頭部 未被掩碼,
    • 0 表示頭部 已被掩碼.
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.modeling_flax_outputs.FlaxMaskedLMOutputtuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size)jnp.ndarray) — 語言建模頭的預測分數(SoftMax 之前每個詞彙 token 的分數)。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")

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

FlaxBertForNextSentencePrediction

class transformers.FlaxBertForNextSentencePrediction

< >

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

引數

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

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)之一。

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

Bert 模型,頂部帶有 下一個句子預測(分類) 頭。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID?

  • attention_mask (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]

    • 1 表示標記 未被掩碼,
    • 0 表示標記 已被掩碼.

    什麼是注意力掩碼?

  • token_type_ids (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 分段標記索引,用於指示輸入的第一個和第二個部分。索引選自 [0, 1]

    • 0 對應於 句子 A 標記,
    • 1 對應於 句子 B 標記.

    什麼是標記型別 ID?

  • position_ids (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 用於遮蔽注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]

    • 1 表示頭部 未被掩碼,
    • 0 表示頭部 已被掩碼.
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutputtuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutput 或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • logits (形狀為 (batch_size, 2)jnp.ndarray) — 下一個序列預測(分類)頭部(SoftMax 之前的 True/False 延續分數)的預測分數。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForNextSentencePrediction

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="jax")

>>> outputs = model(**encoding)
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1]  # next sentence was random

FlaxBertForSequenceClassification

class transformers.FlaxBertForSequenceClassification

< >

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

引數

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

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)之一。

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

Bert 模型轉換器,頂部帶有一個序列分類/迴歸頭(在池化輸出之上有一個線性層),例如用於 GLUE 任務。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID?

  • attention_mask (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]

    • 1 表示標記 未被掩碼,
    • 0 表示標記 已被掩碼.

    什麼是注意力掩碼?

  • token_type_ids (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 分段標記索引,用於指示輸入的第一個和第二個部分。索引選自 [0, 1]

    • 0 對應於 句子 A 標記,
    • 1 對應於 句子 B 標記.

    什麼是標記型別 ID?

  • position_ids (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (形狀為 (batch_size, sequence_length)numpy.ndarray, 可選) — 用於遮蔽注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]

    • 1 表示頭部 未被掩碼,
    • 0 表示頭部 已被掩碼.
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.modeling_flax_outputs.FlaxSequenceClassifierOutputtuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • logits (形狀為 (batch_size, config.num_labels)jnp.ndarray) — 分類(如果 config.num_labels==1,則為迴歸)分數(SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased")

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

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

FlaxBertForMultipleChoice

class transformers.FlaxBertForMultipleChoice

< >

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

引數

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

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)之一。

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

    請注意,這僅指定了計算的資料型別,不影響模型引數的資料型別。

    如果您希望更改模型引數的資料型別,請參閱to_fp16()to_bf16()

Bert 模型,頂部帶有多項選擇分類頭(在池化輸出之上有一個線性層和一個 softmax),例如用於 RocStories/SWAG 任務。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID?

  • attention_mask (形狀為 (batch_size, num_choices, sequence_length)numpy.ndarray, 可選) — 避免對填充標記索引執行注意力的掩碼。掩碼值選自 [0, 1]

    • 1 表示標記 未被掩碼,
    • 0 表示標記 已被掩碼.

    什麼是注意力掩碼?

  • token_type_ids (形狀為 (batch_size, num_choices, sequence_length)numpy.ndarray, 可選) — 分段標記索引,用於指示輸入的第一個和第二個部分。索引選自 [0, 1]

    • 0 對應於 句子 A 標記,
    • 1 對應於 句子 B 標記.

    什麼是標記型別 ID?

  • position_ids (形狀為 (batch_size, num_choices, sequence_length)numpy.ndarray, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (形狀為 (batch_size, num_choices, sequence_length)numpy.ndarray, 可選) — 用於遮蔽注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]

    • 1 表示頭部 未被掩碼,
    • 0 表示頭部 已被掩碼.
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutputtuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一個 torch.FloatTensor 元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置(BertConfig)和輸入的不同元素。

  • logits (形狀為 (batch_size, num_choices)jnp.ndarray) — num_choices 是輸入張量的第二個維度。(請參閱上面的 input_ids)。

    分類分數(SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForMultipleChoice

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForMultipleChoice.from_pretrained("google-bert/bert-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."

>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})

>>> logits = outputs.logits

FlaxBertForTokenClassification

class transformers.FlaxBertForTokenClassification

< >

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

引數

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

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果要更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)之一。

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果要更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

Bert 模型,頂部帶有 token 分類頭(在隱藏狀態輸出之上有一個線性層),例如用於命名實體識別(NER)任務。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID?

  • attention_mask (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 遮罩,用於避免在填充標記索引上執行注意力。遮罩值在 [0, 1] 中選擇:

    • 1 表示未被遮罩的標記,
    • 0 表示被遮罩的標記。

    什麼是注意力遮罩?

  • token_type_ids (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 段標記索引,用於指示輸入的第一個和第二個部分。索引在 [0, 1] 中選擇:

    • 0 對應於 *句子 A* 標記,
    • 1 對應於 *句子 B* 標記。

    什麼是標記型別 ID?

  • position_ids (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 遮罩,用於將注意力模組中選定的頭置空。遮罩值在 [0, 1] 中選擇:

    • 1 表示頭未被遮罩
    • 0 表示頭被遮罩
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.modeling_flax_outputs.FlaxTokenClassifierOutputtuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一個 torch.FloatTensor 元組(如果傳遞了 return_dict=Falseconfig.return_dict=False),包含根據配置 (BertConfig) 和輸入的不同元素。

  • logits (jnp.ndarray,形狀為 (batch_size, sequence_length, config.num_labels)) — 分類得分(SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForTokenClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForTokenClassification.from_pretrained("google-bert/bert-base-uncased")

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

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

FlaxBertForQuestionAnswering

class transformers.FlaxBertForQuestionAnswering

< >

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

引數

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

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果要更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可選, 預設為 jax.numpy.float32) — 計算的資料型別。可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)之一。

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

    請注意,這僅指定計算的資料型別,不影響模型引數的資料型別。

    如果要更改模型引數的資料型別,請參閱 to_fp16()to_bf16()

Bert 模型,頂部帶有用於 SQuAD 等抽取式問答任務的 span 分類頭(在隱藏狀態輸出之上有一個線性層,用於計算 span start logitsspan end logits)。

該模型繼承自 FlaxPreTrainedModel。請查閱其超類文件,瞭解該庫為所有模型實現的通用方法(例如下載、儲存和轉換 PyTorch 模型權重)

該模型也是 flax.linen.Module 的子類。將其作為常規的 Flax Linen 模組使用,並參考 Flax 文件中有關通用用法和行為的所有事項。

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

__call__

< >

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

引數

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

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

    什麼是輸入 ID?

  • attention_mask (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 遮罩,用於避免在填充標記索引上執行注意力。遮罩值在 [0, 1] 中選擇:

    • 1 表示未被遮罩的標記,
    • 0 表示被遮罩的標記。

    什麼是注意力遮罩?

  • token_type_ids (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 段標記索引,用於指示輸入的第一個和第二個部分。索引在 [0, 1] 中選擇:

    • 0 對應於 *句子 A* 標記,
    • 1 對應於 *句子 B* 標記。

    什麼是標記型別 ID?

  • position_ids (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray,形狀為 (batch_size, sequence_length)可選) — 遮罩,用於將注意力模組中選定的頭置空。遮罩值在 [0, 1] 中選擇:

    • 1 表示頭未被遮罩
    • 0 表示頭被遮罩
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutputtuple(torch.FloatTensor)

一個 transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一個 torch.FloatTensor 元組(如果傳遞了 return_dict=Falseconfig.return_dict=False),包含根據配置 (BertConfig) 和輸入的不同元素。

  • start_logits (jnp.ndarray,形狀為 (batch_size, sequence_length)) — 跨度開始得分(SoftMax 之前)。

  • end_logits (jnp.ndarray,形狀為 (batch_size, sequence_length)) — 跨度結束得分(SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入輸出 + 一個用於每層輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每個層輸出的隱藏狀態加上初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxBertPreTrainedModel 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxBertForQuestionAnswering

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForQuestionAnswering.from_pretrained("google-bert/bert-base-uncased")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")

>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits

Bert 特定輸出

class transformers.models.bert.modeling_bert.BertForPreTrainingOutput

< >

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

引數

  • loss (*可選*,在提供 labels 時返回,torch.FloatTensor,形狀為 (1,)) — 總損失,是遮罩語言模型損失和下一序列預測(分類)損失的總和。
  • prediction_logits (torch.FloatTensor,形狀為 (batch_size, sequence_length, config.vocab_size)) — 語言模型頭的預測分數(SoftMax 之前每個詞彙標記的分數)。
  • seq_relationship_logits (torch.FloatTensor,形狀為 (batch_size, 2)) — 下一序列預測(分類)頭的預測分數(SoftMax 之前 True/False 延續的分數)。
  • hidden_states (tuple[torch.FloatTensor], 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 元組(如果模型有嵌入層,則包括嵌入輸出,加上每層的輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每層輸出處的隱藏狀態,以及可選的初始嵌入輸出。

  • attentions (tuple[torch.FloatTensor], 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForPreTraining 的輸出型別。

class transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput

< >

( loss: tf.Tensor | None = None prediction_logits: Optional[tf.Tensor] = None seq_relationship_logits: Optional[tf.Tensor] = None hidden_states: Optional[Union[tuple[tf.Tensor], tf.Tensor]] = None attentions: Optional[Union[tuple[tf.Tensor], tf.Tensor]] = None )

引數

  • prediction_logits (tf.Tensor,形狀為 (batch_size, sequence_length, config.vocab_size)) — 語言模型頭的預測分數(SoftMax 之前每個詞彙標記的分數)。
  • seq_relationship_logits (tf.Tensor,形狀為 (batch_size, 2)) — 下一序列預測(分類)頭的預測分數(SoftMax 之前 True/False 延續的分數)。
  • hidden_states (tuple(tf.Tensor), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — tf.Tensor 元組(一個用於嵌入的輸出 + 一個用於每層的輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每層輸出處的隱藏狀態,以及初始嵌入輸出。

  • attentions (tuple(tf.Tensor), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — tf.Tensor 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

TFBertForPreTraining 的輸出型別。

class transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput

< >

( prediction_logits: Array = None seq_relationship_logits: Array = None hidden_states: typing.Optional[tuple[jax.Array]] = None attentions: typing.Optional[tuple[jax.Array]] = None )

引數

  • prediction_logits (jnp.ndarray,形狀為 (batch_size, sequence_length, config.vocab_size)) — 語言模型頭的預測分數(SoftMax 之前每個詞彙標記的分數)。
  • seq_relationship_logits (jnp.ndarray,形狀為 (batch_size, 2)) — 下一序列預測(分類)頭的預測分數(SoftMax 之前 True/False 延續的分數)。
  • hidden_states (tuple(jnp.ndarray), 可選, 當傳遞 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — jnp.ndarray 元組(一個用於嵌入的輸出 + 一個用於每層的輸出),形狀為 (batch_size, sequence_length, hidden_size)

    模型在每層輸出處的隱藏狀態,以及初始嵌入輸出。

  • attentions (tuple(jnp.ndarray), 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — jnp.ndarray 元組(每層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

BertForPreTraining 的輸出型別。

替換

< >

( **updates )

“返回一個新物件,用新值替換指定欄位。

< > 在 GitHub 上更新

© . This site is unofficial and not affiliated with Hugging Face, Inc.