Transformers 文档
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")NemotronHConfig
class transformers.NemotronHConfig
< 源码 >( 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 = 131072 hidden_size: int = 4096 layers_block_type: list[str] | None = None tie_word_embeddings: bool = False use_cache: bool = True num_logits_to_keep: int = 1 pad_token_id: int | None = 0 bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 num_attention_heads: int = 32 num_key_value_heads: int = 8 head_dim: int = 128 max_position_embeddings: int = 4096 attention_bias: bool = False attention_dropout: float | int = 0.0 sliding_window: int | None = None intermediate_size: int = 21504 mlp_hidden_act: str = 'relu2' mlp_bias: bool = False use_mamba_kernels: bool = True ssm_state_size: int = 128 mamba_num_heads: int = 128 mamba_head_dim: int = 64 mamba_hidden_act: str = 'silu' n_groups: int = 8 conv_kernel: int = 4 expand: int = 2 time_step_min: float = 0.001 time_step_max: float = 0.1 time_step_limit: list[float] | tuple[float, ...] = (0.0, inf) time_step_floor: float = 0.0001 use_conv_bias: bool = True chunk_size: int = 128 mamba_proj_bias: bool = False mamba_ssm_cache_dtype: str = 'float32' n_routed_experts: int = 8 n_shared_experts: int = 1 moe_intermediate_size: int = 7688 moe_shared_expert_intermediate_size: int = 7688 moe_latent_size: int | None = None moe_shared_expert_overlap: bool = True num_experts_per_tok: int = 2 routed_scaling_factor: float | int = 1.0 n_group: int = 1 topk_group: int = 1 norm_topk_prob: bool = True num_nextn_predict_layers: int = 0 mtp_layers_block_type: list[str] | None = None use_bias: bool = False initializer_range: float = 0.02 layer_norm_epsilon: float = 1e-05 residual_in_fp32: bool = False hidden_dropout: float | int = 0.0 rescale_prenorm_residual: bool = True )
参数
- vocab_size (
int, 可选, 默认值为131072) — 模型的词汇表大小。定义了input_ids可表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认值为4096) — 隐藏表示的维度。 - layers_block_type (
list, 可选) — 每层具体的层类型列表。每个元素必须是以下之一：“mlp”、“mamba”、“attention” 或 “moe”。层数由该列表的长度决定。 - tie_word_embeddings (
bool, 可选, 默认值为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应返回最后的 key/values 注意力（并非所有模型都使用）。仅在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) — 词汇表中用于序列结束的 token id。 - num_attention_heads (
int, 可选, 默认值为32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选, 默认值为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。 - head_dim (
int, 可选, 默认值为128) — 注意力头维度。如果为 None，则默认为 hidden_size // num_attention_heads。 - max_position_embeddings (
int, 可选, 默认值为4096) — 此模型可能使用的最大序列长度。 - attention_bias (
bool, 可选, 默认值为False) — 在自注意力机制期间，是否在查询 (query)、键 (key)、值 (value) 和输出投影层中使用偏置 (bias)。 - attention_dropout (
Union[float, int], 可选, 默认值为0.0) — 注意力概率的 dropout 比率。 - sliding_window (
int, 可选) — 滑动窗口注意力的窗口大小。如果为None，则不应用滑动窗口。 - intermediate_size (
int, 可选, 默认值为21504) — MLP 表示的维度。 - mlp_hidden_act (
str, optional, defaults torelu2) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu"、"relu"、"silu"等。 - mlp_bias (
bool, optional, defaults toFalse) — 是否在 MLP 层中的 up_proj、down_proj 和 gate_proj 层使用偏置。 - use_mamba_kernels (
bool, optional, defaults toTrue) — 指示是否使用快速 Mamba 内核的标志。 - ssm_state_size (
int, optional, defaults to 128) — Mamba 状态空间潜在变量的维度。 - mamba_num_heads (
int, optional, defaults to128) — v2 实现中使用的 Mamba 头数量。 - mamba_head_dim (
int, optional, defaults to64) — 头嵌入维度的尺寸。 - mamba_hidden_act (
str, optional, defaults to"silu") — Mamba 层中的非线性激活函数。 - n_groups (
int, optional, defaults to 8) — Mamba 层演化矩阵的分组数量。 - conv_kernel (
int, optional, defaults to4) — 卷积核的大小。 - expand (
int, optional, defaults to 2) — 用于确定 Mamba 层中中间层大小的扩展因子。 - time_step_min (
float, optional, defaults to0.001) — 用于约束dt_proj.bias的最小time_step。 - time_step_max (
float, optional, defaults to0.1) — 用于约束dt_proj.bias的最大time_step。 - time_step_limit (
Union[list[float], tuple[float, ...]], optional, defaults to(0.0, inf)) — 用于钳位（clamping）的时间步长值的允许范围。 - time_step_floor (
float, optional, defaults to0.0001) — 在 softplus 激活后，离散时间步长 delta 的最小允许值。 - use_conv_bias (
bool, optional, defaults toTrue) — 是否在 Mamba 混合器块（mixer block）的卷积层中使用偏置。 - chunk_size (
int, optional, defaults to 128) — Mamba 层中构成序列的数据块（chunk）大小。 - mamba_proj_bias (
bool, optional, defaults toFalse) — 指示是否在 Mamba 混合器块的输入和输出投影（[“in_proj”, “out_proj”]）中使用偏置的标志。 - mamba_ssm_cache_dtype (
str, optional, defaults to"float32") — Mamba SSM 缓存状态的数据类型。 - n_routed_experts (
int, optional, defaults to8) — 路由专家（routed experts）的数量。 - n_shared_experts (
int, optional, defaults to1) — 共享专家（shared experts）的数量。 - moe_intermediate_size (
int, optional, defaults to7688) — 路由专家 MLP 的中间层大小。 - moe_shared_expert_intermediate_size (
int, optional, defaults to 7688) — 共享专家中 MLP 表示的维度。 - moe_latent_size (
int, optional) — MoE 专家投影的潜在空间大小。如果为None，则使用hidden_size。 - moe_shared_expert_overlap (
bool, optional, defaults toTrue) — 共享专家是否与路由专家重叠。 - num_experts_per_tok (
int, optional, defaults to2) — 每个 token 要路由到的专家数量。这是 token 选择路由（token-choice routing）的 top-k 值。 - routed_scaling_factor (
Union[float, int], optional, defaults to1.0) — 路由专家的缩放因子。 - n_group (
int, optional, defaults to 1) — 专家路由的分组数量。 - topk_group (
int, optional, defaults to1) — 每个 token 选择的组数（对于每个 token，确保所选专家仅在topk_group个组内）。 - norm_topk_prob (
bool, optional, defaults toTrue) — 是否对路由专家的权重进行归一化。 - num_nextn_predict_layers (
int, 可选, 默认为 0) — 用于多标记预测（multi-token prediction）的额外层数。如果为 0，则禁用多标记预测。 - mtp_layers_block_type (
list, 可选, 默认为['attention', 'moe']) — 当num_nextn_predict_layers> 0 时，用于多标记预测层的层类型显式列表。 - use_bias (
bool, 可选, 默认为False) — 是否在模型中使用偏置（bias）。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器（truncated_normal_initializer）的标准差。 - layer_norm_epsilon (
float, 可选, 默认为1e-05) — 层归一化（layer normalization）层使用的 epsilon 值。 - residual_in_fp32 (
bool, 可选, 默认为False) — 残差（residuals）是否应为float32类型。 - hidden_dropout (
Union[float, int], 可选, 默认为0.0) — 嵌入、编码器和池化层中所有全连接层的丢弃（dropout）概率。 - rescale_prenorm_residual (
bool, 可选, 默认为True) — 是否重新缩放预归一化（pre-normalization）残差连接。
这是用于存储 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
< 源码 >( input_ids: torch.LongTensor | None = None inputs_embeds: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None attention_mask: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] )
NemotronHForCausalLM
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 ) → CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词表中输入序列标记的索引。默认情况下将忽略填充（padding）。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示已被掩码的标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选自范围[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的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果是int，则计算最后logits_to_keep个标记的逻辑值（logits）。如果为0，则计算所有input_ids的逻辑值（特殊情况）。生成时仅需要最后一个标记的逻辑值，仅为该标记进行计算可以节省内存，这对于长序列或大词表规模来说非常显著。如果是torch.Tensor，必须是对应于序列长度维度中要保留的索引的一维张量。这在使用打包张量格式（批量和序列长度的单维度）时非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置（NemotronHConfig）和输入，包含各种元素。
NemotronHForCausalLM 的前向传播方法，覆盖了 __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, 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."