Transformers 文档
OLMo Hybrid
并获得增强的文档体验
开始使用
该模型于 2026 年 2 月 26 日贡献给 Hugging Face Transformers。
OLMo Hybrid
OLMo Hybrid 是 Ai2 推出的一种混合架构模型,它将标准 Transformer 注意力层与使用 Gated Deltanet 的线性注意力层相结合。这种混合方法旨在通过交替使用完整注意力层和线性注意力层,在保持模型质量的同时提高效率。
为了获得最佳性能,请安装 flash-linear-attention 库。即使没有安装该库,模型也能使用 PyTorch 后备方案运行,但 FLA 为线性注意力层提供了显著的加速效果。
以下示例演示了如何使用 Pipeline、AutoModel 以及命令行来生成文本。
from transformers import pipeline
pipe = pipeline(
task="text-generation",
model="allenai/OLMo-Hybrid-7B",
device=0,
)
result = pipe("Plants create energy through a process known as")
print(result)注意事项
- 为在线性注意力层上获得最佳性能,请安装 flash-linear-attention
pip install flash-linear-attention
- 该模型使用了一种自定义缓存(
OlmoHybridDynamicCache),它同时处理注意力层的 KV 缓存和线性注意力层的循环状态。
OlmoHybridConfig
class transformers.OlmoHybridConfig
< 源代码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 100352 hidden_size: int = 3840 intermediate_size: int = 11008 num_hidden_layers: int = 32 num_attention_heads: int = 30 num_key_value_heads: int | None = None hidden_act: str = 'silu' max_position_embeddings: int = 65536 initializer_range: float = 0.02 rms_norm_eps: float = 1e-06 use_cache: bool = True pad_token_id: int | None = 100277 bos_token_id: int | None = None eos_token_id: int | list[int] | None = 100257 tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None attention_bias: bool = False attention_dropout: int | float | None = 0.0 layer_types: list[str] | None = None linear_num_key_heads: int | None = None linear_num_value_heads: int | None = None linear_key_head_dim: int | None = None linear_value_head_dim: int | None = None linear_a_log_min: float = 0.0 linear_a_log_max: float = 16.0 linear_dt_min: float = 0.001 linear_dt_max: float = 0.1 linear_dt_init_floor: float = 0.0001 linear_conv_kernel_dim: int = 4 linear_allow_neg_eigval: bool = True )
参数
- vocab_size (
int, 可选, 默认为100352) — 模型词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为3840) — 隐藏状态表示的维度。 - intermediate_size (
int, 可选, 默认为11008) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为32) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为30) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力(Grouped Query Attention)的 key_value 头数量。如果num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果num_key_value_heads=1,模型将使用多查询注意力(MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的 key 和 value 头应通过对该组内的所有原始头进行平均池化来构建。更多详细信息,请查看 这篇论文。如果未指定,将默认为num_attention_heads。 - hidden_act (
str, 可选, 默认为silu) — 解码器中的非线性激活函数(函数或字符串)。例如:"gelu","relu","silu"等。 - max_position_embeddings (
int, 可选, 默认为65536) — 该模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - rms_norm_eps (
float, 可选, 默认为1e-06) — RMS 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后的键/值注意力(并非所有模型都使用)。仅在config.is_decoder=True或模型为仅解码器的生成模型时相关。 - pad_token_id (
int, 可选, 默认为100277) — 词汇表中用于填充(padding)的 token ID。 - bos_token_id (
int, 可选) — 词汇表中用于流开始(beginning-of-stream)的 token ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为100257) — 词汇表中用于流结束(end-of-stream)的 token ID。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值,如果希望在更长的max_position_embeddings下使用 RoPE,还可以选择包含用于缩放的参数。 - attention_bias (
bool, 可选, 默认为False) — 在自注意力机制期间,是否在查询、键、值和输出投影层中使用偏置(bias)。 - attention_dropout (
Union[int, float], 可选, 默认为0.0) — 注意力概率的 Dropout 比率。 - layer_types (
list[str], 可选) — 明确将每个层索引映射到其层类型的列表。如果未提供,将根据配置值自动生成。 - linear_num_key_heads (
int, 可选) — 线性注意力层的键头数量。默认为num_attention_heads。 - linear_num_value_heads (
int, 可选) — 线性注意力层的值头数量。默认为num_attention_heads。 - linear_key_head_dim (
int, 可选) — 线性注意力层中每个键头的维度。默认为0.75 * hidden_size / linear_num_key_heads。 - linear_value_head_dim (
int, 可选) — 线性注意力层中每个值头的维度。默认为2 * linear_key_head_dim。 - linear_a_log_min (
float, 可选, 默认为 0.0) — GatedDeltaNet 层中 A_log 均匀初始化的最小值。 - linear_a_log_max (
float, 可选, 默认为 16.0) — GatedDeltaNet 层中 A_log 均匀初始化的最大值。 - linear_dt_min (
float, 可选, 默认为 0.001) — GatedDeltaNet 层中 dt 初始化的最小值。 - linear_dt_max (
float, 可选, 默认为 0.1) — GatedDeltaNet 层中 dt 初始化的最大值。 - linear_dt_init_floor (
float, 可选, 默认为 0.0001) — GatedDeltaNet 层中初始化期间用于截断 dt 的下限值。 - linear_conv_kernel_dim (
int, 可选, 默认为 4) — 线性注意力层中用于查询(queries)、键(keys)和值(values)的短卷积核大小。 - linear_allow_neg_eigval (
bool, 可选, 默认为True) — 是否在 GatedDeltaNet 递归中允许负特征值。当为True时,beta 参数按 2.0 缩放,以允许取值范围在 [0, 2] 而非 [0, 1]。
这是用于存储 OlmoHybridModel 配置的配置类。它根据指定的参数实例化一个 Olmo Hybrid 模型,从而定义模型架构。使用默认值实例化配置将产生与 allenai/Olmo-Hybrid-7B 类似的配置。
配置对象继承自 PreTrainedConfig,可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import OlmoHybridModel, OlmoHybridConfig
>>> # Initializing an OlmoHybrid style configuration
>>> configuration = OlmoHybridConfig()
>>> # Initializing a model from the OlmoHybrid style configuration
>>> model = OlmoHybridModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configOlmoHybridModel
forward
< 源代码 >( 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 use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] )
OlmoHybridForCausalLM
class transformers.OlmoHybridForCausalLM
< 源代码 >( 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 (OlmoHybridForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Olmo Hybrid 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( 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 logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 词汇表中输入序列 token 的索引。填充默认会被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor,形状为(batch_size, sequence_length),可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值选自[0, 1]:- 1 表示 token 未被掩盖,
- 0 表示 token 已被掩盖。
- position_ids (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 每个输入序列 token 在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache,可选) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码的前一阶段返回的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),而不是所有形状为(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的 token 将被忽略(掩盖),损失仅对索引在[0, ..., config.vocab_size]范围内的标签计算。 - use_cache (
bool,可选) — 如果设置为True,将返回past_key_values键值状态,并可用于加速解码(请参阅past_key_values)。 - logits_to_keep (
Union[int, torch.Tensor],可选,默认为0) — 如果是int,则计算最后logits_to_keep个 token 的 logit。如果是0,则计算所有input_ids的 logit(特殊情况)。生成时仅需要最后一个 token 的 logit,并且仅为该 token 计算它们可以节省内存,这对于长序列或大词汇量变得非常显著。如果是torch.Tensor,必须是对应于在序列长度维度上保留索引的一维张量。这在使用打包张量格式(批次和序列长度的单维度)时很有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
根据配置 (OlmoHybridConfig) 和输入,包含各种元素的一个 CausalLMOutputWithPast 或 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时)。
OlmoHybridForCausalLM 的 forward 方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
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), 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 后的注意力权重,用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, OlmoHybridForCausalLM
>>> model = OlmoHybridForCausalLM.from_pretrained("meta-olmo_hybrid/OlmoHybrid-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-olmo_hybrid/OlmoHybrid-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."