Hugging Face 的 LOGO

Transformers 文件

CANINE

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

PyTorch

CANINE

CANINE 是一款無需分詞的 Transformer 模型。它跳過了將文字分割成子詞或詞片的常規步驟，而是逐個字元地處理文字。這意味著它直接處理原始 Unicode，使其特別適用於具有複雜或不一致分詞規則的語言，甚至能處理像拼寫錯誤這樣的噪聲輸入。由於處理字元意味著要處理更長的序列，CANINE 使用了一個巧妙的技巧。該模型在早期階段壓縮輸入（稱為下采樣），這樣 Transformer 就不必單獨處理每個字元。這使得處理過程保持了快速和高效。

你可以在 Google 組織下找到所有原始的 CANINE 檢查點。

點選右側邊欄中的 CANINE 模型，檢視更多關於如何將 CANINE 應用於不同語言任務的示例。

下面的示例演示瞭如何使用 Pipeline、AutoModel 以及從命令列生成嵌入。

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

pipeline = pipeline(
    task="feature-extraction",
    model="google/canine-c",
    device=0,               
)

pipeline("Plant create energy through a process known as photosynthesis.")

注意事項

  • CANINE 完全跳過了分詞過程——它直接處理原始字元，而非子詞。你可以選擇使用或不使用分詞器。對於批次推理和訓練，建議使用分詞器對所有序列進行填充和截斷，使其長度一致。

    from transformers import AutoTokenizer, AutoModel

tokenizer = AutoTokenizer("google/canine-c")
inputs = ["Life is like a box of chocolates.", "You never know what you gonna get."]
encoding = tokenizer(inputs, padding="longest", truncation=True, return_tensors="pt")

  • CANINE 主要設計用於在下游任務上進行微調。預訓練模型可用於掩碼語言建模或下一句預測。

CanineConfig

class transformers.CanineConfig

< >

( 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 = 16384 type_vocab_size = 16 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 bos_token_id = 57344 eos_token_id = 57345 downsampling_rate = 4 upsampling_kernel_size = 4 num_hash_functions = 8 num_hash_buckets = 16384 local_transformer_stride = 128 **kwargs )

引數

  • 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) — 嵌入層、編碼器和池化層中所有全連線層的丟棄機率。
  • attention_probs_dropout_prob (float, 可選, 預設為 0.1) — 注意力機率的丟棄率。
  • max_position_embeddings (int, 可選, 預設為 16384) — 此模型可能使用的最大序列長度。
  • type_vocab_size (int, 可選, 預設為 16) — 在呼叫 CanineModel 時傳遞的 token_type_ids 的詞彙表大小。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
  • layer_norm_eps (float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。
  • pad_token_id (int, 可選, 預設為 0) — 填充標記 ID。
  • bos_token_id (int, 可選, 預設為 57344) — 序列開始標記 ID。
  • eos_token_id (int, 可選, 預設為 57345) — 序列結束標記 ID。
  • downsampling_rate (int, 可選, 預設為 4) — 在應用深度 Transformer 編碼器之前，對原始字元序列長度進行下采樣的比率。
  • upsampling_kernel_size (int, 可選, 預設為 4) — 當從 hidden_size*2 投影回 hidden_size 時，卷積投影層的核大小（即每個視窗中的字元數）。
  • num_hash_functions (int, 可選, 預設為 8) — 要使用的雜湊函式數量。每個雜湊函式都有自己的嵌入矩陣。
  • num_hash_buckets (int, 可選, 預設為 16384) — 要使用的雜湊桶數量。
  • local_transformer_stride (int, 可選, 預設為 128) — 第一個淺層 Transformer 編碼器區域性注意力的步幅。預設為 128，以實現良好的 TPU/XLA 記憶體對齊。

這是用於儲存 CanineModel 配置的配置類。它用於根據指定的引數例項化一個 CANINE 模型，定義模型架構。使用預設值例項化配置將產生與 CANINE google/canine-s 架構類似的配置。

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

示例

>>> from transformers import CanineConfig, CanineModel

>>> # Initializing a CANINE google/canine-s style configuration
>>> configuration = CanineConfig()

>>> # Initializing a model (with random weights) from the google/canine-s style configuration
>>> model = CanineModel(configuration)

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

CanineTokenizer

class transformers.CanineTokenizer

< >

( bos_token = '\ue000' eos_token = '\ue001' sep_token = '\ue001' cls_token = '\ue000' pad_token = '\x00' mask_token = '\ue003' add_prefix_space = False model_max_length = 2048 **kwargs )

引數

  • model_max_length (int, 可選, 預設為 2048) — 模型接受的最大句子長度。

構建一個 CANINE 分詞器（即字元分割器）。它將文字轉換為字元序列，然後將每個字元轉換為其 Unicode 碼點。

CanineTokenizer 繼承自 PreTrainedTokenizer。

有關引數的使用示例和文件，請參閱父類 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], optional) — 可選的第二個 ID 列表，用於序列對。

