Transformers 文档
OLMo2
并获得增强的文档体验
开始使用
OLMo2
概述
OLMo2 模型是 OLMo 模型的后继者，OLMo 模型在 OLMo: 加速语言模型的科学研究 中被提出。
从原始 OLMo 模型到此模型的架构更改包括
- 使用 RMSNorm 代替标准层归一化。
- 归一化应用于注意力查询和键。
- 归一化应用于注意力/前馈层之后，而不是之前。
此模型由 shanearora 贡献。 原始代码可以在 这里 找到。
Olmo2Config
class transformers.Olmo2Config
< source >( vocab_size = 50304 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 use_cache = True pad_token_id = 1 bos_token_id = None eos_token_id = 50279 tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 rms_norm_eps = 1e-05 **kwargs )
参数
- vocab_size (
int, optional, 默认为 50304) — Olmo2 模型的词汇表大小。 定义了在调用 Olmo2Model 时传递的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, optional, 默认为 4096) — 隐藏层表示的维度。 - intermediate_size (
int, optional, 默认为 11008) — MLP 表示的维度。 - num_hidden_layers (
int, optional, 默认为 32) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, optional, 默认为 32) — Transformer 解码器中每个注意力层的注意力头数。 - num_key_value_heads (
int, optional) — 这是用于实现分组查询注意力（Grouped Query Attention）的 key_value 头的数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（Multi Head Attention，MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（Multi Query Attention，MQA）；否则使用 GQA。当将多头检查点转换为 GQA 检查点时，每个组的 key 和 value 头应通过平均池化该组内的所有原始头来构建。有关更多详细信息，请查看这篇论文。如果未指定，则默认为num_attention_heads。 - hidden_act (
str或function, optional, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, optional, 默认为 2048) — 模型可能使用的最大序列长度。 - initializer_range (
float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - use_cache (
bool, optional, 默认为True) — 模型是否应返回上次的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - pad_token_id (
int, optional, 默认为 1) — Padding token id（填充 token id）。 - bos_token_id (
int, optional) — Beginning of stream token id（流开始 token id）。 - eos_token_id (
int, optional, 默认为 50279) — End of stream token id（流结束 token id）。 - tie_word_embeddings (
bool, optional, 默认为False) — 是否绑定词嵌入权重 - rope_theta (
float, optional, 默认为 10000.0) — RoPE 嵌入的基本周期。 - rope_scaling (
Dict, optional) — 包含 RoPE 嵌入缩放配置的字典。当前支持两种缩放策略：linear 和 dynamic。它们的缩放因子必须是大于 1 的浮点数。预期格式为{"type": strategy name, "factor": scaling factor}。使用此标志时，请勿将max_position_embeddings更新为预期的新最大值。有关这些缩放策略行为方式的更多信息，请参阅以下主题：https://www.reddit.com/r/LocalLLaMA/comments/14mrgpr/dynamically_scaled_rope_further_increases/。这是一个实验性功能，未来版本中可能会有破坏性 API 更改。 - attention_bias (
bool, 默认为False, optional, 默认为False) — 是否在自注意力期间在 query、key、value 和 output 投影层中使用 bias。 - attention_dropout (
float, optional, 默认为 0.0) — 注意力概率的 dropout 比率。 - rms_norm_eps (
float, optional, 默认为 1e-05) — rms 归一化层使用的 epsilon 值。
这是用于存储 Olmo2Model 配置的配置类。它用于根据指定的参数实例化 OLMo2 模型，定义模型架构。使用默认值实例化配置将产生与 allenai/Olmo2-7B-1124-hf 类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
>>> from transformers import Olmo2Model, Olmo2Config
>>> # Initializing a Olmo2 7B style configuration
>>> configuration = Olmo2Config()
>>> # Initializing a model from the Olmo2 7B style configuration
>>> model = Olmo2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configOlmo2Model
class transformers.Olmo2Model
< 源代码 >( config: Olmo2Config )
参数
- config (Olmo2Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
- config — Olmo2Config
裸 Olmo2 模型，输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解与常规用法和行为相关的所有事项。
Transformer 解码器，由 config.num_hidden_layers 层组成。每一层都是 Olmo2DecoderLayer
forward
< 源代码 >( input_ids: 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 return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] )
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。 默认情况下，如果您提供 padding，则会被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在[0, 1]中选择:- 1 表示 token 未被 mask，
- 0 表示 token 被 mask。
索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用了
past_key_values，则可以选择仅输入最后的input_ids(请参阅past_key_values)。如果您想更改 padding 行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示 head 未被 mask，
- 0 表示 head 被 mask。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 位置 embeddings 中每个输入序列 token 的位置索引。 在范围[0, config.n_positions - 1]中选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的 hidden-states (self-attention 块和 cross-attention 块中的 key 和 values)，可以用于加速顺序解码。 这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，其中每个元组都有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。 这也称为旧版 cache 格式。
模型将输出与作为输入馈送的 cache 格式相同的格式。 如果未传递
past_key_values，则将返回旧版 cache 格式。如果使用
past_key_values，用户可以选择仅输入最后的input_ids(那些没有将其 past key value states 提供给此模型的 input_ids)，形状为(batch_size, 1)而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码 (请参阅past_key_values)。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。 - cache_position (
torch.LongTensor, 形状为(sequence_length), 可选) — 描述输入序列 tokens 在序列中位置的索引。 与position_ids相反，此张量不受 padding 的影响。 它用于在正确的位置更新 cache 并推断完整序列长度。
Olmo2Model forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
Olmo2ForCausalLM
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, typing.List[torch.FloatTensor], NoneType] = 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 return_dict: 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.olmo2.modeling_olmo2.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。 默认情况下，如果您提供 padding，则会被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在[0, 1]中选择:- 1 表示 token 未被 mask，
- 0 表示 token 被 mask。
索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用了
past_key_values，则可以选择仅输入最后的input_ids(请参阅past_key_values)。如果您想更改 padding 行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示 head 未被 mask，
- 0 表示 head 被 mask。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 位置 embeddings 中每个输入序列 token 的位置索引。 在范围[0, config.n_positions - 1]中选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的 hidden-states (self-attention 块和 cross-attention 块中的 key 和 values)，可以用于加速顺序解码。 这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv cache 指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，其中每个元组都有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。 这也称为旧版 cache 格式。
模型将输出与作为输入馈送的 cache 格式相同的格式。 如果未传递
past_key_values，则将返回旧版 cache 格式。如果使用
past_key_values，用户可以选择仅输入最后的input_ids(那些没有将其 past key value states 提供给此模型的 input_ids)，形状为(batch_size, 1)而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将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 而不是普通的元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 索引，描述输入序列标记在序列中的位置。 与position_ids相反，此张量不受填充的影响。 它用于在正确的位置更新缓存，并推断完整序列长度。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。 索引应为[0, ..., config.vocab_size]或 -100（请参阅input_ids文档字符串）。 索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。 - logits_to_keep (
int或torch.Tensor，可选) — 如果是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 时），其中包含各种元素，具体取决于配置 (Olmo2Config) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于预测下一个标记）。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表标记的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回) —tuple(torch.FloatTensor)元组，长度为config.n_layers，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量)包含预先计算的隐藏状态（自注意力块中的键和值），可以用于（请参阅
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
Olmo2ForCausalLM forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此方法，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, Olmo2ForCausalLM
>>> model = Olmo2ForCausalLM.from_pretrained("meta-olmo2/Olmo2-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-olmo2/Olmo2-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."