Transformers 文档
Laguna
并获得增强的文档体验
开始使用
该模型于2024年8月28日发表在HF论文中，并于2026年4月28日贡献给Hugging Face Transformers。
Laguna
Laguna 是 Poolside 的混合专家（Mixture-of-Experts）语言模型系列。相比标准的 SwiGLU MoE Transformer，Laguna 的具体改进包括：
- 各层注意力头数通过
num_attention_heads_per_layer实现 —— 不同的解码器层可以拥有不同的查询头（query-head）数量，同时共享相同的 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"])注意事项
- 注意力后端。 支持 SDPA（默认）、FlashAttention-2 和 flex attention。注意力输出门控在内核调用之外应用，因此适用于所有后端。
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)（第一层为稠密层，其余为 MoE 层）。moe_apply_router_weight_on_input=True目前不支持与融合专家内核（grouped_mm_experts_forward）同时使用；validate_architecture会在配置构建时报错。请将其设置为False（默认值）。
LagunaConfig
class transformers.LagunaConfig
< 源文件 >（所有参数定义保持不变）
参数
- vocab_size (int, optional, defaults to 100352) — 模型的词汇表大小。定义了 input_ids 可以表示的不同 token 的数量。
- hidden_size (int, optional, defaults to 2048) — 隐藏层表示的维度。
- intermediate_size (int, optional, defaults to 8192) — MLP 表示的维度。
- num_hidden_layers (int, optional, defaults to 40) — Transformer 解码器中的隐藏层数量。
- num_attention_heads (int, optional, defaults to 48) — Transformer 解码器中每个注意力层的注意力头数。
- num_key_value_heads (int, optional, defaults to 8) — 用于实现分组查询注意力（Grouped Query Attention, GQA）的 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, optional, defaults to silu) — 解码器中的非线性激活函数（函数或字符串）。例如：“gelu”、“relu”、“silu” 等。
- max_position_embeddings (int, optional, defaults to 131072) — 此模型可能使用的最大序列长度。
- 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) — 模型是否应返回最后的 key/values 注意力（并非所有模型都使用）。仅在 config.is_decoder=True 或模型为仅解码器生成模型时相关。
- tie_word_embeddings (bool, optional, defaults to False) — 是否根据模型的 tied_weights_keys 映射来绑定权重嵌入。
- rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], optional) — 包含 RoPE 嵌入配置参数的字典。该字典应包含 rope_theta 的值，并可选择包含在想要使用更长的 max_position_embeddings 时用于缩放的参数。
- sliding_window (int, optional, defaults to 512) — 滑动窗口注意力的窗口大小。如果为 None，则不应用滑动窗口。
- attention_dropout (Union[float, int], optional, defaults to 0.0) — 注意力概率的 dropout 比率。
- moe_intermediate_size (int, optional, defaults to 512) — 路由专家 MLP 的中间层大小。
- shared_expert_intermediate_size (int, optional, defaults to 512) — 共享专家 MLP 的中间层大小。
- num_experts_per_tok (int, optional, defaults to 8) — 每个 token 路由到的专家数量。这是 Token 选择路由的 top-k 值。
- num_experts (int, optional, defaults to 256) — MoE 层中路由专家的总数。
- output_router_logits (bool, optional, defaults to False) — 模型是否应返回路由器 logit。启用此功能还将允许模型输出辅助损失，包括负载均衡损失和路由器 z-loss。
- router_aux_loss_coef (float, 可选, 默认为 0.001) — 辅助负载均衡损失系数。用于惩罚 MoE 模型中不均匀的专家路由。
- layer_types (list[str], 可选) — 一个显式映射每个层索引及其层类型的列表。如果未提供，将根据配置值自动生成。
- pad_token_id (int, 可选) — 词表中用于填充（padding）的 Token ID。
- bos_token_id (int, 可选) — 词表中用于流开始（beginning-of-stream）的 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) — 是否在自注意力机制的 query、key、value 和输出投影层中使用偏置（bias）。
- num_attention_heads_per_layer (list[int], 可选) — 逐层覆盖
num_attention_heads的设置。长度必须等于num_hidden_layers。 - mlp_layer_types (list[str], 可选) — 逐层 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 路由器的 Logit 上应用 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
< 源文件 >( config: LagunaConfig )
参数
- config (LagunaConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化模型不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 Laguna 模型，输出原始隐藏状态，顶部没有任何特定的头部。
该模型继承自 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 use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- 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 表示未被掩盖（not masked）的 Token，
- 0 表示被掩盖（masked）的 Token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 Token 在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含当use_cache=True或config.use_cache=True时，模型在解码上一阶段返回的past_key_values。只允许输入 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，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这非常有用。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回
MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（LagunaConfig）和输入而定的各种元素。
LagunaModel 前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) 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 后的注意力权重，用于计算自注意力头中的加权平均值。
router_logits (
tuple(torch.FloatTensor), 可选, 当传递output_router_probs=True且config.add_router_probs=True时，或config.output_router_probs=True时返回) — 形状为(batch_size, sequence_length, num_experts)的torch.FloatTensor元组（每一层一个）。由 MoE 路由器计算的原始路由器对数（softmax 后），这些术语用于计算专家混合模型的辅助损失。
LagunaForCausalLM
class transformers.LagunaForCausalLM
< 源文件 >( 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 (LagunaForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查阅 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Laguna 模型。
该模型继承自 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 output_router_logits: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 词汇表中输入序列标记的索引。默认情况下，填充（Padding）将被忽略。可以通过 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[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（即其过去键值状态未提供给此模型的那些 ID），形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 可选，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这很有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 之间（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的标记计算。 - 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个标记的逻辑值。如果为0，则计算所有input_ids的逻辑值（特殊情况）。生成时仅需要最后一个标记的逻辑值，且仅计算该标记的逻辑值可以节省内存，这对于长序列或大词汇量的情况尤为显著。如果是torch.Tensor，则必须是对应于序列长度维度中要保留的索引的一维张量。当使用打包张量格式（批次和序列长度的单一维度）时，这很有用。
返回
MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeCausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（LagunaConfig）和输入，包含各种元素。
LagunaForCausalLM 前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。aux_loss (
torch.FloatTensor，可选，当提供labels时返回) — 稀疏模块的辅助损失。router_logits (
tuple(torch.FloatTensor), 可选, 当传递output_router_probs=True且config.add_router_probs=True时，或config.output_router_probs=True时返回) — 形状为(batch_size, sequence_length, num_experts)的torch.FloatTensor元组（每一层一个）。由 MoE 路由器计算的原始路由器对数（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 后的注意力权重，用于计算自注意力头中的加权平均值。