Transformers 文件
Llama 2
並獲得增強的文件體驗
開始使用
Llama 2
Llama 2 是一個大型語言模型家族，包含 Llama 2 和 Llama 2-Chat，提供 7B、13B 和 70B 引數的版本。Llama 2 模型基本保持了與 Llama 相同的架構，但它在更多的詞元（token）上進行了預訓練，上下文長度增加了一倍，並在 70B 模型中使用了分組查詢注意力（GQA）來提高推理效率。
Llama 2-Chat 採用監督式微調（SFT）進行訓練，並在微調後的模型上應用了帶有人類反饋的強化學習（RLHF）——拒絕取樣和近端策略最佳化（PPO）——以使聊天模型與人類偏好對齊。
你可以在 Llama 2 家族合集中找到所有原始的 Llama 2 檢查點。
點選右側邊欄中的 Llama 2 模型，檢視更多關於如何將 Llama 應用於不同語言任務的示例。
下面的示例演示瞭如何使用 Pipeline 和 AutoModel 生成文字，以及如何從命令列與 Llama 2-Chat 進行聊天。
import torch
from transformers import pipeline
pipeline = pipeline(
task="text-generation",
model="meta-llama/Llama-2-7b-hf",
torch_dtype=torch.float16,
device=0
)
pipeline("Plants create energy through a process known as")量化透過以較低精度表示權重來減少大型模型的記憶體負擔。有關更多可用量化後端，請參閱量化概述。
以下示例使用torchao僅將權重量化為int4。
# pip install torchao
import torch
from transformers import TorchAoConfig, AutoModelForCausalLM, AutoTokenizer
quantization_config = TorchAoConfig("int4_weight_only", group_size=128)
model = AutoModelForCausalLM.from_pretrained(
"meta-llama/Llama-2-13b-hf",
torch_dtype=torch.bfloat16,
device_map="auto",
quantization_config=quantization_config
)
tokenizer = AutoTokenizer.from_pretrained("meta-llama/Llama-2-13b-hf")
input_ids = tokenizer("Plants create energy through a process known as", return_tensors="pt").to("cuda")
output = model.generate(**input_ids, cache_implementation="static")
print(tokenizer.decode(output[0], skip_special_tokens=True))使用 AttentionMaskVisualizer 來更好地理解模型可以和不可以關注哪些詞元。
from transformers.utils.attention_visualizer import AttentionMaskVisualizer
visualizer = AttentionMaskVisualizer("meta-llama/Llama-2-7b-hf")
visualizer("Plants create energy through a process known as")
注意事項
將 `config.pretraining_tp` 設定為除 `1` 之外的值會啟用一種更準確但計算速度更慢的線性層計算方式。這能更好地匹配原始的 logits。
原始模型使用 `pad_id = -1` 來表示填充詞元。Transformers 的實現需要新增一個填充詞元，並相應地調整詞元嵌入的大小。
tokenizer.add_special_tokens({"pad_token":"<pad>"}) # update model config with padding token model.config.pad_token_id建議使用以下程式碼初始化 `embed_tokens` 層，以確保編碼填充詞元的輸出為零。
self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size, self.config.padding_idx)
分詞器是基於 SentencePiece 的位元組對編碼模型。在解碼過程中，如果第一個詞元是單詞的開頭（例如，“Banana”），分詞器不會在字串前新增字首空格。
如果你正在使用 FlashAttention-2，請不要在 from_pretrained() 中使用 `torch_dtype` 引數，因為它只支援 fp16 或 bf16。你應該使用自動混合精度，如果使用 Trainer，則將 fp16 或 bf16 設定為 `True`，或者使用 torch.autocast。
LlamaConfig
class transformers.LlamaConfig
< 原始碼 >( vocab_size = 32000 hidden_size = 4096 intermediate_size = 11008 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = None hidden_act = 'silu' max_position_embeddings = 2048 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = None bos_token_id = 1 eos_token_id = 2 pretraining_tp = 1 tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 mlp_bias = False head_dim = None **kwargs )
引數
- vocab_size (
int, 可選, 預設為 32000) — LLaMA 模型的詞彙表大小。定義了在呼叫 LlamaModel 時傳遞的 `inputs_ids` 可以表示的不同詞元的數量。 - hidden_size (
int, 可選, 預設為 4096) — 隱藏表示的維度。 - intermediate_size (
int, 可選, 預設為 11008) — MLP 表示的維度。 - num_hidden_layers (
int, 可選, 預設為 32) — Transformer 解碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 32) — Transformer 解碼器中每個注意力層的注意力頭數量。 - num_key_value_heads (
int, 可選) — 這是應該用於實現分組查詢注意力（Grouped Query Attention）的鍵值頭（key_value heads）數量。如果 `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, 可選, 預設為 2048) — 該模型可能使用的最大序列長度。Llama 1 支援最多 2048 個詞元，Llama 2 支援最多 4096 個，CodeLlama 支援最多 16384 個。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - rms_norm_eps (
float, 可選, 預設為 1e-06) — rms 歸一化層使用的 epsilon 值。 - use_cache (
bool, 可選, 預設為True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅在 `config.is_decoder=True` 時相關。 - pad_token_id (
int, 可選) — 填充詞元 ID。 - bos_token_id (
int, 可選, 預設為 1) — 流開始詞元 ID。 - eos_token_id (
int, 可選, 預設為 2) — 流結束詞元 ID。 - pretraining_tp (
int, 可選, 預設為 1) — 實驗性功能。預訓練期間使用的張量並行等級。請參考此文件瞭解更多資訊。此值對於確保預訓練結果的精確可復現性是必需的。請參考此問題。 - 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 嵌入的縮放因子。在大多數縮放型別中，factor為 x 將使模型能夠處理長度為 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 高頻分量的縮放因子。 - attention_bias (
bool, 可選, 預設為False) — 在自注意力機制中，是否在 query、key、value 和 output 投影層中使用偏置。 - attention_dropout (
float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。 - mlp_bias (
bool, 可選, 預設為False) — 是否在 MLP 層的 up_proj、down_proj 和 gate_proj 層中使用偏置。 - head_dim (
int, 可選) — 注意力頭的維度。如果為 None，則預設為 hidden_size // num_attention_heads。
這是一個用於儲存 LlamaModel 配置的配置類。它用於根據指定的引數例項化一個 LLaMA 模型，定義了模型的架構。使用預設值例項化配置將產生與 LLaMA-7B 類似的配置，例如 meta-llama/Llama-2-7b-hf。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。更多資訊請閱讀 PretrainedConfig 的文件。
>>> from transformers import LlamaModel, LlamaConfig
>>> # Initializing a LLaMA llama-7b style configuration
>>> configuration = LlamaConfig()
>>> # Initializing a model from the llama-7b style configuration
>>> model = LlamaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configLlamaTokenizer
class transformers.LlamaTokenizer
< 原始碼 >( vocab_file unk_token = '<unk>' bos_token = '<s>' eos_token = '</s>' pad_token = None sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None add_bos_token = True add_eos_token = False clean_up_tokenization_spaces = False use_default_system_prompt = False spaces_between_special_tokens = False legacy = None add_prefix_space = True **kwargs )
引數
- vocab_file (
str) — 詞彙表文件的路徑。 - unk_token (
strortokenizers.AddedToken, 可選, 預設為"<unk>") — 未知詞元。詞彙表中不存在的詞元無法轉換為 ID，將被設定為此詞元。 - bos_token (
strortokenizers.AddedToken, 可選, 預設為"<s>") — 在預訓練期間使用的序列開始詞元。可用作序列分類器詞元。 - eos_token (
strortokenizers.AddedToken, 可選, 預設為"</s>") — 序列結束詞元。 - pad_token (
strortokenizers.AddedToken, 可選) — 一種特殊的詞元，用於使詞元陣列具有相同的大小以便進行批處理。隨後將被注意力機制或損失計算忽略。 - sp_model_kwargs (
dict[str, Any],Optional, 可選) — 將傳遞給SentencePieceProcessor.__init__()方法。SentencePiece 的 Python 封裝可用於設定以下內容（以及其他）：-
enable_sampling: 啟用子詞正則化。 -
nbest_size: Unigram 的取樣引數。對於 BPE-Dropout 無效。nbest_size = {0,1}: 不執行取樣。nbest_size > 1: 從 nbest_size 個結果中取樣。nbest_size < 0: 假設 nbest_size 是無限的，並使用前向過濾和後向取樣演算法從所有假設（格）中取樣。
-
alpha: Unigram 取樣的平滑引數，以及 BPE-dropout 的合併操作的 dropout 機率。
-
- add_bos_token (
bool, 可選, 預設為True) — 是否在序列開頭新增bos_token。 - add_eos_token (
bool, 可選, 預設為False) — 是否在序列結尾新增eos_token。 - clean_up_tokenization_spaces (
bool, 可選, 預設為False) — 是否在解碼後清理空格，清理包括移除潛在的偽影，如多餘的空格。 - use_default_system_prompt (
bool, 可選, 預設為False) — 是否使用 Llama 的預設系統提示。 - spaces_between_special_tokens (
bool, 可選, 預設為False) — 是否在特殊詞元之間新增空格。 - legacy (
bool, 可選) — 是否使用分詞器的 `legacy` 行為。Legacy 指的是在合併 #24622 和 #25224 之前，這些合併修復了正確處理特殊詞元后出現的詞元的問題。確保同時將 `from_slow` 設定為 `True`。一個簡單的例子：legacy=True:
構建一個 Llama 分詞器。基於位元組級的位元組對編碼（Byte-Pair-Encoding）。由於原始模型中沒有填充詞元，因此預設的填充詞元未設定。
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]
根據傳入的兩個序列建立掩碼，用於序列對分類任務。一個 ALBERT
如果 token_ids_1 為 None，則此方法僅返回掩碼的第一部分（0s）。
0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence | second sequence |如果 token_ids_1 為 None，則只返回掩碼的第一部分（0s）。
save_vocabulary
< 原始碼 >( save_directory filename_prefix: typing.Optional[str] = None ) → Tuple(str)
將詞彙表和特殊標記檔案儲存到目錄。
LlamaTokenizerFast
class transformers.LlamaTokenizerFast
< 原始碼 >( vocab_file = None tokenizer_file = None clean_up_tokenization_spaces = False unk_token = '<unk>' bos_token = '<s>' eos_token = '</s>' add_bos_token = True add_eos_token = False use_default_system_prompt = False legacy = None add_prefix_space = None **kwargs )
引數
- vocab_file (
str, 可選) — SentencePiece 檔案（通常副檔名為 .model），包含例項化分詞器所需的詞彙表。 - tokenizer_file (
str, 可選) — tokenizers 檔案（通常副檔名為 .json），包含載入分詞器所需的一切。 - clean_up_tokenization_spaces (
bool, 可選, 預設為False) — 是否在解碼後清理空格，清理包括移除潛在的偽影，如多餘的空格。 - unk_token (
strortokenizers.AddedToken, 可選, 預設為"<unk>") — 未知詞元。詞彙表中不存在的詞元無法轉換為 ID，將被設定為此詞元。 - bos_token (
strortokenizers.AddedToken, 可選, 預設為"<s>") — 在預訓練期間使用的序列開始詞元。可用作序列分類器詞元。 - eos_token (
strortokenizers.AddedToken, 可選, 預設為"</s>") — 序列結束詞元。 - add_bos_token (
bool, 可選, 預設為True) — 是否在序列開頭新增bos_token。 - add_eos_token (
bool, 可選, 預設為False) — 是否在序列結尾新增eos_token。 - use_default_system_prompt (
bool, 可選, 預設為False) — 是否使用 Llama 的預設系統提示 - legacy (
bool, 可選) — 是否使用分詞器的 `legacy` 行為。Legacy 指的是在合併 #24622 和 #25224 之前，這些合併修復了正確處理特殊詞元后出現的詞元的問題。確保同時將 `from_slow` 設定為 `True`。一個簡單的例子：legacy=True:
構建 Llama 分詞器。基於位元組級位元組對編碼。
這主要使用 ByteFallback 且不進行規範化。
>>> from transformers import LlamaTokenizerFast
>>> tokenizer = LlamaTokenizerFast.from_pretrained("hf-internal-testing/llama-tokenizer")
>>> tokenizer.encode("Hello this is a test")
[1, 15043, 445, 338, 263, 1243]如果你想更改 `bos_token` 或 `eos_token`，請確保在初始化模型時指定它們，或呼叫 `tokenizer.update_post_processor()` 以確保後處理正確完成（否則編碼序列的第一個詞元和最後一個詞元的值將不正確）。更多詳情，請檢視 [post-processors] (https://huggingface.co/docs/tokenizers/api/post-processors) 文件。
該分詞器繼承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
get_special_tokens_mask
< 原始碼 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → 範圍在 [0, 1] 內的整數列表
從未新增特殊令牌的令牌列表中檢索序列 ID。使用分詞器 prepare_for_model 或 encode_plus 方法新增特殊令牌時會呼叫此方法。
create_token_type_ids_from_sequences
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID？
如果模型有特殊的構建方式，應在子類中重寫此方法。
使用當前的 bos_token 和 eos_token 更新底層後處理器。
LlamaModel
class transformers.LlamaModel
< 來源 >( config: LlamaConfig )
引數
- config (LlamaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
這是一個 Llama 裸模型，輸出原始的隱藏狀態，頂部沒有任何特定的處理頭。
該模型繼承自 PreTrainedModel。查閱父類的文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 來源 >( 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 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 **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 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, 可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括模型在先前解碼階段返回的 `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`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的 ID），形狀為 `(batch_size, 1)`，而不是所有形狀為 `(batch_size, sequence_length)` 的 `input_ids`。
- inputs_embeds (
torch.FloatTensor，形狀為(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`。 - cache_position (
torch.LongTensor，形狀為(sequence_length), 可選) — 描述輸入序列標記在序列中位置的索引。與 `position_ids` 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPast 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或當 `config.return_dict=False` 時），包含各種元素，具體取決於配置（LlamaConfig）和輸入。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
LlamaModel 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳播的邏輯需要在該函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默忽略它們。
LlamaForCausalLM
class transformers.LlamaForCausalLM
< 來源 >( config )
引數
- config (LlamaForCausalLM) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
用於因果語言建模的 Llama 模型。
該模型繼承自 PreTrainedModel。查閱父類的文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 來源 >( 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 cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.llama.modeling_llama.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 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, 可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括模型在先前解碼階段返回的 `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`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的 ID），形狀為 `(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, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 `[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 (
torch.LongTensor，形狀為(sequence_length), 可選) — 描述輸入序列標記在序列中位置的索引。與 `position_ids` 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。 - logits_to_keep (
Union[int, torch.Tensor], 預設為0) — 如果是 `int`，則計算最後 `logits_to_keep` 個標記的 logits。如果是 `0`，則計算所有 `input_ids` 的 logits（特殊情況）。生成時只需要最後一個標記的 logits，僅為該標記計算它們可以節省記憶體，這對於長序列或大詞彙表大小來說非常重要。如果是 `torch.Tensor`，則必須是 1D，對應於序列長度維度中要保留的索引。當使用打包張量格式（批處理和序列長度的單個維度）時，這非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithPast 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或當 `config.return_dict=False` 時），包含各種元素，具體取決於配置（LlamaConfig）和輸入。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
The LlamaForCausalLM 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳播的邏輯需要在該函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默忽略它們。
示例
>>> from transformers import AutoTokenizer, LlamaForCausalLM
>>> model = LlamaForCausalLM.from_pretrained("meta-llama/Llama-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-llama/Llama-2-7b-hf")
>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> 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]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."LlamaForSequenceClassification
class transformers.LlamaForSequenceClassification
< 來源 >( config )
引數
- config (LlamaForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
在 LLaMa 模型 Transformer 的頂部添加了一個序列分類頭（線性層）。
LlamaForSequenceClassification 使用最後一個標記來進行分類，就像其他因果模型（例如 GPT-2）一樣。
因為它對最後一個標記進行分類，所以需要知道最後一個標記的位置。如果在配置中定義了 `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 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 (
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, 可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括模型在先前解碼階段返回的 `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`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的 ID），形狀為 `(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.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（LlamaConfig）和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
LlamaForSequenceClassification 的 forward 方法，重寫了 __call__ 特殊方法。
儘管前向傳播的邏輯需要在該函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, LlamaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("meta-llama/Llama-2-7b-hf")
>>> model = LlamaForSequenceClassification.from_pretrained("meta-llama/Llama-2-7b-hf")
>>> 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 = LlamaForSequenceClassification.from_pretrained("meta-llama/Llama-2-7b-hf", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, LlamaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("meta-llama/Llama-2-7b-hf")
>>> model = LlamaForSequenceClassification.from_pretrained("meta-llama/Llama-2-7b-hf", 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 = LlamaForSequenceClassification.from_pretrained(
... "meta-llama/Llama-2-7b-hf", 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