Transformers 文件
RoCBert
並獲得增強的文件體驗
開始使用
RoCBert
RoCBert 是一個預訓練的中文 BERT 模型，旨在對抗錯別字和同義詞等對抗性攻擊。它透過對比學習目標進行預訓練，以對齊正常和對抗性文字示例。這些示例包括中文的不同語義、語音和視覺特徵。這使得 RoCBert 對操作更具魯棒性。
您可以在 weiweishi 配置檔案下找到所有原始的 RoCBert 檢查點。
此模型由 weiweishi 貢獻。
點選右側邊欄中的 RoCBert 模型，檢視如何將 RoCBert 應用於不同的中文語言任務的更多示例。
以下示例演示瞭如何使用 Pipeline、AutoModel 和命令列預測 [MASK] 標記。
import torch
from transformers import pipeline
pipeline = pipeline(
task="fill-mask",
model="weiweishi/roc-bert-base-zh",
torch_dtype=torch.float16,
device=0
)
pipeline("這家餐廳的拉麵是我[MASK]過的最好的拉麵之")RoCBertConfig
class transformers.RoCBertConfig
< 源 >( 詞彙表大小 = 30522 隱藏層大小 = 768 隱藏層數量 = 12 注意力頭數量 = 12 中間層大小 = 3072 隱藏層啟用函式 = 'gelu' 隱藏層dropout機率 = 0.1 注意力機率dropout機率 = 0.1 最大位置嵌入 = 512 型別詞彙表大小 = 2 初始化範圍 = 0.02 層歸一化epsilon = 1e-12 使用快取 = True 填充標記ID = 0 位置嵌入型別 = 'absolute' 分類器dropout = None 啟用發音 = True 啟用形狀 = True 發音嵌入維度 = 768 發音詞彙表大小 = 910 形狀嵌入維度 = 512 形狀詞彙表大小 = 24858 連線輸入 = True **kwargs )
引數
- vocab_size (
int, 可選, 預設為 30522) — RoCBert 模型的詞彙表大小。定義了呼叫 RoCBertModel 時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 (
str或function, 可選, 預設為"gelu") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果是字串，支援"gelu"、"relu"、"selu"和"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) — 呼叫 RoCBertModel 時token_type_ids的詞彙表大小。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態分佈初始化器的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon。 - is_decoder (
bool, 可選, 預設為False) — 模型是否用作解碼器。如果為False，則模型用作編碼器。 - use_cache (
bool, 可選, 預設為True) — 模型是否應該返回最後一個鍵/值注意力（並非所有模型都使用）。僅當config.is_decoder=True時相關。 - position_embedding_type (
str, 可選, 預設為"absolute") — 位置嵌入的型別。選擇"absolute"、"relative_key"、"relative_key_query"之一。對於位置嵌入，請使用"absolute"。有關"relative_key"的更多資訊，請參閱 Self-Attention with Relative Position Representations (Shaw et al.)。有關"relative_key_query"的更多資訊，請參閱 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的方法 4。 - classifier_dropout (
float, 可選) — 分類頭部的 dropout 比率。 - enable_pronunciation (
bool, 可選, 預設為True) — 模型在訓練時是否使用發音嵌入。 - enable_shape (
bool, 可選, 預設為True) — 模型在訓練時是否使用形狀嵌入。 - pronunciation_embed_dim (
int, 可選, 預設為 768) — 發音嵌入的維度。 - pronunciation_vocab_size (
int, 可選, 預設為 910) — RoCBert 模型的發音詞彙表大小。定義了呼叫 RoCBertModel 時input_pronunciation_ids可以表示的不同標記的數量。 - shape_embed_dim (
int, 可選, 預設為 512) — shape_embed 的維度。 - shape_vocab_size (
int, 可選, 預設為 24858) — RoCBert 模型的形狀詞彙量大小。定義了呼叫 RoCBertModel 時input_shape_ids可以表示的不同標記的數量。 - concat_input (
bool, 可選, 預設為True) — 定義了合併 shape_embed、pronunciation_embed 和 word_embed 的方式，如果值為 true，則 output_embed = torch.cat((word_embed, shape_embed, pronunciation_embed), -1)，否則 output_embed = (word_embed + shape_embed + pronunciation_embed) / 3 - 示例 —
這是一個配置類，用於儲存 RoCBertModel 的配置。它用於根據指定的引數例項化 RoCBert 模型，定義模型架構。使用預設值例項化配置將產生類似於 RoCBert weiweishi/roc-bert-base-zh 架構的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請參閱 PretrainedConfig 的文件。
>>> from transformers import RoCBertModel, RoCBertConfig
>>> # Initializing a RoCBert weiweishi/roc-bert-base-zh style configuration
>>> configuration = RoCBertConfig()
>>> # Initializing a model from the weiweishi/roc-bert-base-zh style configuration
>>> model = RoCBertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configRoCBertTokenizer
class transformers.RoCBertTokenizer
< 來源 >( vocab_file word_shape_file word_pronunciation_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 **kwargs )
引數
- 構建 RoCBert 分詞器。基於 WordPiece。此分詞器繼承自 PreTrainedTokenizer，它 —
- 包含 大部分主要方法。使用者應參閱此超類以獲取有關這些方法的更多資訊 —
- 方法。 — vocab_file (
str): 包含詞彙的檔案。word_shape_file (str): 包含詞 => 形狀資訊的檔案。word_pronunciation_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 中一樣）。
build_inputs_with_special_tokens
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None cls_token_id: typing.Optional[int] = None sep_token_id: typing.Optional[int] = None ) → List[int]
透過連線和新增特殊標記，從一個序列或一對序列構建用於序列分類任務的模型輸入。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]
從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。
create_token_type_ids_from_sequences
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID？
如果模型有特殊的構建方式，應在子類中重寫此方法。
RoCBertModel
class transformers.RoCBertModel
< 來源 >( config add_pooling_layer = True )
引數
- config (RoCBertModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不載入與模型關聯的權重，僅載入配置。請查閱 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 input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_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.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 詞彙表中輸入序列標記的索引。填充預設將被忽略。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor) — 形狀詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor) — 發音詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 標記。
- position_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - 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=True或config.use_cache=True時。允許兩種格式：
- Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量）。這也被稱為傳統快取格式。
模型將輸出與作為輸入提供的快取格式相同的快取格式。如果沒有傳遞
past_key_values，則將返回傳統快取格式。如果使用
past_key_values，使用者可以選擇僅輸入形狀為(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.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置（RoCBertConfig）和輸入的不同元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (形狀為
(batch_size, hidden_size)的torch.FloatTensor) — 經過用於輔助預訓練任務的層進一步處理後，序列第一個標記（分類標記）的最後一層隱藏狀態。例如，對於 BERT 家族模型，這會在經過線性層和 tanh 啟用函式處理後返回分類標記。線性層權重是在預訓練期間透過下一句預測（分類）目標進行訓練的。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True和config.add_cross_attention=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, 可選, 當傳遞use_cache=True或當config.use_cache=True時返回) — 它是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（自注意力塊中的鍵和值，如果
config.is_encoder_decoder=True，則可選地在交叉注意力塊中），可用於（參見past_key_values輸入）加速順序解碼。
RoCBertModel 前向傳播方法會覆蓋 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
RoCBertForPreTraining
class transformers.RoCBertForPreTraining
< 源 >( 配置 )
引數
- config (RoCBertForPreTraining) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
RoCBert 模型，在預訓練期間使用對比損失和 masked_lm_loss。
該模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
前向傳播
< 源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None attack_input_ids: typing.Optional[torch.Tensor] = None attack_input_shape_ids: typing.Optional[torch.Tensor] = None attack_input_pronunciation_ids: typing.Optional[torch.Tensor] = None attack_attention_mask: typing.Optional[torch.Tensor] = None attack_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_input_ids: typing.Optional[torch.Tensor] = None labels_input_shape_ids: typing.Optional[torch.Tensor] = None labels_input_pronunciation_ids: typing.Optional[torch.Tensor] = None labels_attention_mask: typing.Optional[torch.Tensor] = None labels_token_type_ids: 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.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor) — 形狀詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor) — 發音詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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** 標記。
- attack_input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算對比損失的攻擊樣本 ID。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（被掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - attack_input_shape_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算對比損失的攻擊樣本形狀 ID。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（被掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - attack_input_pronunciation_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算對比損失的攻擊樣本發音 ID。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（被掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - attack_attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 避免對攻擊樣本的填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：1表示未被掩碼的標記，0表示被掩碼的標記。 - attack_token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 分段標記索引，指示攻擊輸入的各個部分。索引選擇範圍為[0, 1]：0對應於句子 A 標記，1對應於句子 B 標記。 - position_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 輸入序列中每個標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - 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_input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算對比損失和 masked_lm_loss 的目標 ID。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（被掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - labels_input_shape_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算對比損失和 masked_lm_loss 的目標形狀 ID。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（被掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - labels_input_pronunciation_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算對比損失和 masked_lm_loss 的目標發音 ID。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（被掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - labels_attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 避免對標籤樣本的填充標記索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：1表示未被掩碼的標記，0表示被掩碼的標記。 - labels_token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 分段標記索引，指示標籤輸入的各個部分。索引選擇範圍為[0, 1]：0對應於句子 A 標記，1對應於句子 B 標記。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
根據配置 (RoCBertConfig) 和輸入，transformers.RoCBertForPreTraining 的前向方法，覆蓋了 __call__ 特殊方法，返回 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor 的元組（如果傳入了 return_dict=False 或 config.return_dict=False）。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 掩碼語言建模 (MLM) 損失。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RoCBertForPreTraining 的前向方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RoCBertForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForPreTraining.from_pretrained("weiweishi/roc-bert-base-zh")
>>> inputs = tokenizer("你好，很高興認識你", return_tensors="pt")
>>> attack_inputs = {}
>>> for key in list(inputs.keys()):
... attack_inputs[f"attack_{key}"] = inputs[key]
>>> label_inputs = {}
>>> for key in list(inputs.keys()):
... label_inputs[f"labels_{key}"] = inputs[key]
>>> inputs.update(label_inputs)
>>> inputs.update(attack_inputs)
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> logits.shape
torch.Size([1, 11, 21128])RoCBertForCausalLM
類 transformers.RoCBertForCausalLM
< 源 >( 配置 )
引數
- config (RoCBertForCausalLM) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有 `語言建模` 頭部用於 CLM 微調的 RoCBert 模型。
該模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
前向傳播
< 源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_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 inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.Tensor]] = None labels: typing.Optional[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 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor) — 形狀詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor) — 發音詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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** 標記。
- position_ids (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 輸入序列中每個標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - 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 表示**被掩碼**的標記。
- head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部**未被掩碼**，
- 0 表示頭部**被掩碼**。
- past_key_values (
list[torch.Tensor], 可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼前期返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量。這也稱為舊版快取格式。
模型將輸出與作為輸入提供的快取格式相同的快取格式。如果沒有傳入
past_key_values，將返回舊版快取格式。如果使用
past_key_values，使用者可以選擇只輸入形狀為(batch_size, 1)的最新input_ids（那些沒有將其過去的鍵值狀態提供給此模型的）而不是形狀為(batch_size, sequence_length)的所有input_ids。 - labels (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算從左到右語言建模損失（下一個詞預測）的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（被掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - use_cache (
bool, 可選) — 如果設定為True，則返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 物件而不是普通元組。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），包含根據配置（RoCBertConfig）和輸入的不同元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可選，當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, 可選, 當傳遞use_cache=True或當config.use_cache=True時返回) — 它是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。
RoCBertForCausalLM 的前向方法，覆蓋 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RoCBertForCausalLM, RoCBertConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> config = RoCBertConfig.from_pretrained("weiweishi/roc-bert-base-zh")
>>> config.is_decoder = True
>>> model = RoCBertForCausalLM.from_pretrained("weiweishi/roc-bert-base-zh", config=config)
>>> inputs = tokenizer("你好，很高興認識你", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsRoCBertForMaskedLM
class transformers.RoCBertForMaskedLM
< source >( 配置 )
引數
- config (RoCBertForMaskedLM) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Roc Bert 模型，頂部帶有 語言建模 頭。
該模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
前向傳播
< source >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_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.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 形狀詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 發音詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列 token 的位置索引。選擇範圍為[0, config.n_positions - 1]。 - 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 計算。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 物件而不是普通元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
根據配置 (RoCBertConfig) 和輸入，transformers.RoCBertForPreTraining 的前向方法，覆蓋了 __call__ 特殊方法，返回 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor 的元組（如果傳入了 return_dict=False 或 config.return_dict=False）。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 掩碼語言建模 (MLM) 損失。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RoCBertForMaskedLM 的前向方法，覆蓋 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RoCBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForMaskedLM.from_pretrained("weiweishi/roc-bert-base-zh")
>>> inputs = tokenizer("法國是首都[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)
'.'RoCBertForSequenceClassification
class transformers.RoCBertForSequenceClassification
< source >( 配置 )
引數
- config (RoCBertForSequenceClassification) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
RoCBert 模型轉換器，頂部帶有一個序列分類/迴歸頭（在池化輸出之上有一個線性層），例如用於 GLUE 任務。
該模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
前向傳播
< source >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 形狀詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 發音詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列 token 的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被掩碼，
- 0 表示頭部已被掩碼。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您想對如何將input_ids索引轉換為相關向量比模型內部嵌入查詢矩陣有更多的控制，則此功能很有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方誤差損失）；如果config.num_labels > 1，則計算分類損失（交叉熵）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 物件而不是普通元組。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或 config.return_dict=False），包含根據配置（RoCBertConfig）和輸入的不同元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RoCBertForSequenceClassification 的前向方法，覆蓋 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, RoCBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForSequenceClassification.from_pretrained("weiweishi/roc-bert-base-zh")
>>> 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 = RoCBertForSequenceClassification.from_pretrained("weiweishi/roc-bert-base-zh", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, RoCBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForSequenceClassification.from_pretrained("weiweishi/roc-bert-base-zh", 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 = RoCBertForSequenceClassification.from_pretrained(
... "weiweishi/roc-bert-base-zh", 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).lossRoCBertForMultipleChoice
class transformers.RoCBertForMultipleChoice
< source >( 配置 )
引數
- config (RoCBertForMultipleChoice) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Roc Bert 模型，頂部帶有一個多項選擇分類頭（在池化輸出之上有一個線性層和一個 Softmax），例如用於 RocStories/SWAG 任務。
該模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
前向傳播
< source >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_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.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 形狀詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 發音詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 token 未被掩碼，
- 0 表示 token 已被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 分段 token 索引，用於指示輸入的第一個和第二個部分。索引選擇範圍為[0, 1]：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.max_position_embeddings - 1]。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為[0, 1]:- 1 表示頭部 未被遮蔽,
- 0 表示頭部 被遮蔽.
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, num_choices, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果你想對如何將 input_ids 索引轉換為關聯向量擁有比模型內部嵌入查詢矩陣更多的控制權，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size,), 可選) — 用於計算多項選擇分類損失的標籤。索引應在[0, ..., num_choices-1]範圍內，其中num_choices是輸入張量第二個維度的大小。（參見上面的input_ids） - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 物件而不是普通元組。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MultipleChoiceModelOutput 或一個 torch.FloatTensor 元組（如果傳入了 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (RoCBertConfig) 和輸入而變化的各種元素。
-
loss (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RoCBertForMultipleChoice 的前向方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RoCBertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForMultipleChoice.from_pretrained("weiweishi/roc-bert-base-zh")
>>> 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.logitsRoCBertForTokenClassification
類 transformers.RoCBertForTokenClassification
< 來源 >( 配置 )
引數
- config (RoCBertForTokenClassification) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。要載入模型權重，請檢視 from_pretrained() 方法。
Roc Bert 轉換器，頂部帶有一個用於標記分類的頭部（一個線上性層頂部的隱藏狀態輸出），例如用於命名實體識別 (NER) 任務。
該模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
前向傳播
< 來源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_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.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列標記的索引。預設情況下會忽略填充。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 形狀詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 發音詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 標記.
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為[0, 1]:- 1 表示頭部 未被遮蔽,
- 0 表示頭部 被遮蔽.
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果你想對如何將input_ids索引轉換為關聯向量擁有比模型內部嵌入查詢矩陣更多的控制權，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 用於計算標記分類損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 物件而不是普通元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 元組（如果傳入了 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (RoCBertConfig) 和輸入而變化的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RoCBertForTokenClassification 的前向方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RoCBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForTokenClassification.from_pretrained("weiweishi/roc-bert-base-zh")
>>> 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)
...RoCBertForQuestionAnswering
類 transformers.RoCBertForQuestionAnswering
< 來源 >( 配置 )
引數
- config (RoCBertForQuestionAnswering) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。要載入模型權重，請檢視 from_pretrained() 方法。
Roc Bert 轉換器，頂部帶有一個用於抽取式問答任務（如 SQuAD）的跨度分類頭部（一個線上性層頂部的隱藏狀態輸出，用於計算 span start logits 和 span end logits）。
該模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以獲取所有與通用用法和行為相關的事項。
前向傳播
< 來源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_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.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列標記的索引。預設情況下會忽略填充。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 形狀詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 發音詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲得。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 標記.
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為[0, 1]:- 1 表示頭部 未被遮蔽,
- 0 表示頭部 被遮蔽.
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果你想對如何將input_ids索引轉換為關聯向量擁有比模型內部嵌入查詢矩陣更多的控制權，這將非常有用。 - start_positions (
torch.Tensor，形狀為(batch_size,), 可選) — 用於計算標記分類損失的標註跨度起始位置（索引）的標籤。位置將被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。 - end_positions (
torch.Tensor，形狀為(batch_size,), 可選) — 用於計算標記分類損失的標註跨度結束位置（索引）的標籤。位置將被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 物件而不是普通元組。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor 元組（如果傳入了 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (RoCBertConfig) 和輸入而變化的各種元素。
-
loss (
torch.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor元組（如果模型有嵌入層，則有一個用於嵌入層輸出，加上每個層輸出一個）的形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每個層一個）的形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
RoCBertForQuestionAnswering 的前向方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, RoCBertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForQuestionAnswering.from_pretrained("weiweishi/roc-bert-base-zh")
>>> 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)
...