Transformers 文档
NanoChat
并获得增强的文档体验
开始使用
该模型于 {release_date} 发布，并于 2025-11-27 添加到 Hugging Face Transformers。
NanoChat
NanoChat 是一个紧凑的仅解码器 transformer 模型，旨在用于教育目的和高效训练。该模型具有现代 transformer 模型中常见的几项基本架构创新。因此，它是一个很好的模型，可以作为理解现代 transformer 模型原理的起点。NanoChat 是 Llama 架构的一个变体，具有简化的注意力机制和归一化层。
该架构基于 Andrej Karpathy 的 nanochat，并由 Ben Burtenshaw 适配到 Hugging Face Transformers 库。
此模型由 Hugging Face 团队贡献。
下面的示例演示了如何使用 NanoChat 通过聊天模板进行文本生成。
import torch
from transformers import pipeline
chatbot = pipeline(
task="text-generation",
model="karpathy/nanochat-d32",
dtype=torch.bfloat16,
device=0
)
conversation = [
{"role": "user", "content": "What is the capital of France?"},
]
outputs = chatbot(conversation, max_new_tokens=64)
print(outputs[0]["generated_text"][-1]["content"])NanoChatConfig
class transformers.NanoChatConfig
< source >( vocab_size: int = 50304 hidden_size: int = 768 intermediate_size: int | None = 8192 num_hidden_layers: int = 12 num_attention_heads: int = 6 num_key_value_heads: int | None = None max_position_embeddings: int = 2048 hidden_act: str = 'relu2' attention_dropout: float = 0.0 rms_norm_eps: float = 1e-06 initializer_range: float = 0.02 rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None use_cache: bool = True final_logit_softcapping: float | None = 15.0 attention_bias: bool = False bos_token_id: int = 0 eos_token_id: int = 1 pad_token_id: int = 1 tie_word_embeddings: bool = False **kwargs )
参数
- vocab_size (
int, optional, defaults to 50304) — NanoChat 模型词汇表大小。定义了在调用 NanoChatModel 时传递的inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, optional, defaults to 768) — 隐藏表示的维度。 - intermediate_size (
int, optional, defaults to 8192) — MLP 表示的维度。如果为None，则将根据模型架构进行计算。 - num_hidden_layers (
int, optional, defaults to 12) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, optional, defaults to 6) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, optional) — 这是用于实现分组查询注意力（Grouped Query Attention）的关键值头数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（MHA），如果num_key_value_heads=1，模型将使用多查询注意力（MQA），否则使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组的关键和值头应通过对该组内的所有原始头进行平均池化来构建。更多细节请参阅 这篇论文。如果未指定，则默认为num_attention_heads。 - max_position_embeddings (
int, optional, defaults to 2048) — 该模型可能使用的最大序列长度。 - hidden_act (
strorfunction, optional, defaults to"relu2") — 解码器中的非线性激活函数（函数或字符串）。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力概率的 dropout 率。 - rms_norm_eps (
float, optional, defaults to 1e-06) — rms 归一化层使用的 epsilon。 - initializer_range (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rope_parameters (
RopeParameters, optional) — 包含 RoPE 嵌入配置参数的字典。字典应包含rope_theta的值，并且如果您想在更长的max_position_embeddings中使用 RoPE 进行缩放，则可以选择包含用于缩放的参数。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - final_logit_softcapping (
float, optional, defaults to 15.0) — 应用 tanh softcapping 到 logits 时的缩放因子。 - attention_bias (
bool, optional, defaults toFalse) — 是否在自注意力期间使用查询、键和值投影层中的偏差。 - bos_token_id (
int, optional, defaults to 0) — 序列开始 token ID。 - eos_token_id (
int, optional, defaults to 1) — 序列结束 token ID。 - pad_token_id (
int, optional, defaults to 1) — 填充 token ID。 - tie_word_embeddings (
bool, optional, defaults toFalse) — 是否绑定词嵌入
这是配置类，用于存储 NanoChatModel 的配置。它用于根据指定的参数实例化 NanoChat 模型，定义模型架构。使用默认值实例化配置将产生与 karpathy/nanochat-d32 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PreTrainedConfig 的文档。
>>> from transformers import NanoChatModel, NanoChatConfig
>>> # Initializing a NanoChat style configuration
>>> configuration = NanoChatConfig()
>>> # Initializing a model from the NanoChat style configuration
>>> model = NanoChatModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configNanoChatModel
class transformers.NanoChatModel
< source >( config: NanoChatConfig )
参数
- config (NanoChatConfig) — 包含模型所有参数的模型配置类。使用 config 文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸露的 Nanochat 模型输出原始隐藏状态，没有任何顶部的特定头。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( 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 cache_position: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 词汇表中的输入序列 token 的索引。默认情况下将忽略填充。可以使用 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（那些未将过去键值状态提供给此模型的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索引转换为相关向量有更多的控制，则这很有用。 - cache_position (
torch.LongTensor, 形状为(sequence_length), 可选) — 指示输入序列标记在序列中的位置的索引。与position_ids相反，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回
transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含根据配置（NanoChatConfig）和输入而异的各种元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。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 后的注意力权重，用于计算自注意力头中的加权平均值。
NanoChatModel 的前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
NanoChatForCausalLM
class transformers.NanoChatForCausalLM
< 源码 >( 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 (NanoChatForCausalLM) — 模型配置类，包含模型的所有参数。使用 config 文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Nanochat 模型。
此模型继承自 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 cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列标记的索引。默认忽略填充。可以使用 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（那些未将过去键值状态提供给此模型的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）。 - cache_position (
torch.LongTensor, 形状为(sequence_length), 可选) — 指示输入序列标记在序列中的位置的索引。与position_ids相反，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 可选, 默认为0) — 如果是int，则计算最后logits_to_keep个标记的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成时只需要最后一个标记的 logits，仅为此标记计算 logits 可以节省内存，这在序列很长或词汇表很大时非常重要。如果是torch.Tensor，则必须是 1D 且对应于序列长度维度中要保留的索引。当使用打包张量格式（批次和序列长度的单个维度）时，这很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含根据配置（NanoChatConfig）和输入而异的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
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 后的注意力权重，用于计算自注意力头中的加权平均值。
NanoChatForCausalLM 的前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, AutoModelForCausalLM
>>> model = AutoModelForCausalLM.from_pretrained("karpathy/nanochat-d32")
>>> tokenizer = AutoTokenizer.from_pretrained("karpathy/nanochat-d32")
>>> conversation = [
{"role": "user", "content": "What is the capital of France?"},
]
>>> inputs = tokenizer.apply_chat_template(
conversation, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt"
).to(device)
>>> with torch.no_grad():
>>> outputs = model.generate(**inputs, max_new_tokens=64, do_sample=False)
>>> generated_tokens = outputs[0, inputs["input_ids"].shape[1] :]
>>> output = tokenizer.decode(generated_tokens, skip_special_tokens=True)