Transformers 文档

Hy3-preview

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

此模型于 2026 年 4 月 22 日贡献给 Hugging Face Transformers。

Hy3-preview

概述

Hy3-preview 是由腾讯混元(HunYuan)团队开发的大规模专家混合(MoE)语言模型。它采用了 192 个路由专家和每层 1 个常驻共享专家的密集-稀疏混合(Dense-MoE)架构,通过稀疏专家激活实现了高效推理和强大的性能。

关键架构特性

  • 密集-MoE 混合架构:第一层使用密集 FFN;后续所有层均使用带有 top-k 路由(默认 k=8)的 MoE。
  • 共享专家:每个 MoE 层包含 1 个共享专家,与路由专家一同处理所有 Token。
  • Sigmoid 路由与专家偏差校正:Token 通过 Sigmoid 打分(非 Softmax)进行路由,并结合学习到的每个专家的偏差(bias)来实现负载均衡。
  • QK-Norm:在注意力计算前,对查询(query)和键(key)投影应用逐头的 RMSNorm,以提高训练稳定性。

使用技巧

  • 使用 AutoModelForCausalLM 加载。由于模型体积较大,需要多张 GPU。
  • 在配置(config)或前向传播(forward)调用中设置 output_router_logits=True,以收集每层的 MoE 路由 Logits。请注意,该模型不计算辅助负载均衡损失;aux_loss 始终为 None
  • 该模型支持 gradient_checkpointing 以减少微调过程中的内存占用。
from transformers import AutoModelForCausalLM, AutoTokenizer


model_id = "tencent/Hy3-preview"
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(
    model_id,
    device_map="auto",
)

inputs = tokenizer("The future of artificial intelligence is", return_tensors="pt").to(model.device)
outputs = model.generate(**inputs, max_new_tokens=64)
print(tokenizer.decode(outputs[0], skip_special_tokens=True))

HYV3Config

class transformers.HYV3Config

< >

(略,保留代码结构)

参数

  • vocab_size (int, 可选, 默认值为 120832) — 模型词汇表大小。定义了 input_ids 可以表示的不同 Token 的数量。
  • hidden_size (int, 可选, 默认值为 4096) — 隐藏层表示的维度。
  • intermediate_size (int, 可选, 默认值为 13312) — MLP 表示的维度。
  • num_hidden_layers (int, 可选, 默认值为 80) — Transformer 解码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认值为 64) — Transformer 解码器中每个注意力层的注意力头数量。
  • num_key_value_heads (int, 可选, 默认值为 8) — 这是用于实现分组查询注意力(GQA)的键值(key_value)头数量。若 num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);若 num_key_value_heads=1,模型将使用多查询注意力(MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的键和值头应通过对该组内的所有原始头进行均值池化(meanpooling)来构建。更多详情请参考这篇论文。如未指定,将默认采用 num_attention_heads
  • head_dim (int, 可选, 默认值为 128) — 注意力头维度。如果为 None,则默认为 hidden_size // num_attention_heads。
  • hidden_act (str, 可选, 默认值为 silu) — 解码器中的非线性激活函数(函数或字符串)。例如:"gelu", "relu", "silu" 等。
  • max_position_embeddings (int, 可选, 默认值为 131072) — 此模型可能使用的最大序列长度。
  • initializer_range (float, 可选, 默认值为 0.006) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • rms_norm_eps (float, 可选, 默认值为 1e-05) — RMS 归一化层使用的 epsilon 值。
  • use_cache (bool, 可选, 默认值为 True) — 模型是否应返回最后的 key/values 注意力(并非所有模型都使用)。仅在 config.is_decoder=True 或模型为仅解码器的生成式模型时相关。
  • 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。
  • tie_word_embeddings (bool, 可选, 默认值为 False) — 是否根据模型映射关系 tied_weights_keys 绑定权重嵌入。
  • attention_bias (bool, 可选, 默认值为 False) — 自注意力层中是否在查询、键、值及输出投影层使用偏置。
  • attention_dropout (float, 可选, 默认值为 0.0) — 注意力概率的 Dropout 比率。
  • mlp_bias (bool, 可选, 默认值为 False) — MLP 层中是否在 up_proj、down_proj 和 gate_proj 层使用偏置。
  • num_experts (int, 可选, 默认值为 192) — MoE 层中路由专家的数量。
  • num_experts_per_tok (int, 可选, 默认值为 8) — 每个 Token 需要路由到的专家数量。这是 Token 选择路由的 top-k 值。
  • num_shared_experts (int, 可选, 默认值为 1) — 对所有 Token 始终激活的共享专家数量。
  • moe_intermediate_size (int, 可选, 默认值为 1536) — 路由专家 MLP 的中间层大小。
  • router_scaling_factor (float, 可选, 默认值为 2.826) — MoE 专家选择的 top-k 权重缩放因子。
  • enable_moe_fp32_combine (bool, 可选, 默认值为 True) — 是否在 fp32 或模型的基础数据类型中将共享专家添加到最终的 MoE 结果中。
  • mlp_layer_types (list, 可选) — 每一层的 MLP(MoE 与 Dense)模式。
  • output_router_logits (bool, 可选, 默认值为 False) — 模型是否应返回路由 Logits。启用此项也将允许模型输出辅助损失,包括负载均衡损失和路由 z-loss。
  • rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含 rope_theta 的值,以及在希望使用更长的 max_position_embeddings 时用于缩放的可选参数。

这是用于存储 HYV3Model 配置的配置类。它用于根据指定的参数实例化 Hy V3 模型,从而定义模型架构。使用默认值实例化配置将产生与 tencent/Hy3-preview 类似的配置。

配置对象继承自 PreTrainedConfig,可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import HYV3Config, HYV3Model

>>> config = HYV3Config()
>>> model = HYV3Model(config)

HYV3Model

class transformers.HYV3Model

< >

(略,保留代码结构)

参数

  • config (HYV3Config) — 包含模型所有参数的模型配置类。使用配置文件初始化模型不会加载关联的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。

输出原始隐藏状态且不带任何特定头部的纯 Hy V3 模型。

该模型继承自 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] ) MoeModelOutputWithPasttuple(torch.FloatTensor)