返回

List[int]

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

透過連線和新增特殊標記，從一個序列或一對序列為序列分類任務構建模型輸入。CANINE 序列具有以下格式

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

get_special_tokens_mask

< >

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

引數

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], optional) — 可選的第二個 ID 列表，用於序列對。
  • already_has_special_tokens (bool, optional, defaults to 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], optional) — 第二個分詞後的序列。

返回

list[int]

標記型別 ID。

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

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

CANINE 特定輸出

class transformers.models.canine.modeling_canine.CanineModelOutputWithPooling

< >

( last_hidden_state: typing.Optional[torch.FloatTensor] = None pooler_output: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )

引數

  • last_hidden_state (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列（即最終淺層 Transformer 編碼器的輸出）。
  • pooler_output (torch.FloatTensor，形狀為 (batch_size, hidden_size)) — 深層 Transformer 編碼器最後一層中序列第一個標記（分類標記）的隱藏狀態，經過線性層和 Tanh 啟用函式進一步處理。線性層的權重是在預訓練期間透過下一句預測（分類）目標進行訓練的。
  • hidden_states (tuple(torch.FloatTensor), optional, 當 output_hidden_states=True 傳入或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（每個編碼器的輸入一個 + 每個編碼器每層的輸出一個），形狀為 (batch_size, sequence_length, hidden_size) 和 (batch_size, sequence_length // config.downsampling_rate, hidden_size)。模型在每一層輸出的隱藏狀態，加上每個 Transformer 編碼器的初始輸入。淺層編碼器的隱藏狀態長度為 sequence_length，但深層編碼器的隱藏狀態長度為 sequence_length // config.downsampling_rate。
  • attentions (tuple(torch.FloatTensor), optional, 當 output_attentions=True 傳入或 config.output_attentions=True 時返回) — 3 個 Transformer 編碼器中每層一個的 torch.FloatTensor 元組，形狀為 (batch_size, num_heads, sequence_length, sequence_length) 和 (batch_size, num_heads, sequence_length // config.downsampling_rate, sequence_length // config.downsampling_rate)。注意力 softmax 之後的注意力權重，用於計算自注意力頭中的加權平均值。

CanineModel 的輸出型別。基於 BaseModelOutputWithPooling，但 hidden_states 和 attentions 稍有不同，因為它們還包括了淺層 Transformer 編碼器的隱藏狀態和注意力。

CanineModel

class transformers.CanineModel

< >

( config add_pooling_layer = True )

引數

  • config (CanineModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
  • add_pooling_layer (bool, optional, defaults to True) — 是否新增池化層。

裸 Canine 模型，輸出原始隱藏狀態，頂部沒有任何特定的頭。

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.canine.modeling_canine.CanineModelOutputWithPooling 或 tuple(torch.FloatTensor)

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), optional) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：

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

    什麼是標記型別 ID？

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

    什麼是位置 ID？

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

    • 1 表示頭未被遮蓋，
    • 0 表示頭被遮蓋。
  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), optional) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為關聯向量，這會很有用。
  • output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參閱返回張量下的 `hidden_states`。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.models.canine.modeling_canine.CanineModelOutputWithPooling 或 tuple(torch.FloatTensor)

一個 transformers.models.canine.modeling_canine.CanineModelOutputWithPooling 或一個 torch.FloatTensor 的元組（如果傳入 `return_dict=False` 或 `config.return_dict=False`），包含各種元素，具體取決於配置（CanineConfig）和輸入。

  • last_hidden_state (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列（即最終淺層 Transformer 編碼器的輸出）。
  • pooler_output (torch.FloatTensor，形狀為 (batch_size, hidden_size)) — 深層 Transformer 編碼器最後一層中序列第一個標記（分類標記）的隱藏狀態，經過線性層和 Tanh 啟用函式進一步處理。線性層的權重是在預訓練期間透過下一句預測（分類）目標進行訓練的。
  • hidden_states (tuple(torch.FloatTensor), optional, 當 output_hidden_states=True 傳入或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（每個編碼器的輸入一個 + 每個編碼器每層的輸出一個），形狀為 (batch_size, sequence_length, hidden_size) 和 (batch_size, sequence_length // config.downsampling_rate, hidden_size)。模型在每一層輸出的隱藏狀態，加上每個 Transformer 編碼器的初始輸入。淺層編碼器的隱藏狀態長度為 sequence_length，但深層編碼器的隱藏狀態長度為 sequence_length // config.downsampling_rate。
  • attentions (tuple(torch.FloatTensor), optional, 當 output_attentions=True 傳入或 config.output_attentions=True 時返回) — 3 個 Transformer 編碼器中每層一個的 torch.FloatTensor 元組，形狀為 (batch_size, num_heads, sequence_length, sequence_length) 和 (batch_size, num_heads, sequence_length // config.downsampling_rate, sequence_length // config.downsampling_rate)。注意力 softmax 之後的注意力權重，用於計算自注意力頭中的加權平均值。

CanineModel 的 forward 方法會覆蓋 __call__ 特殊方法。

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

CanineForSequenceClassification

class transformers.CanineForSequenceClassification

< >

( config )

引數

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

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

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

forward

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), optional) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [0, 1] 中選擇：

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

    什麼是標記型別 ID？

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

    什麼是位置 ID？

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

    • 1 表示頭未被遮蓋，
    • 0 表示頭被遮蓋。
  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), optional) — 可選地，你可以不傳遞 input_ids，而是直接傳遞一個嵌入表示。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為關聯向量，這會很有用。
  • labels (torch.LongTensor，形狀為 (batch_size,), optional) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels == 1，則計算迴歸損失（均方損失），如果 config.num_labels > 1，則計算分類損失（交叉熵）。
  • output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參閱返回張量下的 `hidden_states`。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元組。

返回

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

一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳入 `return_dict=False` 或 `config.return_dict=False`），包含各種元素，具體取決於配置（CanineConfig）和輸入。

  • 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), optional, 當 output_hidden_states=True 傳入或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（如果模型有嵌入層，則為嵌入層的輸出 + 每層輸出一個），形狀為 (batch_size, sequence_length, hidden_size)。

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

  • attentions (tuple(torch.FloatTensor), optional, 當 output_attentions=True 傳入或 config.output_attentions=True 時返回) — 每層一個的 torch.FloatTensor 元組，形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

