Transformers 文档
此模型发布于 2025-07-21,并于 2026-05-08 加入 Hugging Face Transformers。
并获得增强的文档体验
开始使用
<<<<<<< 更新上游 (Updated upstream)
此模型发布于 2025-07-21,并于 2026-05-08 加入 Hugging Face Transformers。
此模型于 2026-05-08 被贡献至 Hugging Face Transformers。
暂存的更改 (Stashed changes)
HyperCLOVA X
概述
HyperCLOVA X SEED Think 是 NAVER Cloud 的语言模型,它将剪枝(pruning)和知识蒸馏与先进的推理能力相结合。该 14B 模型采用基于 Transformer 的架构,具有层内归一化(Peri-Layer Normalization)和最大更新参数化(Maximal Update Parameterization, μP),拥有 147.4 亿参数和 32k 上下文长度。它支持双模式推理(思考/非思考)以及通过基于 ChatML 格式的函数调用。
该模型采用了多阶段强化学习流水线(SFT → RLVR → 长度可控性 → 联合 RLHF+RLVR)训练,在韩语基准测试和推理任务中表现出色。
HyperCLOVA X 的实现与 Granite 高度相似,并进行了以下修改:
- 最大更新参数化 (MuP):使用各配置的缩放因子(
attention_multiplier、residual_multiplier、embedding_multiplier、logits_scaling)以实现跨模型规模的稳定训练。head_dim(默认为hidden_size // num_attention_heads)用于计算默认的attention_multiplier。 - 层内归一化 (Peri-Layer Normalization)(可选):当
use_post_norm=True时,在每个子层输出后应用额外的 RMSNorm。
此模型由 NAVER Cloud HyperCLOVA X 团队 贡献。原始模型可参考 naver-hyperclovax/HyperCLOVAX-SEED-Think-14B。
用法
该模型使用基于 ChatML 的格式,并带有特殊标记 <|im_start|>、<|im_end|>、<|endofturn|> 和 <|stop|>。apply_chat_template 方法接受以下参数:
force_reasoning=True— 在回答前始终进行思考skip_reasoning=True— 始终直接回答(非思考模式)- 默认 (
None) — 模型根据上下文自行决定
import torch
from transformers import AutoModelForCausalLM, AutoTokenizer
model_id = "naver-hyperclovax/HyperCLOVAX-SEED-Think-14B"
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(
model_id,
device_map="auto",
)
messages = [
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "What is the capital of South Korea?"},
]
# Pass force_reasoning=True to always think, or skip_reasoning=True to skip thinking.
model_inputs = tokenizer.apply_chat_template(
messages,
add_generation_prompt=True,
return_tensors="pt",
# force_reasoning=True,
# skip_reasoning=True,
).to(model.device)
output = model.generate(
**model_inputs,
tokenizer=tokenizer,
)
print(tokenizer.decode(output[0][model_inputs["input_ids"].shape[-1]:], skip_special_tokens=True))HyperCLOVAXConfig
class transformers.HyperCLOVAXConfig
< 源码 >( 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 = 32000 hidden_size: int = 4096 intermediate_size: int = 11008 num_hidden_layers: int = 32 num_attention_heads: int = 32 num_key_value_heads: int | None = None hidden_act: str = 'silu' max_position_embeddings: int = 2048 initializer_range: float = 0.02 rms_norm_eps: float = 1e-06 use_cache: bool = True pad_token_id: int | None = None bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None attention_bias: bool = False attention_dropout: float | int = 0.0 mlp_bias: bool = False embedding_multiplier: float | int = 1.0 logits_scaling: float | int = 1.0 residual_multiplier: float | int = 1.0 attention_multiplier: float | None = None head_dim: int | None = None use_post_norm: bool = True )
参数
- vocab_size (
int, 可选, 默认为32000) — 模型的词汇表大小。定义了input_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为4096) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为11008) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为32) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力 (Grouped Query Attention) 的键值头数量。如果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, 可选, 默认为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, 可选) — 词汇表中用于填充(padding)的标记 ID。 - bos_token_id (
int, 可选, 默认为1) — 词汇表中用于流开始(beginning-of-stream)的标记 ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词汇表中用于流结束(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) — 是否在自注意力机制中的查询(query)、键(key)、值(value)和输出投影层中使用偏置(bias)。 - attention_dropout (
Union[float, int], optional, defaults to0.0) — 注意力概率的丢弃(dropout)比例。 - mlp_bias (
bool, optional, defaults toFalse) — 是否在MLP层中的 up_proj、down_proj 和 gate_proj 层使用偏置(bias)。 - embedding_multiplier (
float, optional, defaults to1.0) — 应用于词嵌入(token embedding)输出的缩放因子。在 MuP 中用于控制嵌入激活的规模。 - logits_scaling (
float, optional, defaults to1.0) — 在计算损失或采样之前,乘于最终 logits 的缩放因子。在 MuP 中用于确保模型在不同规模下输出规模的一致性。注意:与 GraniteConfig 不同,这是一个乘数,而不是除数。 - residual_multiplier (
float, optional, defaults to1.0) — 在添加到残差流(residual stream)之前,应用于每个子层输出的缩放因子。在最大化更新参数化(Maximal Update Parametrization, MuP)中使用,以稳定不同模型规模下的训练。 - attention_multiplier (
float, optional, defaults tohead_dim ** -0.5) — 在 softmax 之前应用于注意力 logits 的缩放因子,取代了标准的1 / sqrt(head_dim)缩放。为基于 MuP 的训练显式设置;当为None时,默认为标准值。 - head_dim (
int, optional) — 注意力头的维度。如果为 None,则默认为 hidden_size // num_attention_heads。 - use_post_norm (
bool, optional, defaults toTrue) — 是否在每个子层输出后应用额外的 RMSNorm(层间归一化)。
这是用于存储 HyperCLOVAXModel 配置的配置类。它根据指定的参数实例化 Hyperclovax 模型,定义模型架构。使用默认值实例化配置将产生与 naver-hyperclovax/HyperCLOVAX-SEED-Think-14B 类似的配置。
配置对象继承自 PreTrainedConfig,可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
>>> from transformers import HyperCLOVAXModel, HyperCLOVAXConfig
>>> # Initializing a HyperCLOVAX style configuration
>>> configuration = HyperCLOVAXConfig()
>>> # Initializing a model from the configuration
>>> model = HyperCLOVAXModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config验证 hidden_size 是否可以被 num_attention_heads 整除。
HyperCLOVAXModel
class transformers.HyperCLOVAXModel
< 源代码 >( config: HyperCLOVAXConfig )
参数
- config (HyperCLOVAXConfig) — 具有所有模型参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
原始的 Hyperclovax 模型,输出原始隐藏状态,顶部没有任何特定的头部(head)。
该模型继承自 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] ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在词表中的索引。默认情况下将忽略填充(padding)。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选自[0, 1]:- 1 表示 未被掩码 的 token,
- 0 表示 被掩码 的 token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列中每个 token 的位置索引,用于位置嵌入。选自范围[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, optional) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常由模型在解码的先前阶段返回,且当use_cache=True或config.use_cache=True时使用。仅允许 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用
past_key_values,用户应仅输入形状为(batch_size, unprocessed_length)的未处理input_ids(即未提供过其 past key value 状态的input_ids),而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量,这会很有用。 - use_cache (
bool, optional) — 如果设置为True,则会返回past_key_values键值状态,并可用于加速解码(参见past_key_values)。
返回
BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 BaseModelOutputWithPast 或 torch.FloatTensor 的元组(如果传递了 return_dict=False 或 config.return_dict=False),根据配置(HyperCLOVAXConfig)和输入,包含各种元素。
HyperCLOVAXModel 的 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 后的注意力权重,用于计算自注意力头中的加权平均值。
HyperCLOVAXForCausalLM
class transformers.HyperCLOVAXForCausalLM
< 源代码 >( 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 (HyperCLOVAXForCausalLM) — 具有所有模型参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Hyperclovax 模型。
该模型继承自 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 logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在词表中的索引。默认情况下将忽略填充(padding)。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选自[0, 1]:- 1 表示 未被掩码 的 token,
- 0 表示 被掩码 的 token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列中每个 token 的位置索引,用于位置嵌入。选自范围[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, optional) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常由模型在解码的先前阶段返回,且当use_cache=True或config.use_cache=True时使用。仅允许 Cache 实例作为输入,请参阅我们的 kv 缓存指南。如果未传递
past_key_values,则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用
past_key_values,用户应仅输入形状为(batch_size, unprocessed_length)的未处理input_ids(即未提供过其 past key value 状态的input_ids),而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量,这会很有用。 - labels (
torch.LongTensor,形状为(batch_size, sequence_length),可选) — 用于计算掩码语言建模(masked language modeling)损失的标签。索引应在[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,必须是对应于要在序列长度维度上保留的索引的一维张量。这在使用打包张量格式(batch 和 sequence length 的单维度)时非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或 config.return_dict=False 时),根据配置(HyperCLOVAXConfig)和输入包含各种元素。
HyperCLOVAXForCausalLM 的 forward 方法,重写了 __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, HyperCLOVAXForCausalLM
>>> model = HyperCLOVAXForCausalLM.from_pretrained("naver-hyperclovax/HyperCLOVAX-SEED-Think-14B")
>>> tokenizer = AutoTokenizer.from_pretrained("naver-hyperclovax/HyperCLOVAX-SEED-Think-14B")
>>> 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? Are you okay?" The man was confused and answered, "Yes." Then the woman asked.