参数

  • (略,保留代码结构)
  • (略,保留代码结构)
  • (略,保留代码结构)
  • (略,保留代码结构)
  • (略,保留代码结构)
  • (略,保留代码结构)

返回

MoeModelOutputWithPasttuple(torch.FloatTensor)

根据配置(HYV3Config)和输入,包含各种元素的 MoeModelOutputWithPasttorch.FloatTensor 元组(若传入 return_dict=Falseconfig.return_dict=False)。

HYV3Model 的前向传播方法,覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

  • last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  • past_key_values (Cache,*可选*,当传入 use_cache=Trueconfig.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=True in the cross-attention blocks) that can be used (see past_key_values input) 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=Trueconfig.add_router_probs=True 时,或 config.output_router_probs=True 时返回) — 形状为 (batch_size, sequence_length, num_experts)torch.FloatTensor 元组(每一层一个)。

    由 MoE 路由器计算的原始路由器对数(softmax 后),这些术语用于计算专家混合模型的辅助损失。

HYV3ForCausalLM

class transformers.HYV3ForCausalLM

< >

(略,保留代码结构)

参数

  • config (HYV3Config) — 包含模型所有参数的模型配置类。使用配置文件初始化模型不会加载关联的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。

用于因果语言建模的 Hy V3 模型。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

(略,保留代码结构)

(略,保留代码结构)

参数

  • (略,保留代码结构)
  • (略,保留代码结构)
  • (略,保留代码结构)
  • past_key_values (~cache_utils.Cache, 可选) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速序列解码。通常由模型在解码的先前阶段返回,当 use_cache=Trueconfig.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 的 logits。如果为 0,则计算所有 input_ids 的 logits(特殊情况)。生成时仅需最后 token 的 logits,仅为该 token 计算可以节省内存,这对于长序列或大词汇表来说意义重大。如果为 torch.Tensor,则必须是对应序列长度维度中要保留的索引的一维张量。这在使用打包(packed)张量格式(批量和序列长度为单维度)时很有用。

返回

MoeCausalLMOutputWithPasttuple(torch.FloatTensor)

一个 MoeCausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False 时),根据配置 (HYV3Config) 和输入包含各种元素。

HYV3ForCausalLM 的 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=Trueconfig.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=Trueconfig.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 后的注意力权重,用于计算自注意力头中的加权平均值。

示例

在 GitHub 上更新

© . This site is unofficial and not affiliated with Hugging Face, Inc.