Transformers 文件
StableLM
並獲得增強的文件體驗
開始使用
StableLM
概述
StableLM 3B 4E1T 由 Stability AI 在 StableLM 3B 4E1T：技術報告中提出，是多輪預訓練語言模型系列中的第一個模型。
模型詳情
StableLM 3B 4E1T 是一個僅解碼器的基礎語言模型，在1萬億個來自不同英語和程式碼資料集的詞元上進行了四輪預訓練。該模型架構基於 Transformer，採用了部分旋轉位置嵌入（Partial Rotary Position Embeddings）、SwiGLU 啟用函式、LayerNorm 等技術。
我們還提供了 StableLM Zephyr 3B，這是該模型的指令微調版本，可用於基於聊天的應用。
使用技巧
- 該架構類似於 LLaMA，但 RoPE 應用於 25% 的頭嵌入維度，使用 LayerNorm 而非 RMSNorm，並帶有可選的 QKV 偏置項。
- 基於
StableLM 3B 4E1T的模型使用與 GPTNeoXTokenizerFast 相同的分詞器。
StableLM 3B 4E1T 和 StableLM Zephyr 3B 可在 Hugging Face Hub 上找到。
以下程式碼片段演示瞭如何使用 StableLM 3B 4E1T 進行推理：
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, set_seed
>>> device = "cuda" # the device to load the model onto
>>> set_seed(0)
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = AutoModelForCausalLM.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model.to(device)
>>> model_inputs = tokenizer("The weather is always wonderful in", return_tensors="pt").to(model.device)
>>> generated_ids = model.generate(**model_inputs, max_length=32, do_sample=True)
>>> responses = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
>>> responses
['The weather is always wonderful in Costa Rica, which makes it a prime destination for retirees. That’s where the Pensionado program comes in, offering']結合 StableLM 與 Flash Attention 2
首先，請確保安裝最新版本的 Flash Attention v2。
pip install -U flash-attn --no-build-isolation
同時，請確保你的硬體與 Flash-Attention 2 相容。更多資訊請參閱 flash-attn 倉庫的官方文件。注意：你必須以半精度（例如 `torch.bfloat16`）載入模型。
現在，要使用 Flash Attention 2 執行模型，請參考以下程式碼片段：
>>> import torch
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, set_seed
>>> device = "cuda" # the device to load the model onto
>>> set_seed(0)
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = AutoModelForCausalLM.from_pretrained("stabilityai/stablelm-3b-4e1t", torch_dtype=torch.bfloat16, attn_implementation="flash_attention_2")
>>> model.to(device)
>>> model_inputs = tokenizer("The weather is always wonderful in", return_tensors="pt").to(model.device)
>>> generated_ids = model.generate(**model_inputs, max_length=32, do_sample=True)
>>> responses = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
>>> responses
['The weather is always wonderful in Costa Rica, which makes it a prime destination for retirees. That’s where the Pensionado program comes in, offering']StableLmConfig
class transformers.StableLmConfig
< 來源 >( vocab_size = 50304 intermediate_size = 6912 hidden_size = 2560 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 32 hidden_act = 'silu' max_position_embeddings = 4096 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True tie_word_embeddings = False rope_theta = 10000 rope_scaling = None use_qkv_bias = False qk_layernorm = False use_parallel_residual = False hidden_dropout = 0.0 attention_dropout = 0.0 partial_rotary_factor = 0.25 bos_token_id = 0 eos_token_id = 0 **kwargs )
引數
- vocab_size (
int, 可選, 預設為 50304) — StableLM 模型的詞彙表大小。定義了在呼叫 StableLmModel 時，可以透過inputs_ids傳遞的不同詞元的數量。 - intermediate_size (
int, 可選, 預設為 6912) — MLP 表示的維度。 - hidden_size (
int, 可選, 預設為 2560) — Transformer 解碼器中隱藏層的數量。 - num_hidden_layers (
int, 可選, 預設為 32) — Transformer 解碼器中隱藏層的數量。 - num_attention_heads (
int, 可選, 預設為 32) — Transformer 編碼器中每個注意力層的注意力頭數量。 - num_key_value_heads (
int, 可選, 預設為 32) — 這是用於實現分組查詢注意力（Grouped Query Attention）的鍵值頭數量。如果num_key_value_heads=num_attention_heads，模型將使用多頭注意力（MHA）；如果num_key_value_heads=1，模型將使用多查詢注意力（MQA）；否則將使用 GQA。當將多頭檢查點轉換為 GQA 檢查點時，每個組的鍵和值頭應透過對該組內所有原始頭進行均值池化來構建。更多詳情，請檢視這篇論文。如果未指定，將預設為num_attention_heads。 - hidden_act (
str或function, 可選, 預設為"silu") — 非線性啟用函式（函式或字串）。 - max_position_embeddings (
int, 可選, 預設為 4096) — 此模型可能使用的最大序列長度。通常將其設定為一個較大的值以備不時之需（例如，512、1024 或 2048）。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-05) — 歸一化層使用的 epsilon 值。 - use_cache (
bool, 可選, 預設為True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅在config.is_decoder=True時相關。 - tie_word_embeddings (
bool, 可選, 預設為False) — 模型的輸入和輸出詞嵌入是否應該繫結。 - rope_theta (
float, 可選, 預設為10000.0) — RoPE 嵌入的基週期。 - rope_scaling (
Dict, 可選) — 包含 RoPE 嵌入縮放配置的字典。注意：如果應用新的 RoPE 型別並且希望模型能在更長的max_position_embeddings上工作，我們建議你相應地更新此值。預期內容：rope_type(str)：要使用的 RoPE 子變體。可以是 [‘default’, ‘linear’, ‘dynamic’, ‘yarn’, ‘longrope’, ‘llama3’] 之一，其中 ‘default’ 是原始的 RoPE 實現。factor(float, 可選)：用於除 ‘default’ 以外的所有 RoPE 型別。應用於 RoPE 嵌入的縮放因子。在大多數縮放型別中，一個 x 的factor將使模型能夠處理長度為 x * 原始最大預訓練長度的序列。original_max_position_embeddings(int, *可選*)：用於 ‘dynamic’、‘longrope’ 和 ‘llama3’。預訓練期間使用的原始最大位置嵌入。attention_factor(float, *可選*)：用於 ‘yarn’ 和 ‘longrope’。應用於注意力計算的縮放因子。如果未指定，它將預設為實現所推薦的值，使用factor欄位來推斷建議值。beta_fast(float, *可選*)：僅用於 ‘yarn’。用於設定線性斜坡函式中外推（僅限）邊界的引數。如果未指定，預設為 32。beta_slow(float, *可選*)：僅用於 ‘yarn’。用於設定線性斜坡函式中內插（僅限）邊界的引數。如果未指定，預設為 1。short_factor(list[float], *可選*)：僅用於 ‘longrope’。應用於短上下文（<original_max_position_embeddings）的縮放因子。必須是一個數字列表，其長度與隱藏大小除以注意力頭數再除以 2 相同。long_factor(list[float], *可選*)：僅用於 ‘longrope’。應用於長上下文（<original_max_position_embeddings）的縮放因子。必須是一個數字列表，其長度與隱藏大小除以注意力頭數再除以 2 相同。low_freq_factor(float, *可選*)：僅用於 ‘llama3’。應用於 RoPE 低頻分量的縮放因子。high_freq_factor(float, *可選*)：僅用於 ‘llama3’。應用於 RoPE 高頻分量的縮放因子。 - use_qkv_bias (
bool, 可選, 預設為False) — 模型是否應為 qkv 層使用偏置。 - qk_layernorm (
bool, 可選, 預設為False) — 是否在投射隱藏狀態後，對每個頭的查詢和鍵進行歸一化。 - use_parallel_residual (
bool, 可選, 預設為False) — 是否在每個 Transformer 層中使用“並行”公式，這可以在大規模訓練時提供輕微的訓練速度提升。 - hidden_dropout (
float, 可選, 預設為 0.0) — 對隱藏狀態應用 MLP 後的 dropout 比率。 - attention_dropout (
float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。 - partial_rotary_factor (
float, 可選, 預設為 0.25) — 將具有旋轉嵌入的查詢和鍵的百分比。 - bos_token_id (int, 可選, 預設為 0) — 詞彙表中
BOS標記的 ID。 - eos_token_id (int, 可選, 預設為 0) — 詞彙表中
EOS標記的 ID。
這是用於儲存 ~StableLmModel 配置的配置類。它用於根據指定的引數例項化一個 StableLM 模型，定義模型架構。使用預設值例項化配置將產生與 StableLM stabilityai/stablelm-3b-4e1t 架構相似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。更多資訊請閱讀 PretrainedConfig 的文件。
StableLmModel
class transformers.StableLmModel
< source >( config: StableLmConfig )
引數
- config (StableLmConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
基礎的 Stablelm 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭（head）。
此模型繼承自 PreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 的子類。可以像使用常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選值範圍為[0, config.n_positions - 1]。 - past_key_values (
list[torch.FloatTensor]，可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常是在解碼的先前階段，當use_cache=True或config.use_cache=True時，由模型返回的past_key_values。允許兩種格式：
- 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，使用者可以選擇只輸入最後一個input_ids（那些沒有給出過去鍵值狀態的標記），形狀為(batch_size, 1)，而不是所有形狀為(batch_size, sequence_length)的input_ids。 - inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你希望比模型內部的嵌入查詢矩陣有更多控制權來將input_ids索引轉換為相關向量，這將非常有用。 - use_cache (
bool, 可選) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加速解碼（請參閱past_key_values）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - cache_position (形狀為
(sequence_length)的torch.LongTensor，可選) — 描述輸入序列標記在序列中位置的索引。與position_ids不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPast 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（StableLmConfig）和輸入，包含各種元素。
-
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 快取指南。包含預先計算的隱藏狀態（自注意塊中的鍵和值，如果
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
StableLmModel 的 forward 方法會覆蓋 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理預處理和後處理步驟，而後者會默默地忽略它們。
StableLmForCausalLM
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選值範圍為[0, config.n_positions - 1]。 - past_key_values (
list[torch.FloatTensor]，可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常是在解碼的先前階段，當use_cache=True或config.use_cache=True時，由模型返回的past_key_values。允許兩種格式：
- 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，使用者可以選擇只輸入最後一個input_ids（那些沒有給出過去鍵值狀態的標記），形狀為(batch_size, 1)，而不是所有形狀為(batch_size, sequence_length)的input_ids。 - inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你希望比模型內部的嵌入查詢矩陣有更多控制權來將input_ids索引轉換為相關向量，這將非常有用。 - labels (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 用於計算掩碼語言建模損失的標籤。索引應在[0, ..., config.vocab_size]範圍內或為 -100（請參閱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。 - cache_position (形狀為
(sequence_length)的torch.LongTensor，可選) — 描述輸入序列標記在序列中位置的索引。與position_ids不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。 - logits_to_keep (
Union[int, torch.Tensor], 預設為0) — 如果是int，則為最後logits_to_keep個標記計算 logits。如果為0，則為所有input_ids計算 logits（特殊情況）。生成時只需要最後一個標記的 logits，僅為此標記計算 logits 可以節省記憶體，這對於長序列或大詞彙量來說非常重要。如果是torch.Tensor，則必須是一維的，對應於序列長度維度中要保留的索引。這在使用打包張量格式（批次和序列長度使用單一維度）時非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithPast 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（StableLmConfig）和輸入，包含各種元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
past_key_values (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
StableLmForCausalLM 的 forward 方法會覆蓋 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理預處理和後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, StableLmForCausalLM
>>> model = StableLmForCausalLM.from_pretrained("adept/persimmon-8b-base")
>>> tokenizer = AutoTokenizer.from_pretrained("adept/persimmon-8b-base")
>>> prompt = "human: Hey, what should I eat for dinner?"
>>> inputs = tokenizer(prompt, return_tensors="pt")
>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'human: Hey, what should I eat for dinner?\n\ncat: 🐱\n\nhuman: 😐\n\n'StableLmForSequenceClassification
class transformers.StableLmForSequenceClassification
< source >( config )
引數
- config (StableLmForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
帶有序列分類頭（線性層）的 StableLm transformer。
StableLmForSequenceClassification 使用最後一個標記來進行分類，就像其他因果模型（例如 GPT-2）一樣。
由於它對最後一個標記進行分類，因此需要知道最後一個標記的位置。如果在配置中定義了 pad_token_id，它會找到每行中不是填充標記的最後一個標記。如果沒有定義 pad_token_id，它會簡單地取批次中每行的最後一個值。由於當傳遞 inputs_embeds 而不是 input_ids 時它無法猜測填充標記，因此它會做同樣的操作（取批次中每行的最後一個值）。
此模型繼承自 PreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 的子類。可以像使用常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被遮蔽，
- 0 表示標記被遮蔽。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選值範圍為[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常是在解碼的先前階段，當use_cache=True或config.use_cache=True時，由模型返回的past_key_values。允許兩種格式：
- 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，使用者可以選擇只輸入最後一個input_ids（那些沒有給出過去鍵值狀態的標記），形狀為(batch_size, 1)，而不是所有形狀為(batch_size, sequence_length)的input_ids。 - inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞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。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（StableLmConfig）和輸入，包含各種元素。
-
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 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
StableLmForSequenceClassification 的 forward 方法會覆蓋 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理預處理和後處理步驟，而後者會默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, StableLmForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = StableLmForSequenceClassification.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> 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 = StableLmForSequenceClassification.from_pretrained("stabilityai/stablelm-3b-4e1t", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, StableLmForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = StableLmForSequenceClassification.from_pretrained("stabilityai/stablelm-3b-4e1t", 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 = StableLmForSequenceClassification.from_pretrained(
... "stabilityai/stablelm-3b-4e1t", 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).lossStableLmForTokenClassification
class transformers.StableLmForTokenClassification
< source >( config )
引數
- config (StableLmForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
帶有標記分類頭（一個線上性層之上的隱藏狀態輸出層）的 Stablelm transformer，例如用於命名實體識別（NER）任務。
此模型繼承自 PreTrainedModel。請查閱超類的文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入的大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 的子類。可以像使用常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力計算的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。取值範圍為[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常是在解碼的前一個階段，當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（那些沒有為其提供過去鍵值狀態的標記），其形狀為(batch_size, 1)，而不是形狀為(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.FloatTensor，形狀為(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。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（StableLmConfig）和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
StableLmForTokenClassification 的前向方法覆蓋了 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理預處理和後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, StableLmForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> model = StableLmForTokenClassification.from_pretrained("stabilityai/stablelm-3b-4e1t")
>>> 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)
...