CanineForSequenceClassification 的 forward 方法會覆蓋 __call__ 特殊方法。

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

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, CanineForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForSequenceClassification.from_pretrained("google/canine-s")

>>> 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 = CanineForSequenceClassification.from_pretrained("google/canine-s", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, CanineForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForSequenceClassification.from_pretrained("google/canine-s", 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 = CanineForSequenceClassification.from_pretrained(
...     "google/canine-s", 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

CanineForMultipleChoice

class transformers.CanineForMultipleChoice

< >

( config )

引數

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

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

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

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

forward

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記被遮蓋。

    什麼是注意力掩碼？

  • token_type_ids (torch.LongTensor，形狀為 (batch_size, num_choices, sequence_length), optional) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在 [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.FloatTensor，形狀為 (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），包含根據配置（CanineConfig）和輸入而不同的各種元素。

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

  • logits (形狀為 (batch_size, num_choices) 的 torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。

    分類分數（SoftMax 之前）。

  • hidden_states (tuple(torch.FloatTensor), optional, 當 output_hidden_states=True 傳入或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（如果模型有嵌入層，則為嵌入層的輸出 + 每層輸出一個），形狀為 (batch_size, sequence_length, hidden_size)。

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

  • attentions (tuple(torch.FloatTensor), optional, 當 output_attentions=True 傳入或 config.output_attentions=True 時返回) — 每層一個的 torch.FloatTensor 元組，形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

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

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

示例

>>> from transformers import AutoTokenizer, CanineForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForMultipleChoice.from_pretrained("google/canine-s")

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

CanineForTokenClassification

class transformers.CanineForTokenClassification

< >

( config )

引數

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

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

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

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

forward

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 範圍內選擇：

    • 1 表示標記未被掩碼，
    • 0 表示標記被掩碼。

    什麼是注意力掩碼？

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

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

    什麼是詞元型別 ID？

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

    什麼是位置 ID？

  • head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在 [0, 1] 範圍內選擇：

    • 1 表示頭未被掩碼，
    • 0 表示頭被掩碼。
  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
  • 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），包含根據配置（CanineConfig）和輸入而不同的各種元素。

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

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

  • hidden_states (tuple(torch.FloatTensor), optional, 當 output_hidden_states=True 傳入或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（如果模型有嵌入層，則為嵌入層的輸出 + 每層輸出一個），形狀為 (batch_size, sequence_length, hidden_size)。

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

  • attentions (tuple(torch.FloatTensor), optional, 當 output_attentions=True 傳入或 config.output_attentions=True 時返回) — 每層一個的 torch.FloatTensor 元組，形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

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

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

示例

>>> from transformers import AutoTokenizer, CanineForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForTokenClassification.from_pretrained("google/canine-s")

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

CanineForQuestionAnswering

class transformers.CanineForQuestionAnswering

< >

( config )

引數

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

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

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

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

forward

< >

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

引數

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

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

    什麼是輸入 ID？

  • attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 避免對填充標記索引執行注意力的掩碼。掩碼值在 [0, 1] 範圍內選擇：

    • 1 表示標記未被掩碼，
    • 0 表示標記被掩碼。

    什麼是注意力掩碼？

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

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

    什麼是詞元型別 ID？

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

    什麼是位置 ID？

  • head_mask (torch.FloatTensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在 [0, 1] 範圍內選擇：

    • 1 表示頭未被掩碼，
    • 0 表示頭被掩碼。
  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
  • start_positions (torch.LongTensor，形狀為 (batch_size,)，可選) — 標記的跨度開始位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（sequence_length）內。超出序列的位置不計入損失計算。
  • end_positions (torch.LongTensor，形狀為 (batch_size,)，可選) — 標記的跨度結束位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（sequence_length）內。超出序列的位置不計入損失計算。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。

返回

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

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

  • 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), optional, 當 output_hidden_states=True 傳入或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（如果模型有嵌入層，則為嵌入層的輸出 + 每層輸出一個），形狀為 (batch_size, sequence_length, hidden_size)。

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

  • attentions (tuple(torch.FloatTensor), optional, 當 output_attentions=True 傳入或 config.output_attentions=True 時返回) — 每層一個的 torch.FloatTensor 元組，形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

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

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

示例

>>> from transformers import AutoTokenizer, CanineForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForQuestionAnswering.from_pretrained("google/canine-s")

>>> 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)
...
< > 在 GitHub 上更新

←CamemBERT CodeGen→
© . This site is unofficial and not affiliated with Hugging Face, Inc.