Hugging Face 的 LOGO

Transformers 文件

MPT

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

MPT

PyTorch

概述

MPT模型由MosaicML團隊提出，釋出了多種規模和微調變體。MPT模型是一系列開源且可商用的LLM，預訓練資料量為1萬億個詞元（token）。

MPT模型是GPT風格的僅解碼器Transformer，並進行了幾項改進：效能最佳化的層實現、提高訓練穩定性的架構更改，以及透過用ALiBi替換位置嵌入來消除上下文長度限制。

  • MPT base：在下一個詞元預測任務上預訓練的MPT基礎模型
  • MPT instruct：在基於指令的任務上微調的MPT基礎模型
  • MPT storywriter：在books3語料庫中包含的65k詞元小說節選上微調2500步的MPT基礎模型，這使得模型能夠處理非常長的序列

原始程式碼可在llm-foundry倉庫中找到。

在釋出博文中閱讀更多相關資訊

使用技巧

  • 在llm-foundry倉庫的這一部分瞭解更多關於模型訓練背後的一些技術
  • 如果你想使用模型的高階版本（triton核心、直接flash attention整合），你仍然可以透過在呼叫 `from_pretrained` 時新增 `trust_remote_code=True` 來使用原始模型實現。

資源

  • 微調 Notebook，介紹如何在一個免費的Google Colab例項上微調MPT-7B，將其轉變為一個聊天機器人。

MptConfig

class transformers.MptConfig

< >

( d_model: int = 2048 n_heads: int = 16 n_layers: int = 24 expansion_ratio: int = 4 max_seq_len: int = 2048 vocab_size: int = 50368 resid_pdrop: float = 0.0 layer_norm_epsilon: float = 1e-05 emb_pdrop: float = 0.0 learned_pos_emb: bool = True attn_config: MptAttentionConfig = None init_device: str = 'cpu' logit_scale: typing.Union[float, str, NoneType] = None no_bias: bool = True verbose: int = 0 embedding_fraction: float = 1.0 norm_type: str = 'low_precision_layernorm' use_cache: bool = False initializer_range = 0.02 **kwargs )

引數

  • d_model (int, 可選, 預設為 2048) — 嵌入和隱藏狀態的維度。
  • n_heads (int, 可選, 預設為 16) — Transformer編碼器中每個注意力層的注意力頭數量。
  • n_layers (int, 可選, 預設為 24) — Transformer編碼器中的隱藏層數量。
  • expansion_ratio (int, 可選, 預設為 4) — MLP中上/下縮放的比例。
  • max_seq_len (int, 可選, 預設為 2048) — 模型的最大序列長度。
  • vocab_size (int, 可選, 預設為 50368) — Mpt模型的詞彙表大小。定義了在呼叫MptModel時，`inputs_ids`可以表示的最大不同詞元數量。請檢視此討論瞭解`vocab_size`是如何定義的。
  • resid_pdrop (float, 可選, 預設為 0.0) — 應用於注意力輸出（在與殘差結合之前）的dropout機率。
  • layer_norm_epsilon (float, 可選, 預設為 1e-05) — 在層歸一化層中使用的epsilon值。
  • emb_pdrop (float, 可選, 預設為 0.0) — 嵌入層的dropout機率。
  • learned_pos_emb (bool, 可選, 預設為 `True`) — 是否使用可學習的位置嵌入。
  • attn_config (dict, 可選) — 用於配置模型注意力模組的字典。
  • init_device (str, 可選, 預設為 `"cpu"`) — 用於引數初始化的裝置。為向後相容而定義。
  • logit_scale (float, 可選) — 如果不為None，則用此值縮放logits。
  • no_bias (bool, 可選, 預設為 `True`) — 是否在所有線性層中使用偏置。
  • verbose (int, 可選, 預設為 0) — 用於日誌記錄的詳細程度級別。在早期版本的MPT模型中用於日誌記錄。此引數已棄用。
  • embedding_fraction (float, 可選, 預設為 1.0) — 用於縮放嵌入層梯度的分數。
  • norm_type (str, 可選, 預設為 `"low_precision_layernorm"`) — 要使用的層歸一化型別。所有MPT模型都使用相同的層歸一化實現。為向後相容而定義。
  • use_cache (bool, 可選, 預設為 `False`) — 模型是否應返回最後的鍵/值注意力（並非所有模型都使用）。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態分佈初始化器的標準差。

這是一個配置類，用於儲存MptModel的配置。它用於根據指定的引數例項化一個Mpt模型，定義模型架構。使用預設值例項化一個配置將產生一個與Mpt-7b架構mosaicml/mpt-7b相似的配置。

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

示例

>>> from transformers import MptConfig, MptModel

>>> # Initializing a Mpt configuration
>>> configuration = MptConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = MptModel(configuration)

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

MptModel

class transformers.MptModel

< >

( config: MptConfig )

引數

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

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

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

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

forward

