Transformers 文档
HRM-Text
并获得增强的文档体验
开始使用
该模型于 2025 年 6 月 26 日发表在 HF papers 上，并于 2026 年 5 月 18 日贡献给 Hugging Face Transformers。
HRM-Text
概述
HRM-Text 是由 Sapient AI 团队开发的层级推理模型（HRM, Hierarchical Reasoning Model）的改进自回归语言建模变体。它是一个基础模型，使用了层级循环前向传播——两个 Transformer 堆栈（H 用于慢速、抽象的规划，L 用于快速、详细的计算）在嵌套循环中被重复使用。
for h in range(H_cycles):
for l in range(L_cycles):
z_L = L(z_L + z_H)
z_H = H(z_H + z_L)架构特性
- PrefixLM 注意力：指令标记（instruction tokens）进行双向注意力计算，响应标记（response tokens）进行因果注意力计算。由
config.prefix_lm控制（默认True）；有关规范形式，请参阅 4D-masks 博客 / FlexAttention 博客。 - 逐头 Sigmoid 输出门（Per-head sigmoid output gate）：在
o_proj之前应用于注意力输出（Qwen3-Next 风格；参阅Qwen3NextAttention）。存储为单个融合gqkv_proj的旧检查点在加载时，通过已注册的 HRM-Text 检查点转换映射拆分为gate_proj/q_proj/k_proj/v_proj。 - 无参数 RMSNorm — 即没有可学习缩放参数的
F.rms_norm。 L_bp_cycles— 来自 HRM 的 k-step 梯度技巧。在训练时，只有L_cycles低级迭代中的末尾L_bp_cycles[i]会传播梯度；之前的迭代在torch.no_grad()下运行，因此不会存储其激活值。在推理阶段无影响。
用法
HRM-Text-1B 是一个基础语言模型。它不附带 chat_template，且在此版本中特意不支持 apply_chat_template——预训练期间使用的提示词格式仍在演变中，带有稳定聊天模板的指令微调变体将在后续的独立版本中发布。请通过原始的 AutoTokenizer + AutoModelForCausalLM.generate(...) 来运行该基础模型。
from transformers import AutoTokenizer, AutoModelForCausalLM
tokenizer = AutoTokenizer.from_pretrained("sapientinc/HRM-Text-1B")
model = AutoModelForCausalLM.from_pretrained(
"sapientinc/HRM-Text-1B", device_map="auto",
)
inputs = tokenizer("The quick brown fox", return_tensors="pt").to(model.device)
out = model.generate(**inputs, max_new_tokens=16, do_sample=False)
print(tokenizer.decode(out[0], skip_special_tokens=True))Attention 后端
"sdpa" 是默认设置，也是大多数工作负载的正确选择。"flex_attention" 也受支持，在长上下文任务中表现优异——但它在每次前向传播时都有固定的 BlockMask 构建开销，这种开销在 HRM-Text 的循环堆栈复用所带来的优势下并不总是能被摊销。以下是使用发布的 1.2B 基础检查点，在默认 H_cycles=2、L_cycles=3 下，单张 H100 上的预填充（prefill）延迟指示：
| 序列长度 | sdpa | flex_attention | 建议 |
|---|---|---|---|
| 64 | 41 毫秒 | 70 毫秒 | sdpa |
| 256 | 41 毫秒 | 70 毫秒 | sdpa |
| 1024 | 42 毫秒 | 69 毫秒 | sdpa |
| 2048 | 85 毫秒 | 78 毫秒 | flex (≈ 1.1倍) |
因此请根据工作负载选择后端。
# Default — short / medium context
model = AutoModelForCausalLM.from_pretrained("sapientinc/HRM-Text-1B", device_map="auto")
# Long context (≥ 2K tokens) — FlexAttention's per-block sparsity overtakes SDPA
model = AutoModelForCausalLM.from_pretrained(
"sapientinc/HRM-Text-1B", device_map="auto", attn_implementation="flex_attention",
)两种后端产生的结果（Logits）是等效的（已验证端到端 Top-1 与 PyTorch 参考实现 100% 匹配）。"eager" 模式受支持并产生相同的 Logits，但在现代硬件上很少是最高效的选项。其主要用途是 output_attentions=True——SDPA / FlexAttention 不返回逐头（per-head）的注意力权重，因此需要进行分析或可视化时，应使用 attn_implementation="eager"。
任何 FlashAttention 变体（包括 FA 2/3/4 以及可能不遵循
flash_attention_*命名约定的 HF Hub 内核实现）在config.prefix_lm=True（默认值）时，都会在 HrmTextModel 初始化时被拒绝。FA 后端仅接受因果（causal）与非因果掩码，无法表示 PrefixLM 的 4D 覆盖。对于 PrefixLM，请使用"sdpa"（默认）或"flex_attention"。将config.prefix_lm=False设置为 False 会使掩码变为纯因果关系并重新启用 FA——这对于仅限因果的微调或 FA 为最快选项的推理路径非常有用。
PrefixLM 训练
对于尊重指令/响应边界的监督微调，请从数据整理器（data collator）中与 input_ids 一起发出 token_type_ids——指令内部的位置设为 1，响应和填充位置设为 0。模型会将所有 token_type_ids == 1 的位置视为单个双向块，其余部分保持因果关系。
import torch
def collate_prefixlm(batch, pad_token_id=0, ignore_label_id=-100):
"""`batch[i] = {"instruction_ids": [...], "response_ids": [...]}`."""
full_ids = [b["instruction_ids"] + b["response_ids"] for b in batch]
prefix_lens = [len(b["instruction_ids"]) for b in batch]
max_len = max(len(ids) for ids in full_ids)
input_ids = torch.full((len(batch), max_len), pad_token_id, dtype=torch.long)
token_type_ids = torch.zeros_like(input_ids)
labels = torch.full_like(input_ids, ignore_label_id)
attention_mask = torch.zeros_like(input_ids)
for i, (ids, plen) in enumerate(zip(full_ids, prefix_lens)):
input_ids[i, : len(ids)] = torch.tensor(ids)
token_type_ids[i, :plen] = 1 # bidirectional prefix
labels[i, plen : len(ids)] = input_ids[i, plen : len(ids)] # loss on response only
attention_mask[i, : len(ids)] = 1
return {
"input_ids": input_ids,
"token_type_ids": token_type_ids,
"attention_mask": attention_mask,
"labels": labels,
}有关接收的形状，请参阅 HrmTextModel.forward()。
HrmTextConfig
class transformers.HrmTextConfig
... [省略源代码链接部分以保持简洁] ...（配置参数列表，如 vocab_size, hidden_size 等）
参数
- vocab_size (
int, 可选, 默认值为151808) — 模型的词汇表大小。定义了input_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认值为1536) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认值为4096) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认值为16) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认值为12) — Transformer 解码器中每个注意力层的注意力头数量。 - hidden_act (
str, 可选, 默认值为silu) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu"、"relu"、"silu"等。 - max_position_embeddings (
int, 可选, 默认值为2048) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认值为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认值为1e-06) — 用于 RMS 归一化层的 epsilon 值。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True或模型是仅解码器生成模型时相关。 - pad_token_id (
int, 可选) — 词汇表中用于填充的标记 ID。 - bos_token_id (
int, 可选) — 词汇表中用于流起始（beginning-of-stream）的标记 ID。 - eos_token_id (
Union[int, list[int]], 可选) — 词汇表中用于流结束（end-of-stream）的标记 ID。 - tie_word_embeddings (
bool, 可选, 默认值为False) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。字典应包含rope_theta的值，以及在想要配合更长的max_position_embeddings使用 RoPE 时，可选的缩放参数。 - attention_bias (
bool, 可选, 默认值为False) — 在自注意力期间，是否在查询、键、值和输出投影层中使用偏置项。 - attention_dropout (
Union[int, float], 可选, 默认值为0.0) — 注意力概率的 Dropout 比率。 - mlp_bias (
bool, 可选, 默认值为False) — 在 MLP 层中，是否在 up_proj、down_proj 和 gate_proj 层中使用偏置项。 - head_dim (
int, 可选, 默认值为128) — 注意力头维度。如果为 None，默认值为 hidden_size // num_attention_heads。 - H_cycles (
int, 可选, 默认为 2) — 高级循环（high-level cycles）的数量。 - L_cycles (
int, 可选, 默认为 3) — 每个 H 循环中的低级循环（low-level cycles）数量。 - L_bp_cycles (
list[int], 可选, 默认为[2]) — 训练时的梯度路由列表；在模型内部会对左侧填充1直至达到L_cycles。推理时无操作。 - embedding_scale (
float, 可选) — Token 嵌入的乘数。如果为None，则默认为1 / initializer_range。 - prefix_lm (
bool, 可选, 默认为True) — 指令 token 进行双向注意力机制，回复 token 进行因果注意力机制。 - num_layers_per_stack (
int, 可选) — 每个 H / L 堆栈内实际的 transformer 层数。在首次构建时自动设置：传递的num_hidden_layers值会在此处记录，随后num_hidden_layers会被重写为num_layers_per_stack * H_cycles * (L_cycles + 1)，以便DynamicCache(config=...)在循环前向传递过程中为每次独特的注意力调用预分配一个槽位。首次构建时请勿直接设置此项 — 请将实际的每堆栈层数作为num_hidden_layers传入，并让__post_init__进行拆分。
这是用于存储 HrmTextModel 配置的配置类。它根据指定的参数实例化一个 Hrm Text 模型，从而定义模型架构。使用默认值实例化配置将产生与 sapientinc/HRM-Text-1B 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
HrmTextModel
class transformers.HrmTextModel
< 源码 >( config: HrmTextConfig )
参数
- config (HrmTextConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
原始的 Hrm Text 模型，输出原始隐藏状态，不带任何特定的输出头。
该模型继承自 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 token_type_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下填充会被忽略。可以使用 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，用户只需输入形状为(batch_size, unprocessed_length)的未处理input_ids（那些其过去键值状态未提供给此模型的输入），而不是形状为(batch_size, sequence_length)的所有input_ids。 - token_type_ids (
torch.LongTensor, 形状为(batch, seq_len), 可选) — 每个位置的双向/因果指示器。token_type_ids == 1的 token 形成单个双向块；所有其他位置均为因果关系。 - inputs_embeds (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
返回
BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置 (HrmTextConfig) 和输入包含各种元素。
HrmTextModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, 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 后的注意力权重，用于计算自注意力头中的加权平均值。
HrmTextForCausalLM
class transformers.HrmTextForCausalLM
< 源码 >( 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 (HrmTextForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Hrm Text 模型。
该模型继承自 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 token_type_ids: torch.LongTensor | 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 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下填充会被忽略。可以使用 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 cache 指南。如果没有传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即那些没有将其过去键值状态提供给该模型的输入），其形状为(batch_size, unprocessed_length)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - token_type_ids (
torch.LongTensor，形状为(batch, seq_len)，可选) — 每个位置的双向/因果指示器。token_type_ids == 1的标记构成一个双向块；所有其他位置均为因果关系。 - 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 时），根据配置（HrmTextConfig）和输入包含各种元素。
HrmTextForCausalLM 的前向传播方法，覆盖了 __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 后的注意力权重，用于计算自注意力头中的加权平均值。