Transformers 文档

Llama 2

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

在模型、数据集和 Spaces 上进行协作

通过加速推理获得更快的示例

切换文档主题

开始使用

此模型于 2023-07-18 发布，并于 2023-07-18 添加到 Hugging Face Transformers。

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 进行交互。

流水线

自动模型

Transformers CLI

量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。

以下示例使用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",
    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(model.device)

output = model.generate(**input_ids, cache_implementation="static")
print(tokenizer.decode(output[0], skip_special_tokens=True))

使用 AttentionMaskVisualizer 可以更好地了解模型可以关注哪些 token，不能关注哪些 token。

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 来表示填充 token。Transformers 实现需要添加一个填充 token 并相应地调整 token 嵌入的大小。
```
tokenizer.add_special_tokens({"pad_token":"<pad>"})
# update model config with padding token
model.config.pad_token_id
```
建议使用以下代码初始化 embed_tokens 层，以确保填充 token 的输出编码为零。
```
self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size, self.config.padding_idx)
```
tokenizer 是基于 SentencePiece 的字节对编码模型。在解码过程中，如果第一个 token 是单词的开头（例如，“Banana”），tokenizer 不会在字符串前面加上前缀空格。
如果您使用 FlashAttention-2，请不要在 from_pretrained() 中使用 dtype 参数，因为它仅支持 fp16 或 bf16。您应该使用自动混合精度，如果使用 Trainer，则将 fp16 或 bf16 设置为 True，或使用 torch.autocast。

LlamaConfig

class transformers.LlamaConfig

< source >

参数

