Transformers documentation
NemotronH
该模型于 2025-04-04 在 HF papers 上发布，并于 2026-03-03 贡献至 Hugging Face Transformers。
NemotronH
NemotronH 是一种混合架构，结合了注意力层和状态空间层，以实现高效的长上下文语言建模。它交错排列 Mamba2 和 Transformer 块，并使用固定比例来平衡表达能力与线性时间序列处理。
以下示例演示了如何使用 Pipeline 或 AutoModelForCausalLM 类生成文本。
from transformers import pipeline
pipe = pipeline(
task="text-generation",
model="nvidia/Nemotron-H-8B-Reasoning-128K",
)
pipe("Plants create energy through a process known as")from transformers import AutoModelForCausalLM, AutoTokenizer
tokenizer = AutoTokenizer.from_pretrained("nvidia/Nemotron-H-8B-Reasoning-128K")
model = AutoModelForCausalLM.from_pretrained(
"nvidia/Nemotron-H-8B-Reasoning-128K",
device_map="auto",
)
input_ids = tokenizer("Plants create energy through a process known as", return_tensors="pt").to(model.device)
output = model.generate(**input_ids, max_new_tokens=50)
print(tokenizer.decode(output[0], skip_special_tokens=True))备注
- 在批量生成时使用左侧填充。请参阅 填充侧。
NemotronHConfig
class transformers.NemotronHConfig
< 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 = 131072hidden_size: int = 4096layers_block_type: list[str] | None = Nonetie_word_embeddings: bool = Falseuse_cache: bool = Truenum_logits_to_keep: int = 1pad_token_id: int | None = 0bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2num_attention_heads: int = 32num_key_value_heads: int = 8head_dim: int = 128max_position_embeddings: int = 4096attention_bias: bool = Falseattention_dropout: float | int = 0.0sliding_window: int | None = Noneintermediate_size: int = 21504mlp_hidden_act: str = 'relu2'mlp_bias: bool = Falseuse_mamba_kernels: bool = Truessm_state_size: int = 128mamba_num_heads: int = 128mamba_head_dim: int = 64mamba_hidden_act: str = 'silu'n_groups: int = 8conv_kernel: int = 4expand: int = 2time_step_min: float = 0.001time_step_max: float = 0.1time_step_limit: list[float] | tuple[float, ...] = (0.0, inf)time_step_floor: float = 0.0001use_conv_bias: bool = Truechunk_size: int = 128mamba_proj_bias: bool = Falsemamba_ssm_cache_dtype: str = 'float32'n_routed_experts: int = 8output_router_logits: bool = Falsen_shared_experts: int = 1moe_intermediate_size: int = 7688moe_shared_expert_intermediate_size: int = 7688moe_latent_size: int | None = Nonemoe_shared_expert_overlap: bool = Truenum_experts_per_tok: int = 2routed_scaling_factor: float | int = 1.0n_group: int = 1topk_group: int = 1norm_topk_prob: bool = Truenum_nextn_predict_layers: int = 0mtp_layers_block_type: list[str] | None = Noneuse_bias: bool = Falseinitializer_range: float = 0.02layer_norm_epsilon: float = 1e-05residual_in_fp32: bool = Falsehidden_dropout: float | int = 0.0rescale_prenorm_residual: bool = True )
参数
- vocab_size (
int，可选，默认为131072) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 数量。 - hidden_size (
int，可选，默认为4096) — 隐藏表示的维度。 - layers_block_type (
list, 可选) — 显式指定每一层的类型列表。每个元素必须是以下之一：“mlp”、“linear_attention”、“full_attention” 或 “moe”。 层数由该列表的长度决定。 - tie_word_embeddings (
bool，可选，默认为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - use_cache (
bool，可选，默认为True) — 模型是否应返回最后一次键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True或模型为仅解码器生成式模型时相关。 - num_logits_to_keep（
int，可选，默认为 1）— 生成过程中需要计算的提示词 logits 数量。如果为None，则计算所有 logits。 - pad_token_id (
int, 可选，默认为0) — 词表中用于填充的 token id。 - bos_token_id (
int，可选，默认为1) — 词汇表中用于表示流起始的 token id。 - eos_token_id (
Union[int, list[int]]，可选，默认为2) — 词汇表中用于表示流结束（end-of-stream）的 token id。 - num_attention_heads (
int，可选，默认为32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选，默认为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。 - head_dim (
int，可选，默认为128) — 注意力头维度。如果为 None，则默认为 hidden_size // num_attention_heads - max_position_embeddings (
int，可选，默认为4096) — 该模型可能使用的最大序列长度。 - attention_bias (
bool，可选，默认为False) — 在自注意力机制中，是否在 query、key、value 和 output 投影层中使用偏置。 - attention_dropout (
Union[float, int]，可选，默认为0.0) — 注意力概率的 dropout 比率。 - sliding_window (
int, 可选) — 滑动窗口注意力的窗口大小。如果为None，则不应用滑动窗口。 - intermediate_size (
int，可选，默认为21504) — MLP 表示的维度。 - mlp_hidden_act (
str, 可选，默认为relu2) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu"等。 - mlp_bias (
bool，可选，默认为False) — 是否在 MLP 层的 up_proj、down_proj 和 gate_proj 层中使用偏置。 - use_mamba_kernels (
bool，可选，默认为True) — 已弃用且无实际效果。当快速 Mamba 内核可用时，系统会自动使用它们。 - ssm_state_size (
int，可选，默认为 128) — Mamba 状态空间隐变量的维度。 - mamba_num_heads (
int, 可选，默认为128) — v2 实现中使用的 mamba 头数。 - mamba_head_dim (
int，可选，默认为64) — 头嵌入维度大小 - mamba_hidden_act (
str, 可选，默认为"silu") — Mamba 层中使用的非线性激活函数。 - n_groups (
int，可选，默认为 8) — Mamba 层中演化矩阵的组数。 - conv_kernel (
int，可选，默认为4) — 卷积核的大小。 - expand (
int，可选，默认为 2) — 用于确定 Mamba 层中间大小的扩展因子。 - time_step_min (
float，可选，默认为0.001) — 用于限制dt_proj.bias的最小time_step。 - time_step_max (
float，可选，默认为0.1) — 用于限制dt_proj.bias的最大time_step。 - time_step_limit (
Union[list[float], tuple[float, ...]]，可选，默认为(0.0, inf)) — 用于截断的时间步取值范围。 - time_step_floor (
float，可选，默认为0.0001) — 经过 softplus 激活后，离散时间步长增量的最小允许值。 - use_conv_bias (
bool，可选，默认为True) — 是否在 Mamba mixer 块的卷积层中使用偏置。 - chunk_size (
int，可选，默认为 128) — Mamba 层中用于组成序列的块大小。 - mamba_proj_bias (
bool，可选，默认为False) — 指示是否在 mamba mixer 块的输入和输出投影（[“in_proj”, “out_proj”]）中使用偏置的标志 - mamba_ssm_cache_dtype (
str，可选，默认为"float32") — Mamba SSM 缓存状态的数据类型。 - n_routed_experts (
int，可选，默认为8) — 路由专家的数量。 - output_router_logits (
bool，可选，默认为False) — 是否由模型返回路由器 logits。启用此选项后，模型还将输出辅助损失，包括负载均衡损失和路由器 z-loss。 - n_shared_experts (
int，可选，默认为1) — 共享专家的数量。 - moe_intermediate_size (
int, 可选, 默认值为7688) — 路由专家 MLP 的中间层大小。 - moe_shared_expert_intermediate_size (
int，可选，默认值为 7688) — 共享专家中 MLP 表示的维度。 - moe_latent_size (
int, 可选) — MoE 专家投影的潜在维度。如果为None，则使用hidden_size。 - moe_shared_expert_overlap (
bool，可选，默认为True) — 共享专家是否与路由专家重叠。 - num_experts_per_tok (
int，可选，默认为2) — 每个 token 路由到的专家数量。这是 token 选择路由的 top-k 值。 - routed_scaling_factor (
Union[float, int]，可选，默认为1.0) — 路由专家的缩放因子。 - n_group (
int，可选，默认为 1) — 用于专家路由的组数。 - topk_group (
int，可选，默认为1) — 每个 token 所选的组数（对于每个 token，确保所选专家仅位于topk_group个组内）。 - norm_topk_prob (
bool，可选，默认为True) — 是否对路由专家的权重进行归一化。 - num_nextn_predict_layers (
int，可选，默认为 0) — 用于多 token 预测的额外层数。如果为 0，则禁用多 token 预测。 - mtp_layers_block_type (
list，可选，默认为['full_attention', 'moe']) — 当num_nextn_predict_layers> 0 时，多 token 预测层的显式层类型列表。 - use_bias (
bool，可选，默认为False) — 是否在模型中使用偏置。 - initializer_range (
float，可选，默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_epsilon (
float，可选，默认为1e-05) — 层归一化层所使用的 epsilon 值。 - residual_in_fp32（
bool，可选，默认为False）— 是否将残差保留为float32。 - hidden_dropout (
Union[float, int]，可选，默认为0.0) — 嵌入层、编码器和池化层中所有全连接层的 dropout 概率。 - rescale_prenorm_residual (
bool，可选，默认为True) — 是否对预归一化残差连接进行重新缩放。
这是用于存储 NemotronHModel 配置的类。它根据指定的参数实例化 Nemotron H 模型，并定义模型架构。使用默认值实例化配置，将得到与 nvidia/NVIDIA-Nemotron-3-Nano-30B-A3B-BF16 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PreTrainedConfig 的文档。
>>> from transformers import NemotronHModel, NemotronHConfig
>>> # Initializing a NemotronH configuration
>>> configuration = NemotronHConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = NemotronHModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config验证 layers_block_type 列表。
NemotronHModel
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneinputs_embeds: typing.Optional[torch.LongTensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneuse_cache: bool | None = Noneattention_mask: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> )
NemotronHForCausalLM
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 = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → 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）。 - 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 时），其包含的元素取决于配置（NemotronHConfig）和输入。
NemotronHForCausalLM 的 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 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoTokenizer, NemotronHForCausalLM
>>> model = NemotronHForCausalLM.from_pretrained("Zyphra/NemotronH-7B-v1")
>>> tokenizer = AutoTokenizer.from_pretrained("Zyphra/NemotronH-7B-v1")
>>> 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."