Transformers documentation
Laguna
该模型于 2024-08-28 在 HF papers 上发布，并于 2026-04-28 贡献至 Hugging Face Transformers。
Laguna
Laguna 是 Poolside 的混合专家语言模型系列。与标准的 SwiGLU MoE Transformer 相比，Laguna 特有的差异如下：
- 通过
num_attention_heads_per_layer设置每层的注意力头数——不同的解码器层可以拥有不同的查询头数量，同时共享相同的 KV 缓存形状。 - 采用无辅助损失负载均衡的 Sigmoid MoE 路由器（arXiv:2408.15664）以及可选的 logit 软截断（
moe_router_logit_softcapping）—— 路由器分数为门控 logit 的逐元素 sigmoid 值，再加上一个仅在专家选择时添加的、按专家学习的偏置（e_score_correction_bias）。
用法
from transformers import pipeline
pipe = pipeline(
"text-generation",
model="poolside/Laguna-XS.2",
dtype="auto",
device_map="auto",
)
print(pipe("The capital of France is", max_new_tokens=20, do_sample=False)[0]["generated_text"])import torch
from transformers import AutoModelForCausalLM, AutoTokenizer
model_id = "poolside/Laguna-XS.2"
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(
model_id,
dtype=torch.bfloat16,
device_map="auto",
)
prompt = "The capital of France is"
inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
generated = model.generate(**inputs, max_new_tokens=20, do_sample=False)
print(tokenizer.decode(generated[0], skip_special_tokens=True))备注
- 注意力后端。支持 SDPA（默认）、FlashAttention-2 和 flex attention。注意力输出门控在 kernel 调用之外应用，因此适用于所有后端。
num_attention_heads_per_layer。如果提供该参数，其长度必须等于num_hidden_layers。每个条目必须能被num_key_value_heads整除。layer_types。如果未设置，默认值为["full_attention"] * num_hidden_layers。若要启用滑动窗口注意力，请传入一个由"full_attention"/"sliding_attention"值组成的列表。mlp_layer_types。 每层 MLP 的类型，取值为"dense"或"sparse"。其长度必须等于num_hidden_layers。若未设置，默认值为["dense"] + ["sparse"] * (num_hidden_layers - 1)（第一层为 dense，其余层为 MoE）。- 目前，
moe_apply_router_weight_on_input=True与融合专家内核（grouped_mm_experts_forward）不兼容；validate_architecture会在配置构建时抛出异常。请将其设置为False（默认值）。
LagunaConfig
class transformers.LagunaConfig
< source >( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 100352hidden_size: int = 2048intermediate_size: int = 8192num_hidden_layers: int = 40num_attention_heads: int = 48num_key_value_heads: int = 8hidden_act: str = 'silu'max_position_embeddings: int = 131072initializer_range: float = 0.02rms_norm_eps: float = 1e-06use_cache: bool = Truetie_word_embeddings: bool = Falserope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = Nonesliding_window: int = 512attention_dropout: float | int = 0.0moe_intermediate_size: int = 512shared_expert_intermediate_size: int = 512num_experts_per_tok: int = 8num_experts: int = 256output_router_logits: bool = Falserouter_aux_loss_coef: float = 0.001layer_types: list[str] | None = Nonepad_token_id: int | None = Nonebos_token_id: int | None = Noneeos_token_id: int | list[int] | None = Nonehead_dim: int = 128attention_bias: bool = Falsegating: bool | str = Truenum_attention_heads_per_layer: list[int] | None = Nonemlp_layer_types: list[str] | None = Nonemoe_routed_scaling_factor: float = 1.0moe_apply_router_weight_on_input: bool = Falsemoe_router_logit_softcapping: float = 0.0 )
参数
- vocab_size (int，可选，默认为 100352) — 模型的词汇表大小。定义了 input_ids 可以表示的不同 token 数量。
- hidden_size (int，可选，默认为 2048) — 隐藏表示的维度。
- intermediate_size (int，可选，默认为 8192) — MLP 表示的维度。
- num_hidden_layers (int，可选，默认为 40) — Transformer 解码器中的隐藏层数。
- num_attention_heads (int，可选，默认为 48) — Transformer 解码器中每个注意力层的注意力头数量。
- num_key_value_heads (int, optional, 默认为 8) — 这是用于实现 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 头应通过对该组内所有原始头进行 meanpooling 来构建。更多详情请参阅 这篇 论文。如果未指定，则默认为 num_attention_heads。
- hidden_act (str，可选，默认为 silu) — 解码器中的非线性激活函数（函数或字符串）。例如，“gelu”、 “relu”、“silu” 等。
- max_position_embeddings (int，可选，默认为 131072) — 该模型可能使用的最大序列长度。
- initializer_range (float，可选，默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
- rms_norm_eps (float，可选，默认为 1e-06) — RMS 归一化层所使用的 epsilon 值。
- use_cache (bool, optional, defaults to True) — Whether or not the model should return the last key/values attentions (not used by all models). Only relevant if config.is_decoder=True or when the model is a decoder-only generative model.
- tie_word_embeddings (bool，可选，默认为 False) — 是否根据模型的 tied_weights_keys 映射来绑定权重嵌入。
- rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含 rope_theta 的值，并且如果希望使用 RoPE 处理更长的 max_position_embeddings，则可选地包含用于缩放的参数。
- sliding_window (int，可选，默认为 512) — 滑动窗口注意力的窗口大小。如果为 None，则不应用滑动窗口。
- attention_dropout (Union[float, int]，可选，默认为 0.0) — 注意力概率的 dropout 比率。
- moe_intermediate_size (int，可选，默认为 512) — 路由专家 MLP 的中间层大小。
- shared_expert_intermediate_size (int，可选，默认为 512) — 共享专家 MLP 的中间层大小。
- num_experts_per_tok (int，可选，默认为 8) — 每个 token 路由到的专家数量。这是 token 选择路由的 top-k 值。
- num_experts (int，可选，默认为 256) — MoE 层中路由专家的数量。
- output_router_logits (bool，可选，默认为 False) — 是否由模型返回路由器 logits。启用此选项后，模型还将输出辅助损失，包括负载均衡损失和路由器 z-loss。
- router_aux_loss_coef (float，可选，默认为 0.001) — 辅助负载均衡损失系数。用于惩罚 MoE 模型中专家路由的不均衡。
- layer_types (list[str], 可选) — 一个列表，显式地将每个层索引映射到其层类型。如果未提供，将根据 config 值自动生成。
- pad_token_id (int, optional) — 词表中用于填充的 token id。
- bos_token_id (int, optional) — 词汇表中用于表示流起始的 Token id。
- eos_token_id (Union[int, list[int]], 可选) — 词汇表中用于表示流结束（end-of-stream）的 token id。
- head_dim (int，可选，默认为 128) — 注意力头维度。如果为 None，则默认为 hidden_size // num_attention_heads
- attention_bias (bool，可选，默认为 False) — 在自注意力机制中，是否在查询、键、值和输出投影层中使用偏置。
- gating（bool 或 str，可选，默认为 True）—
Softplus 输出门控的粒度。
True或"per-head"表示每个 head 应用一个门控，并在head_dim维度上进行广播；"per-element"表示每个(head, head_dim)通道应用一个门控。 - num_attention_heads_per_layer (list[int]，可选) —
num_attention_heads的逐层覆盖值。其长度必须等于num_hidden_layers。 - mlp_layer_types (list[str], optional) —
每层 MLP 类型 —
"dense"或"sparse"。长度必须等于num_hidden_layers。默认第一层为 dense，其余为 sparse。 - moe_routed_scaling_factor (float，可选，默认为 1.0) — 在将路由专家输出与共享专家输出合并之前，应用于路由专家输出的标量。
- moe_apply_router_weight_on_input (bool，可选，默认为 False) —
是否将路由权重应用于 MoE 的输入而非输出。Transformers 目前尚不支持此功能；当前设置
True会引发NotImplementedError。 - moe_router_logit_softcapping (float，可选，默认值为 0.0) — 在对 MoE 路由器的 logits 应用 tanh 软截断（softcapping）时使用的缩放因子。
这是用于存储 LagunaModel 配置的类。它根据指定的参数实例化 Laguna 模型，并定义模型架构。使用默认值实例化配置将生成与 poolside/laguna-XS.2 类似的配置。
配置对象继承自 [PreTrainedConfig]，可用于控制模型输出。有关更多信息，请参阅 [PreTrainedConfig] 的文档。
示例：
>>> from transformers import LagunaModel, LagunaConfig
>>> configuration = LagunaConfig()
>>> model = LagunaModel(configuration)
>>> configuration = model.config@strict 驱动验证的一部分。
LagunaModel
class transformers.LagunaModel
< source >( config: LagunaConfig )
参数
- config (LagunaConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
未添加任何特定头部的裸 Laguna 模型，直接输出原始隐藏状态。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoeModelOutputWithPast or tuple(torch.Tensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), ，可选) — 输入序列中各 token 在词汇表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- 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 cache 指南。 如果未传入
past_key_values，则默认会初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未向该模型提供其过去键值状态的那些），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部input_ids。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - use_cache (
bool，可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回值
MoeModelOutputWithPast 或 tuple(torch.Tensor)
MoeModelOutputWithPast 或 torch.Tensor 元组（当传入 return_dict=False 或 config.return_dict=False 时），其包含的元素取决于配置（LagunaConfig）和输入。
LagunaModel 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
last_hidden_state（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor）— 模型最后一层输出的隐藏状态序列。past_key_values（
Cache，可选，在传入use_cache=True或config.use_cache=True时返回）—— 它是一个 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值，以及如果
config.is_encoder_decoder=True则还包括交叉注意力块中的键和值），可用于（参见past_key_values输入）加速顺序解码。hidden_states (
tuple(torch.Tensor)，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层的输出，以及每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple(torch.Tensor)，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
router_logits (
tuple(torch.Tensor)，可选，当传入output_router_probs=True且config.add_router_probs=True，或当config.output_router_probs=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, sequence_length, num_experts)。由 MoE 路由器计算的原始路由器 logits（softmax 之后），这些术语用于计算混合专家模型的辅助损失。
LagunaForCausalLM
class transformers.LagunaForCausalLM
< source >( config: LagunaConfig )
参数
- config (LagunaConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Laguna 模型。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = Noneoutput_router_logits: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MoeCausalLMOutputWithPast or tuple(torch.Tensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), ，可选) — 输入序列中各 token 在词汇表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- 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 cache 指南。 如果未传入
past_key_values，则默认会初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未向该模型提供其过去键值状态的那些），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部input_ids。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引值应在[0, ..., config.vocab_size]范围内，或为 -100（参见input_ids的文档字符串）。索引值设为-100的 token 将被忽略（即被掩码），损失仅针对标签位于[0, ..., config.vocab_size]范围内的 token 进行计算。 - use_cache (
bool，可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_router_logits (
bool, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，在推理期间不应返回。 - logits_to_keep (
Union[int, torch.Tensor], 可选，默认为0) — 如果为int，则计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成过程只需要最后一个 token 的 logits，仅针对该 token 进行计算可以节省内存，对于长序列或大词汇量而言，这种节省相当显著。 如果为torch.Tensor，则必须是一维张量，对应于序列长度维度中需要保留的索引。 这在使用打包张量格式（将批次和序列长度合并为单一维度）时非常有用。
返回值
MoeCausalLMOutputWithPast 或 tuple(torch.Tensor)
MoeCausalLMOutputWithPast 或 torch.Tensor 元组（当传入 return_dict=False 或 config.return_dict=False 时），其包含的元素取决于配置（LagunaConfig）和输入。
LagunaForCausalLM 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss (
torch.Tensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。logits（形状为
(batch_size, sequence_length, config.vocab_size)的torch.Tensor）— 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。aux_loss (
torch.Tensor，可选，当传入output_router_logits=True或config.output_router_logits=True，且模型使用负载均衡损失训练其路由器时返回) — 稀疏模块的负载均衡辅助损失。那些改用路由器偏差来平衡其专家（DeepSeek-V3 及由其衍生的架构）的模型，此处返回None，但仍会返回router_logits。router_logits (
tuple(torch.Tensor)，可选，在传入output_router_logits=True或config.output_router_logits=True时返回) — 一个torch.Tensor元组（每个稀疏层对应一个），形状为(batch_size * sequence_length, num_experts)。由 MoE 路由器计算的原始路由器 logits。可用于计算负载均衡损失，或检查 token 如何被分发到各个专家。
past_key_values（
Cache，可选，在传入use_cache=True或config.use_cache=True时返回）—— 它是一个 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。hidden_states (
tuple(torch.Tensor)，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层的输出，以及每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple(torch.Tensor)，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。