vocab_size (int, optional, defaults to 32000) — LLaMA 模型的词汇表大小。定义调用 LlamaModel 时传入的 inputs_ids 可以表示的不同 token 的数量
hidden_size (int, optional, defaults to 4096) — 隐藏表示的维度。
intermediate_size (int, optional, defaults to 11008) — MLP 表示的维度。
num_hidden_layers (int, optional, defaults to 32) — Transformer 解码器中的隐藏层数量。
num_attention_heads (int, optional, defaults to 32) — Transformer 解码器中每层注意力头的数量。
num_key_value_heads (int, optional) — 这是应该用于实现分组查询注意力（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 or function, optional, defaults to "silu") — 解码器中非线性激活函数（函数或字符串）。
max_position_embeddings (int, optional, defaults to 2048) — 此模型可能使用的最大序列长度。Llama 1 支持多达 2048 个 token，Llama 2 支持多达 4096 个 token，CodeLlama 支持多达 16384 个 token。
initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
rms_norm_eps (float, optional, defaults to 1e-06) — rms 归一化层使用的 epsilon 值。
use_cache (bool, optional, defaults to True) — 是否应返回最后一个键/值注意力（并非所有模型都使用）。仅在 config.is_decoder=True 时相关。
pad_token_id (int, optional) — 填充 token ID。
bos_token_id (int, optional, defaults to 1) — 流开始 token ID。
eos_token_id (int, optional, defaults to 2) — 流结束 token ID。
pretraining_tp (int, optional, defaults to 1) — 实验性功能。预训练期间使用的张量并行级别。请参阅本文档以了解更多信息。此值对于确保预训练结果的精确再现至关重要。请参阅此问题。
tie_word_embeddings (bool, optional, defaults to False) — 是否将权重嵌入绑定在一起
rope_parameters (RopeParameters, optional) — 包含 RoPE 嵌入配置参数的字典。该字典应包含 rope_theta 的值，并且如果希望在更长的 max_position_embeddings 下使用 RoPE，可以选择包含用于缩放的参数。
attention_bias (bool, optional, defaults to False) — 是否在自注意力过程中的查询、键、值和输出投影层中使用偏置。
attention_dropout (float, optional, defaults to 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.config

LlamaTokenizer

class transformers.LlamaTokenizer

< source >

参数

vocab (str, dict 或 list, 可选) — 词汇文件路径、字典或 token 列表。
merges (str 或 list, 可选) — merges 文件路径或 merges 列表。
clean_up_tokenization_spaces (bool, 可选, 默认为 False) — 是否清理解码后的空格，清理包括删除可能出现的额外空格。
unk_token (str 或 tokenizers.AddedToken, 可选, 默认为 "<unk>") — 未知 token。词汇表中不存在的 token 无法转换为 ID，而是被设置为该 token。
bos_token (str 或 tokenizers.AddedToken, 可选, 默认为 "<s>") — 预训练期间使用的序列开始 token。可用作序列分类 token。
eos_token (str 或 tokenizers.AddedToken, 可选, 默认为 "</s>") — 序列结束 token。
add_bos_token (bool, 可选, 默认为 True) — 是否在序列开头添加 bos_token。
add_eos_token (bool, 可选, 默认为 False) — 是否在序列末尾添加 eos_token。
use_default_system_prompt (bool, 可选, 默认为 False) — 是否使用 Llama 的默认系统提示
add_prefix_space (bool, 可选) — 分词器是否应自动添加前导空格

构建 Llama 分词器。基于字节级字节对编码。

这主要使用 ByteFallback 且不进行规范化。

>>> from transformers import LlamaTokenizer

>>> tokenizer = LlamaTokenizer.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() 以确保后处理正确完成（否则编码序列的第一个token和最后一个token的值将不正确）。有关更多详细信息，请查看 [post-processors] (https://huggingface.co/docs/tokenizers/api/post-processors) 文档。

此分词器继承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。用户应参考此父类以获取有关这些方法的更多信息。

get_special_tokens_mask

< source >

( token_ids_0: list[int] token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → 一个介于 0 和 1 之间的整数列表

参数

token_ids_0 — 序列的 ID 列表（可能已格式化）。
token_ids_1 — 如果 already_has_special_tokens=True 则未使用。在这种情况下必须为 None。
already_has_special_tokens — 序列是否已使用特殊 token 格式化。

一个范围在 [0, 1] 的整数列表

特殊令牌为 1，序列令牌为 0。

Retrieve sequence ids from a token list that has no special tokens added.

For fast tokenizers, data collators call this with already_has_special_tokens=True to build a mask over an already-formatted sequence. In that case, we compute the mask by checking membership in all_special_ids.

save_vocabulary

< source >

( save_directory: str filename_prefix: str | None = None )

LlamaTokenizerFast

class transformers.LlamaTokenizer

< source >

参数

vocab (str, dict 或 list, 可选) — 词汇文件路径、字典或 token 列表。
merges (str 或 list, 可选) — merges 文件路径或 merges 列表。
clean_up_tokenization_spaces (bool, 可选, 默认为 False) — 是否清理解码后的空格，清理包括删除可能出现的额外空格。
unk_token (str 或 tokenizers.AddedToken, 可选, 默认为 "<unk>") — 未知 token。词汇表中不存在的 token 无法转换为 ID，而是被设置为该 token。
bos_token (str 或 tokenizers.AddedToken, 可选, 默认为 "<s>") — 预训练期间使用的序列开始 token。可用作序列分类 token。
eos_token (str 或 tokenizers.AddedToken, 可选, 默认为 "</s>") — 序列结束 token。
add_bos_token (bool, 可选, 默认为 True) — 是否在序列开头添加 bos_token。
add_eos_token (bool, 可选, 默认为 False) — 是否在序列末尾添加 eos_token。
use_default_system_prompt (bool, 可选, 默认为 False) — 是否使用 Llama 的默认系统提示
add_prefix_space (bool, 可选) — 分词器是否应自动添加前导空格

构建 Llama 分词器。基于字节级字节对编码。

这主要使用 ByteFallback 且不进行规范化。

>>> from transformers import LlamaTokenizer

>>> tokenizer = LlamaTokenizer.from_pretrained("hf-internal-testing/llama-tokenizer")
>>> tokenizer.encode("Hello this is a test")
[1, 15043, 445, 338, 263, 1243]

此分词器继承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。用户应参考此父类以获取有关这些方法的更多信息。

get_special_tokens_mask

< source >

( token_ids_0: list[int] token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → 一个介于 0 和 1 之间的整数列表

参数

token_ids_0 — 序列的 ID 列表（可能已格式化）。
token_ids_1 — 如果 already_has_special_tokens=True 则未使用。在这种情况下必须为 None。
already_has_special_tokens — 序列是否已使用特殊 token 格式化。

一个范围在 [0, 1] 的整数列表

特殊令牌为 1，序列令牌为 0。

Retrieve sequence ids from a token list that has no special tokens added.

update_post_processor

< source >

( )

使用当前的 bos_token 和 eos_token 更新底层后处理器。

save_vocabulary

< source >

( save_directory: str filename_prefix: str | None = None )

LlamaModel

class transformers.LlamaModel

< source >

( config: LlamaConfig )

参数

config (LlamaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化仅加载配置，不加载模型权重。请查看 from_pretrained() 方法以加载模型权重。

输出原始隐藏状态且顶部没有任何特定头的裸 Llama 模型。

此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< source >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None cache_position: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

输入 ID 是什么？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 用于避免对 padding token 索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
注意力掩码是什么？
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 在位置嵌入中每个输入序列 token 的位置索引。选择范围为 [0, config.n_positions - 1]。

位置 ID 是什么？
past_key_values (~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常由模型在之前的解码阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

只有 Cache 实例可以作为输入，请参阅我们的 kv 缓存指南。如果未传入 past_key_values，则默认初始化 DynamicCache。

模型将输出与输入相同的缓存格式。

如果使用 past_key_values，则用户应仅输入未处理的 input_ids（其过去键值状态未提供给此模型的那些），形状为 (batch_size, unprocessed_length)，而不是所有 input_ids，形状为 (batch_size, sequence_length)。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是 input_ids。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这会很有用。
cache_position (torch.LongTensor of shape (sequence_length), optional) — 指示输入序列 token 在序列中位置的索引。与 position_ids 不同，该张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。

transformers.modeling_outputs.BaseModelOutputWithPast or 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, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) to speed up sequential decoding.
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 后的注意力权重，用于计算自注意力头中的加权平均值。

LlamaModel 的 forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

LlamaForCausalLM

class transformers.LlamaForCausalLM

< source >

( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )

参数

config (LlamaForCausalLM) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。

用于因果语言建模的 Llama 模型。

此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< source >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

输入 ID 是什么？
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择范围为 [0, 1]：
- 1 表示 **未掩码** 的 token，
- 0 表示 **已掩码** 的 token。
注意力掩码是什么？
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 在位置嵌入中每个输入序列 token 的位置索引。选择范围为 [0, config.n_positions - 1]。

位置 ID 是什么？
past_key_values (~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常由模型在之前的解码阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

只有 Cache 实例可以作为输入，请参阅我们的 kv 缓存指南。如果未传入 past_key_values，则默认初始化 DynamicCache。

模型将输出与输入相同的缓存格式。

如果使用 past_key_values，则用户应仅输入未处理的 input_ids（其过去键值状态未提供给此模型的那些），形状为 (batch_size, unprocessed_length)，而不是所有 input_ids，形状为 (batch_size, sequence_length)。
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是 input_ids。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这会很有用。
labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 范围内（请参阅 input_ids 文档字符串）。索引设置为 -100 的 token 将被忽略（掩码），损失仅为在 [0, ..., config.vocab_size] 范围内具有标签的 token 计算。
use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
cache_position (torch.LongTensor of shape (sequence_length), optional) — 指示输入序列 token 在序列中位置的索引。与 position_ids 不同，该张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
logits_to_keep (Union[int, torch.Tensor], optional, defaults to 0) — 如果是 int，则计算最后 logits_to_keep 个 token 的 logits。如果是 0，则计算所有 input_ids 的 logits（特殊情况）。生成时只需要最后一个 token 的 logits，并且仅为该 token 计算它们可以节省内存，这对于长序列或大词汇量来说非常显著。如果是 torch.Tensor，则必须是 1D 张量，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度的单维）时非常有用。

transformers.modeling_outputs.CausalLMOutputWithPast or 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, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

LlamaForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 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

< source >

( config )

forward

< source >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

输入 ID 是什么？
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择范围为 [0, 1]：
- 1 表示 **未掩码** 的 token，
- 0 表示 **已掩码** 的 token。
注意力掩码是什么？
position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.n_positions - 1].

位置ID是什么？
past_key_values (~cache_utils.Cache, optional) — Pre-computed hidden-states (key and values in the self-attention blocks and in the cross-attention blocks) that can be used to speed up sequential decoding. This typically consists in the past_key_values returned by the model at a previous stage of decoding, when use_cache=True or config.use_cache=True.

Only Cache instance is allowed as input, see our kv cache guide. If no past_key_values are passed, DynamicCache will be initialized by default.

The model will output the same cache format that is fed as input.

If past_key_values are used, the user is expected to input only unprocessed input_ids (those that don’t have their past key value states given to this model) of shape (batch_size, unprocessed_length) instead of all input_ids of shape (batch_size, sequence_length).
inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — Optionally, instead of passing input_ids you can choose to directly pass an embedded representation. This is useful if you want more control over how to convert input_ids indices into associated vectors than the model’s internal embedding lookup matrix.
labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — Labels for computing the masked language modeling loss. Indices should either be in [0, ..., config.vocab_size] or -100 (see input_ids docstring). Tokens with indices set to -100 are ignored (masked), the loss is only computed for the tokens with labels in [0, ..., config.vocab_size].
use_cache (bool, optional) — If set to True, past_key_values key value states are returned and can be used to speed up decoding (see past_key_values).

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

A transformers.modeling_outputs.SequenceClassifierOutputWithPast or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.

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, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

The GenericForSequenceClassification forward method, overrides the __call__ special method.

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

在 GitHub 上更新

←LLaMA Llama3→