< >

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

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, input_ids_length)) — 如果 past_key_values 為 None，則 input_ids_length = sequence_length，否則為 past_key_values[0][0].shape[2] (輸入 past key value 狀態的 sequence_length)。詞彙表中輸入序列詞元的索引。

    如果使用了 past_key_values，則只有那些尚未計算其 past 值的 input_ids 才應作為 input_ids 傳入。

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

    什麼是輸入 ID？

  • past_key_values (tuple[tuple[torch.Tensor, torch.Tensor, ...]], 可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括在解碼的前一階段，當 use_cache=True 或 config.use_cache=True 時，模型返回的 past_key_values。

    允許兩種格式：

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

    模型將輸出與輸入相同的快取格式。如果沒有傳入 past_key_values，將返回舊版快取格式。

    如果使用 past_key_values，使用者可以選擇只輸入最後一個 input_ids（那些沒有向該模型提供其 past key value 狀態的詞元），其形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。

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

    • 1 表示未被遮蔽的詞元，
    • 0 表示被遮蔽的詞元。

    什麼是注意力掩碼？

  • inputs_embeds (torch.LongTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 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.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），根據配置（MptConfig）和輸入，包含各種元素。

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

    如果使用了 past_key_values，則只輸出形狀為 (batch_size, 1, hidden_size) 的序列的最後一個隱藏狀態。

  • past_key_values (Cache, 可選, 當傳入 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv cache 指南。

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

  • 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 之後，用於計算交叉注意力頭中的加權平均。

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

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

MptForCausalLM

class transformers.MptForCausalLM

< >

( config: MptConfig )

引數

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

帶有語言模型頭的 MPT 模型轉換器（線性層，其權重與輸入嵌入繫結）。

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor, torch.Tensor], ...]] = None attention_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[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 (torch.LongTensor，形狀為 (batch_size, input_ids_length)) — 如果 past_key_values 為 None，則 input_ids_length = sequence_length，否則為 past_key_values[0][0].shape[2] (輸入 past key value 狀態的 sequence_length)。詞彙表中輸入序列詞元的索引。

    如果使用了 past_key_values，則只有那些尚未計算其 past 值的 input_ids 才應作為 input_ids 傳入。

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

    什麼是輸入 ID？

  • past_key_values (tuple[tuple[torch.Tensor, torch.Tensor, ...]], 可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括在解碼的前一階段，當 use_cache=True 或 config.use_cache=True 時，模型返回的 past_key_values。

    允許兩種格式：

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

    模型將輸出與輸入相同的快取格式。如果沒有傳入 past_key_values，將返回舊版快取格式。

    如果使用 past_key_values，使用者可以選擇只輸入最後一個 input_ids（那些沒有向該模型提供其 past key value 狀態的詞元），其形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。

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

    • 1 表示未被遮蔽的詞元，
    • 0 表示被遮蔽的詞元。

    什麼是注意力掩碼？

  • inputs_embeds (torch.Tensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會很有用。
  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 語言建模的標籤。請注意，標籤在模型內部會進行偏移，即你可以設定 labels = input_ids。索引在 [-100, 0, ..., config.vocab_size] 中選擇。所有設定為 -100 的標籤都會被忽略（遮蔽），損失僅對 [0, ..., config.vocab_size] 中的標籤進行計算。
  • 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），根據配置（MptConfig）和輸入，包含各種元素。

  • 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 cache 指南。

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

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

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

示例

MptForSequenceClassification

class transformers.MptForSequenceClassification

< >

( config: MptConfig )

引數

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

帶有序列分類頭的 MPT 模型轉換器（線性層）。

MptForSequenceClassification 使用最後一個詞元進行分類，與其他因果模型（如 GPT-1）一樣。

由於它對最後一個詞元進行分類，因此需要知道最後一個詞元的位置。如果在配置中定義了 pad_token_id，它會找到每行中最後一個非填充詞元。如果沒有定義 pad_token_id，它會簡單地取批次中每行的最後一個值。由於當傳入 inputs_embeds 而不是 input_ids 時無法猜測填充詞元，它會做同樣的事情（取批次中每行的最後一個值）。

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor, torch.Tensor], ...]] = None attention_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[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 ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, input_ids_length)) — 如果 past_key_values 為 None，則 input_ids_length = sequence_length，否則為 past_key_values[0][0].shape[2] (輸入 past key value 狀態的 sequence_length)。詞彙表中輸入序列詞元的索引。

    如果使用了 past_key_values，則只有那些尚未計算其 past 值的 input_ids 才應作為 input_ids 傳入。

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

    什麼是輸入 ID？

  • past_key_values (tuple[tuple[torch.Tensor, torch.Tensor, ...]], 可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括在解碼的前一階段，當 use_cache=True 或 config.use_cache=True 時，模型返回的 past_key_values。

    允許兩種格式：

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

    模型將輸出與輸入相同的快取格式。如果沒有傳入 past_key_values，將返回舊版快取格式。

    如果使用 past_key_values，使用者可以選擇只輸入最後一個 input_ids（那些沒有向該模型提供其 past key value 狀態的詞元），其形狀為 (batch_size, 1)，而不是所有形狀為 (batch_size, sequence_length) 的 input_ids。

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免在填充詞元索引上執行注意力的掩碼。掩碼值在 [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，則計算分類損失（交叉熵）。
  • 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.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），根據配置（MptConfig）和輸入，包含各種元素。

  • loss (形狀為 (1,) 的 torch.FloatTensor，可選，當提供 labels 時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。

  • logits (形狀為 (batch_size, config.num_labels) 的 torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。

  • past_key_values (Cache, 可選, 當傳入 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv cache 指南。

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

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

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

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

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, MptForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("mosaicml/mpt-7b")
>>> model = MptForSequenceClassification.from_pretrained("mosaicml/mpt-7b")

>>> 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 = MptForSequenceClassification.from_pretrained("mosaicml/mpt-7b", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, MptForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("mosaicml/mpt-7b")
>>> model = MptForSequenceClassification.from_pretrained("mosaicml/mpt-7b", 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 = MptForSequenceClassification.from_pretrained(
...     "mosaicml/mpt-7b", 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

MptForTokenClassification

class transformers.MptForTokenClassification

< >

( config: MptConfig )

引數

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

帶有詞元分類頭的 Mpt 轉換器（在隱藏狀態輸出之上有一個線性層），例如用於命名實體識別（NER）任務。

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor, torch.Tensor], ...]] = None attention_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[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 **deprecated_arguments ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

引數

  • input_ids (形狀為 (batch_size, input_ids_length) 的 torch.LongTensor) — 如果 `past_key_values` 為 `None`，則 `input_ids_length` = `sequence_length`；否則為 `past_key_values[0][0].shape[2]` (輸入 `past_key_values` 狀態的 `sequence_length`)。詞彙表中輸入序列詞元的索引。

    如果使用了 `past_key_values`，則只有那些尚未計算其過去值的 `input_ids` 才應作為 `input_ids` 傳遞。

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

    什麼是輸入 ID？

  • past_key_values (tuple[tuple[torch.Tensor, 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`（即那些沒有為其提供過去鍵值狀態的 `input_ids`），而不是形狀為 `(batch_size, sequence_length)` 的所有 `input_ids`。

  • attention_mask (形狀為 `(batch_size, sequence_length)` 的 `torch.Tensor`，*可選*) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值選自 `[0, 1]`：

    • 1 表示**未被掩碼**的詞元，
    • 0 表示**被掩碼**的詞元。

    什麼是注意力掩碼？

  • inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `torch.Tensor`，*可選*) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關向量，這會很有用。
  • labels (形狀為 `(batch_size,)` 的 `torch.LongTensor`，*可選*) — 用於計算序列分類/迴歸損失的標籤。索引應在 `[0, ..., config.num_labels - 1]` 範圍內。如果 `config.num_labels == 1`，則計算迴歸損失 (均方損失)；如果 `config.num_labels > 1`，則計算分類損失 (交叉熵)。
  • 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.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或者 `config.return_dict=False`），根據配置 (MptConfig) 和輸入包含不同的元素。

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

MptForTokenClassification 的 forward 方法覆蓋了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, MptForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("mosaicml/mpt-7b")
>>> model = MptForTokenClassification.from_pretrained("mosaicml/mpt-7b")

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

MptForQuestionAnswering

class transformers.MptForQuestionAnswering

< >

( config )

引數

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

Mpt 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 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 (形狀為 `(batch_size, input_ids_length)` 的 `torch.LongTensor`) — 如果 `past_key_values` 為 `None`，則 `input_ids_length` = `sequence_length`；否則為 `past_key_values[0][0].shape[2]` (輸入 `past_key_values` 狀態的 `sequence_length`)。詞彙表中輸入序列詞元的索引。

    如果使用了 `past_key_values`，則只有那些尚未計算其過去值的 `input_ids` 才應作為 `input_ids` 傳遞。

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

    什麼是輸入 ID？

  • attention_mask (形狀為 `(batch_size, sequence_length)` 的 `torch.FloatTensor`，*可選*) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值選自 `[0, 1]`：

    • 1 表示**未被掩碼**的詞元，
    • 0 表示**被掩碼**的詞元。

    什麼是注意力掩碼？

  • inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `torch.FloatTensor`，*可選*) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關向量，這會很有用。
  • start_positions (形狀為 `(batch_size,)` 的 `torch.LongTensor`，*可選*) — 標記片段開始位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（`sequence_length`）內。序列之外的位置不計入損失計算。
  • end_positions (形狀為 `(batch_size,)` 的 `torch.LongTensor`，*可選*) — 標記片段結束位置（索引）的標籤，用於計算詞元分類損失。位置被限制在序列長度（`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`），根據配置 (MptConfig) 和輸入包含不同的元素。

  • loss (torch.FloatTensor of shape (1,), 可選, 當提供 labels 時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。

  • end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。

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

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

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

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

MptForQuestionAnswering 的 forward 方法覆蓋了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, MptForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("mosaicml/mpt-7b")
>>> model = MptForQuestionAnswering.from_pretrained("mosaicml/mpt-7b")

>>> 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 上更新

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