Transformers 文档
Mellum
并获得增强的文档体验
开始使用
此模型于 2026 年 5 月 28 日贡献给 Hugging Face Transformers。
Mellum
Mellum 是由 JetBrains 开发的专注于代码的混合专家（Mixture-of-Experts）语言模型。它衍生自 Qwen3-MoE 架构，采用了按层类型区分的 RoPE 和交错滑动窗口注意力机制。该模型总参数量为 12B，每个 token 激活 2.5B 参数，在 28 层结构中使用了 64 个路由专家，每个 token 激活其中的 8 个。
以下示例演示了如何使用 Pipeline 或 AutoModelForCausalLM 类生成文本。
from transformers import pipeline
pipe = pipeline(
task="text-generation",
model="JetBrains/Mellum2-12B-A2.5B-Base",
)
pipe("def fibonacci(n):")MellumConfig
class transformers.MellumConfig
< 源代码 >( 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 = 98304 hidden_size: int = 2304 intermediate_size: int = 7168 num_hidden_layers: int = 28 num_attention_heads: int = 32 num_key_value_heads: int = 4 hidden_act: str = 'silu' max_position_embeddings: int = 131072 initializer_range: float = 0.02 rms_norm_eps: float = 1e-06 use_cache: bool = True tie_word_embeddings: bool = False rope_parameters: dict | transformers.modeling_rope_utils.RopeParameters | None = None attention_bias: bool = False sliding_window: int | None = 1024 attention_dropout: float | int = 0.0 moe_intermediate_size: int = 896 num_experts_per_tok: int = 8 num_experts: int = 64 norm_topk_prob: bool = True output_router_logits: bool = False router_aux_loss_coef: float = 0.001 pad_token_id: int | None = None bos_token_id: int | None = None eos_token_id: int | list[int] | None = None head_dim: int = 128 layer_types: list[str] | None = None mlp_layer_types: list[str] | None = None )
参数
- vocab_size (
int, 可选, 默认为98304) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为2304) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为7168) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为28) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选, 默认为4) — 这是用于实现分组查询注意力（Grouped Query Attention, GQA）的键值（key_value）头数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（MQA）；否则使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组的键和值头应通过对该组内的所有原始头进行平均池化来构建。更多详细信息，请参阅这篇论文。如果不指定，默认值为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, 可选, 默认为True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型是仅解码器的生成模型时相关。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。 - rope_parameters (
Union[dict, ~modeling_rope_utils.RopeParameters], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，以及在希望使用具有更长max_position_embeddings的 RoPE 时用于缩放的可选参数。 - attention_bias (
bool, 可选, 默认为False) — 是否在自注意力机制期间的查询、键、值和输出投影层中使用偏置。 - sliding_window (
int, 可选, 默认为1024) — 滑动窗口注意力的窗口大小。如果为None，则不应用滑动窗口。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力概率的丢弃率。 - moe_intermediate_size (
int, 可选, 默认为896) — 路由专家 MLP 的中间层大小。 - num_experts_per_tok (
int, 可选, 默认为8) — 每个 token 要路由到的专家数量。这是 token 选择路由的 top-k 值。 - num_experts (
int, 可选, 默认为64) — MoE 层中的路由专家数量。 - norm_topk_prob (
bool, 可选, 默认为True) — 是否对路由专家的权重进行归一化。 - output_router_logits (
bool, 可选, 默认为False) — 模型是否应该返回路由 logits。启用此选项还将允许模型输出辅助损失，包括负载均衡损失和路由 z-loss。 - router_aux_loss_coef (
float, 可选, 默认为0.001) — 辅助负载均衡损失系数。用于惩罚 MoE 模型中不均匀的专家路由。 - pad_token_id (
int, 可选) — 词汇表中用于填充（padding）的 token ID。 - bos_token_id (
int, 可选) — 词汇表中用于流开始（beginning-of-stream）的 token ID。 - eos_token_id (
Union[int, list[int]], optional) — 词表中用于表示流结束（end-of-stream）的 Token ID。 - head_dim (
int, optional, defaults to128) — 注意力头的维度。如果为 None，则默认为 hidden_size // num_attention_heads。 - layer_types (
list[str], optional) — 一个明确将每个层索引映射到其层类型的列表。如果未提供，将根据配置值自动生成。 - mlp_layer_types (
list[str], optional) — 每层的 MLP 类型 —"dense"或"sparse"。长度必须等于num_hidden_layers。默认为全稀疏（sparse）。
这是用于存储 MellumModel 配置的配置类。它用于根据指定的参数实例化 Mellum 模型，从而定义模型架构。使用默认值实例化配置将产生与 JetBrains/Mellum2-12B-A2.5B-Base 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
MellumModel
class transformers.MellumModel
< 源码 >( config: MellumConfig )
参数
- config (MellumConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化模型不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
裸 Mellum 模型，输出原始隐藏状态，顶部没有任何特定的头部。
该模型继承自 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 在位置嵌入（position embeddings）中的位置索引。选自范围[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（即没有向模型提供其过去键值状态的 token），形状为(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 时），根据配置（MellumConfig）和输入包含不同的元素。
MellumModel 的 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 后），这些术语用于计算专家混合模型的辅助损失。
MellumForCausalLM
class transformers.MellumForCausalLM
< 源码 >( 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 (MellumForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化模型不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Mellum 模型。
该模型继承自 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 (
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 在位置嵌入（position embeddings）中的位置索引。选自范围[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（即没有向模型提供其过去键值状态的 token），形状为(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）。 - output_router_logits (
bool, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失（router loss）很有用，但在推理过程中不应返回。 - logits_to_keep (
Union[int, torch.Tensor], 可选, 默认为0) — 如果是int，则计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成时仅需要最后一个 token 的 logits，仅为该 token 计算 logits 可以节省内存，这对于长序列或大词表大小的情况非常显著。如果是torch.Tensor，则必须是一维的，对应于要在序列长度维度上保留的索引。这在使用打包张量格式（batch 和序列长度使用单一维度）时非常有用。
返回
MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 MoeCausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置（MellumConfig）和输入而定的各种元素。
MellumForCausalLM 的 forward 方法，重写了 __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 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, MellumForCausalLM
>>> model = MellumForCausalLM.from_pretrained("Qwen/Qwen3-MoE-15B-A2B")
>>> tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen3-MoE-15B-A2B")
>>> 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."