Transformers 文档
Lfm2Moe
并获得增强的文档体验
开始使用
此模型于 2025 年 10 月 7 日贡献给 Hugging Face Transformers。
Lfm2Moe
概述
LFM2-MoE 是 LFM2 的混合专家（MoE）变体。LFM2 系列通过将短距离、输入感知的门控卷积与分组查询注意力（GQA）相结合，并采用在严格的速度和内存限制下实现质量最大化的布局，从而针对端侧推理进行了优化。
LFM2-MoE 保留了这一快速的主干网络，并引入了稀疏 MoE 前馈网络，在不显著增加活跃计算路径的情况下增加了表征能力。首个 LFM2-MoE 版本是 LFM2-8B-A1B，总参数量为 83 亿，活跃参数量为 15 亿。该模型在质量（可媲美 30 亿-40 亿参数的稠密模型）和速度（快于其他 15 亿参数级别的模型）方面表现出色。
示例
以下示例展示了如何使用 AutoModelForCausalLM 类来生成答案。
from transformers import AutoModelForCausalLM, AutoTokenizer
# Load model and tokenizer
model_id = "LiquidAI/LFM2-8B-A1B"
model = AutoModelForCausalLM.from_pretrained(
model_id,
device_map="auto",
dtype="bfloat16",
# attn_implementation="flash_attention_2" <- uncomment on compatible GPU
)
tokenizer = AutoTokenizer.from_pretrained(model_id)
# Generate answer
prompt = "What is C. elegans?"
input_ids = tokenizer.apply_chat_template(
[{"role": "user", "content": prompt}],
add_generation_prompt=True,
return_tensors="pt",
tokenize=True,
).to(model.device)
output = model.generate(
input_ids,
do_sample=True,
temperature=0.3,
min_p=0.15,
repetition_penalty=1.05,
max_new_tokens=512,
)
print(tokenizer.decode(output[0], skip_special_tokens=False))Lfm2MoeConfig
class transformers.Lfm2MoeConfig
< 源码 >( 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 = 65536 hidden_size: int = 2048 intermediate_size: int = 7168 moe_intermediate_size: int = 1792 num_hidden_layers: int = 32 pad_token_id: int | None = 0 bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 tie_word_embeddings: bool = True rope_parameters: dict | None = None max_position_embeddings: int = 128000 initializer_range: float = 0.02 use_cache: bool = True norm_eps: float = 1e-05 num_attention_heads: int = 32 num_key_value_heads: int = 8 conv_bias: bool = False conv_L_cache: int = 3 num_dense_layers: int = 2 num_experts_per_tok: int = 4 num_experts: int = 32 use_expert_bias: bool = True routed_scaling_factor: float = 1.0 norm_topk_prob: bool = True layer_types: list[str] | None = None )
参数
- vocab_size (
int, 可选, 默认为65536) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为2048) — 隐藏状态表征的维度。 - intermediate_size (
int, 可选, 默认为7168) — MLP 表征的维度。 - moe_intermediate_size (
int, 可选, 默认为1792) — 路由专家 MLP 的中间层维度。 - num_hidden_layers (
int, 可选, 默认为32) — Transformer 解码器中的隐藏层数量。 - pad_token_id (
int, 可选, 默认为0) — 词汇表中用于填充（padding）的 token ID。 - bos_token_id (
int, 可选, 默认为1) — 词汇表中用于流开始（beginning-of-stream）的 token ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词汇表中用于流结束（end-of-stream）的 token ID。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。 - rope_parameters (
dict, 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，以及（可选）如果您想在更长的max_position_embeddings上使用 RoPE 时所需的缩放参数。 - max_position_embeddings (
int, 可选, 默认为128000) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True或当模型为仅解码器生成模型时才相关。 - norm_eps (
float, 可选, 默认为1e-05) — 层归一化层使用的 epsilon。 - num_attention_heads (
int, 可选, 默认为32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选, 默认为8) — 这是用于实现分组查询注意力（Grouped Query Attention）的键值头数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（MQA）；否则使用 GQA。当将多头检查点转换为 GQA 检查点时，每个组的键和值头应通过对该组内的所有原始头进行均值池化来构建。更多详情，请查阅此论文。如果不指定，将默认为num_attention_heads。 - conv_bias (
bool, 可选, 默认为False) — 是否在卷积层中使用偏置。 - conv_L_cache (
int, 可选, 默认为 3) — 卷积层中的 L_cache 维度。 - num_dense_layers (
int, 可选, 默认为 2) — 浅层中的稠密 Lfm2MoeMLP 层数量 (embed->dense->dense->…->dense->moe->moe…->lm_head)。 - num_experts_per_tok (
int, 可选, 默认为4) — 每个 token 要路由到的专家数量。这是 token 选择路由的 top-k 值。 - num_experts (
int, 可选, 默认为32) — MoE 层中的路由专家数量。 - use_expert_bias (
bool, 可选, 默认为True) — 是否在路由权重上使用专家偏置。 - routed_scaling_factor (
float, optional, defaults to1.0) — 路由专家的缩放因子。 - norm_topk_prob (
bool, optional, defaults toTrue) — 是否对路由专家的权重进行归一化。 - layer_types (
list[str], optional) — 一个显式映射每个层索引及其层类型的列表。如果未提供，将根据配置值自动生成。
这是用于存储 Lfm2MoeModel 配置的配置类。它根据指定的参数实例化一个 Lfm2 Moe 模型，从而定义模型架构。使用默认值实例化配置将产生与 LiquidAI/LFM2-8B-A1B 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
>>> from transformers import Lfm2MoeModel, Lfm2MoeConfig
>>> # Initializing a LFM2 Moe model
>>> configuration = Lfm2MoeConfig()
>>> # Initializing a model from the LFM2-8B-A1B style configuration
>>> model = Lfm2MoeModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configLfm2MoeForCausalLM
class transformers.Lfm2MoeForCausalLM
< 源代码 >( 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 (Lfm2MoeForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看
from_pretrained()方法以加载模型权重。
用于因果语言建模的 Lfm2 Moe 模型。
该模型继承自 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 的索引。默认情况下，填充（padding）将被忽略。可以使用 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]范围内的 token 计算。 - 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，则必须是一维的，对应于序列长度维度中要保留的索引。当使用打包张量格式（batch 和序列长度使用单一维度）时，这很有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传入 return_dict=False 或当 config.return_dict=False 时），根据配置 (Lfm2MoeConfig) 和输入包含各种元素。
Lfm2MoeForCausalLM 的 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, Lfm2MoeForCausalLM
>>> model = Lfm2MoeForCausalLM.from_pretrained("meta-lfm2_moe/Lfm2Moe-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-lfm2_moe/Lfm2Moe-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."Lfm2MoeModel
class transformers.Lfm2MoeModel
< 源代码 >( config: Lfm2MoeConfig )
参数
- config (Lfm2MoeConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看
from_pretrained()方法以加载模型权重。
输出原始隐藏状态且顶部没有任何特定头的纯 Lfm2 Moe 模型。
该模型继承自 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 表示未被掩码的 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索引转换为关联向量，这会非常有用。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。
返回
MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeModelOutputWithPast 或 torch.FloatTensor 的元组（如果传入 return_dict=False 或当 config.return_dict=False 时），根据配置 (Lfm2MoeConfig) 和输入包含各种元素。
Lfm2MoeModel 的 forward 方法，重写了 __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 后），这些术语用于计算专家混合模型的辅助损失。
Lfm2MoePreTrainedModel
class transformers.Lfm2MoePreTrainedModel
< 源码 >( config: PreTrainedConfig *inputs **kwargs )
参数
- config (PreTrainedConfig) — 包含模型所有参数的模型配置类。仅使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
定义每次调用时执行的计算。
应由所有子类覆盖。
尽管前向传播的配方需要在该函数中定义，但之后应该调用
Module实例而不是它，因为前者负责运行注册的钩子，而后者则默默地忽略它们。