Nemotron
Nemotron
许可证
此模型的使用受 NVIDIA AI Foundation Models 社区许可协议 约束。
描述
Nemotron-4 是一个企业级就绪的生成式文本模型系列，与 NVIDIA NeMo 框架 兼容。
NVIDIA NeMo 是一个端到端的云原生平台，用于在任何地方构建、定制和部署生成式 AI 模型。它包括训练和推理框架、护栏工具包、数据整理工具和预训练模型，为企业提供了一种简单、经济高效且快速的方式来采用生成式 AI。要访问 NeMo 框架，请在 此链接 注册。
参考
模型架构
架构类型： Transformer
网络架构： Transformer 解码器（自回归语言模型）。
Minitron
Minitron 4B 基础
Minitron 是一个小型语言模型 (SLM) 系列，它是通过剪枝 NVIDIA 的 Nemotron-4 15B 模型获得的。我们剪枝模型嵌入大小、注意力头和 MLP 中间维度，然后进行蒸馏继续训练，以获得最终模型。
使用我们的方法从基础 15B 模型中推导出 Minitron 8B 和 4B 模型，与从头开始训练相比，每个模型所需的训练 token 减少了 40 倍；这导致训练整个模型系列（15B、8B 和 4B）的 计算成本节省了 1.8 倍。与从头开始训练相比，Minitron 模型在 MMLU 分数上最多提高了 16%，与 Mistral 7B、Gemma 7B 和 Llama-3 8B 等其他社区模型的表现相当，并且优于文献中最新压缩技术的性能。有关更多详细信息，请参阅我们的 arXiv 论文。
Minitron 模型仅用于研究和开发。
HuggingFace 快速入门
以下代码提供了一个示例，说明如何加载 Minitron-4B 模型并使用它进行文本生成。
import torch
from transformers import AutoTokenizer, AutoModelForCausalLM
# Load the tokenizer and model
model_path = 'nvidia/Minitron-4B-Base'
tokenizer = AutoTokenizer.from_pretrained(model_path)
device = 'cuda'
dtype = torch.bfloat16
model = AutoModelForCausalLM.from_pretrained(model_path, torch_dtype=dtype, device_map=device)
# Prepare the input text
prompt = 'Complete the paragraph: our solar system is'
inputs = tokenizer.encode(prompt, return_tensors='pt').to(model.device)
# Generate the output
outputs = model.generate(inputs, max_length=20)
# Decode and print the output
output_text = tokenizer.decode(outputs[0])
print(output_text)许可证
Minitron 在 NVIDIA 开放模型许可协议 下发布。
评估结果
5 次微调后的性能。 使用 大规模多任务语言理解 评估语言理解
| 平均 |
|---|
| 58.6 |
零次微调后的性能。 使用 LM 评估工具 中选定的数据集以及一些补充数据集进行评估
| HellaSwag | Winogrande | GSM8K | ARC-C | XLSum |
|---|---|---|---|---|
| 75.0 | 74.0 | 24.1 | 50.9 | 29.5 |
代码生成性能。使用 HumanEval 评估
| p@1，0-Shot |
|---|
| 23.3 |
请参阅我们的 论文 获取完整的结果集。
引用
如果您发现我们的工作有帮助，请考虑引用我们的论文
@article{minitron2024,
title={Compact Language Models via Pruning and Knowledge Distillation},
author={Saurav Muralidharan and Sharath Turuvekere Sreenivas and Raviraj Joshi and Marcin Chochowski and Mostofa Patwary and Mohammad Shoeybi and Bryan Catanzaro and Jan Kautz and Pavlo Molchanov},
journal={arXiv preprint arXiv:2407.14679},
year={2024},
url={https://arxiv.org/abs/2407.14679},
}NemotronConfig
class transformers.NemotronConfig
< 源代码 >( vocab_size = 256000 hidden_size = 6144 intermediate_size = 24576 num_hidden_layers = 32 num_attention_heads = 48 head_dim = None num_key_value_heads = None hidden_act = 'relu2' max_position_embeddings = 4096 initializer_range = 0.0134 norm_eps = 1e-05 use_cache = True pad_token_id = None bos_token_id = 2 eos_token_id = 3 tie_word_embeddings = False rope_theta = 10000.0 partial_rotary_factor = 0.5 attention_bias = False attention_dropout = 0.0 mlp_bias = False **kwargs )
参数
- vocab_size (
int, 可选，默认值为 256000) — Nemotron 模型的词汇量大小。定义了调用 NemotronModel 时传递的inputs_ids可以表示的不同令牌数。 - hidden_size (
int, 可选，默认值为 6144) — 隐藏表示的维度。 - intermediate_size (
int, 可选，默认值为 24576) — MLP 表示的维度。 - num_hidden_layers (
int, 可选，默认值为 32) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, 可选，默认值为 48) — Transformer 解码器中每个注意力层的注意力头数。 - hidden_act (
str或function, 可选, 默认值为"relu2") — 解码器中的非线性激活函数 (函数或字符串)。 - max_position_embeddings (
int, 可选, 默认值为 4096) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认值为 0.0134) — 初始化所有权重矩阵的截断正态初始化的标准差。 - norm_eps (
float, 可选, 默认值为 1e-05) — 规范化层使用的 epsilon。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应该返回最后键/值注意力 (并非所有模型都使用)。仅在config.is_decoder=True时相关。 - pad_token_id (
int, 可选) — 填充标记 ID。 - bos_token_id (
int, 可选, 默认值为 2) — 流的开始标记 ID。 - eos_token_id (
int, 可选, 默认值为 3) — 流的结束标记 ID。 - tie_word_embeddings (
bool, 可选, 默认值为False) — 是否绑定权重嵌入。 - attention_bias (
bool, 可选, 默认为False) — 是否在自注意力过程中使用查询、键、值和输出投影层中的偏差。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的丢弃率。 - mlp_bias (
bool, 可选, 默认为False) — 是否在 MLP 层中的 up_proj 和 down_proj 层使用偏差。
这是一个配置类，用于存储 NemotronModel 的配置。它用于根据指定的参数实例化 Nemotron 模型，定义模型架构。使用默认值实例化配置将产生与 Nemotron-8B 相似的配置。例如 nvidia/nemotron-3-8b-base-4k-hf。配置对象继承自 PretrainedConfig 并且可以用来控制模型输出。阅读来自 PretrainedConfig 的文档以获取更多信息。
>>> from transformers import NemotronModel, NemotronConfig
>>> # Initializing a Nemotron nemotron-15b style configuration
>>> configuration = NemotronConfig()
>>> # Initializing a model from the nemotron-15b style configuration
>>> model = NemotronModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configNemotronModel
class transformers.NemotronModel
< 源代码 >( config: NemotronConfig )
参数
- config (NemotronConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。config — NemotronConfig
不带任何特定头的基本 Nemotron 模型，输出原始隐藏状态。此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
包含 config.num_hidden_layers 个层的 Transformer 解码器。每个层都是一个 NemotronDecoderLayer
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None )
参数
- 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 表示掩盖的标记。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
如果使用
past_key_values，则可以选择仅输入最后一个input_ids（参见past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需求进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示头部未掩盖，
- 0 表示头部掩盖。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为旧缓存格式。
模型将输出与输入相同的缓存格式。如果未传递
past_key_values，则将返回旧缓存格式。如果使用
past_key_values，则用户可以选择仅输入最后一个input_ids（形状为(batch_size, 1)）而不是所有input_ids（形状为(batch_size, sequence_length)），这些input_ids没有提供给该模型的过去键值状态。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想更控制如何将input_ids索引转换为关联的向量（而不是模型的内部嵌入查找矩阵），这很有用。 - use_cache (
bool，可选) — 如果设置为True，则将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor形状为(sequence_length)，可选) — 指示输入序列 token 在序列中的位置的索引。与position_ids相反，该张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
NemotronModel 的前向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的步骤需要在此函数内定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
NemotronForCausalLM
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None ) → transformers.modeling_outputs.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。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用了
past_key_values，则可以选择只输入最后一个input_ids（参见past_key_values）。如果你想改变填充行为，你应该阅读
modeling_opt._prepare_decoder_attention_mask并根据你的需求进行修改。有关默认策略的更多信息，请参阅 论文 中的图表 1。- 1 代表注意力头未被掩码，
- 0 代表注意力头被掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列中每个 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。 这通常由模型在解码的先前阶段返回的past_key_values组成，此时use_cache=True或config.use_cache=True。允许两种格式：
- 一个 Cache 实例；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。 这也被称为传统的缓存格式。
模型将输出与作为输入馈送的相同的缓存格式。 如果没有传递
past_key_values，将返回传统的缓存格式。如果使用
past_key_values，用户可以选择仅输入最后一个input_ids（那些没有将其过去键值状态提供给此模型的）形状为(batch_size, 1)，而不是所有input_ids形状为(batch_size, sequence_length)。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想对如何将input_ids索引转换为关联向量（比模型的内部嵌入查找矩阵更详细）进行更多控制，这将很有用。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor, 可选) — 指示输入序列标记在序列中的位置的索引。 与position_ids相反，此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。参数 — labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选): 用于计算掩码语言建模损失的标签。 索引应为[0, ..., config.vocab_size]或 -100（参见input_ids文档字符串）。 索引设置为-100的标记将被忽略（掩码），损失仅针对[0, ..., config.vocab_size]中的标签标记进行计算。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或 config.return_dict=False），包括取决于配置的各种元素（NemotronConfig）和输入。
-
loss (形状为
(1,)的torch.FloatTensor, 可选，在提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。包含预先计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型有嵌入层，以及一个用于每层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The NemotronForCausalLM 前向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的步骤需要在此函数内定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, NemotronForCausalLM
>>> model = NemotronForCausalLM.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> 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."NemotronForSequenceClassification
class transformers.NemotronForSequenceClassification
< source >( config )
参数
- config (NemotronConfig) — 模型配置类，包含模型的所有参数。 用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有序列分类头的 Nemotron 模型转换器（线性层）。
NemotronForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。 如果在配置中定义了 pad_token_id，它会找到每一行中不是填充 token 的最后一个 token。 如果没有定义 pad_token_id，它只会取批处理中每一行的最后一个值。 由于它无法在传递 inputs_embeds 而不是 input_ids 时猜测填充 token，因此它执行相同的操作（取批处理中每一行的最后一个值）。
此模型继承自 PreTrainedModel。 检查超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 输入序列 token 在词汇表中的索引。 默认情况下，如果您提供填充，则会忽略填充。索引可以通过 AutoTokenizer 获取。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示未掩码的 token，
- 0 表示掩码的 token。
索引可以通过 AutoTokenizer 获取。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
如果使用
past_key_values，则可以选择仅输入最后一个input_ids（参见past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并修改为您的需求。 查看 论文 中的图 1，以了解更多关于默认策略的信息。- 1 表示头未掩码，
- 0 表示头掩码。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在位置嵌入中的位置索引。 在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。 这通常包括模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例;
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。 这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。 如果没有传递
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其过去键值状态传递给此模型的input_ids），而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想比模型的内部嵌入查找矩阵更细致地控制如何将input_ids索引转换为相关向量，这将非常有用。 - use_cache (
bool, 可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor, 可选) — 表示输入序列标记在序列中位置的索引。 与position_ids相反，此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (形状为
(batch_size,)的torch.LongTensor, 可选) — 用于计算序列分类/回归损失的标签。 索引应在[0, ..., config.num_labels - 1]中。 如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
The NemotronForSequenceClassification forward method, overrides the __call__ special method.
虽然前向传递的步骤需要在此函数内定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
NemotronForQuestionAnswering
Nemotron 模型转换器，顶部带有一个跨度分类头，用于提取式问答任务，例如 SQuAD（隐藏状态输出顶部的线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。 检查超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- 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 表示屏蔽的标记
可以使用 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
如果使用了
past_key_values，可以选择只输入最后一个input_ids（那些没有提供其过去键值状态的输入，形状为(batch_size, 1)），而不是所有形状为(batch_size, sequence_length)的input_ids。如果你想更改填充行为，你应该阅读
modeling_opt._prepare_decoder_attention_mask并根据你的需要修改。 查看 论文 中的图表 1，了解有关默认策略的更多信息。- 1 表示头未屏蔽
- 0 表示头屏蔽
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 输入序列每个标记在位置嵌入中的位置索引。 在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。 这通常包含模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。 这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。 如果没有传递
past_key_values，将返回传统缓存格式。如果使用了
past_key_values，用户可以选择只输入最后一个input_ids（那些没有提供其过去键值状态的输入，形状为(batch_size, 1)），而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。 如果你想要对如何将input_ids索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将很有用。 - use_cache (
bool, 可选) — 如果设置为True，则会返回past_key_values键值状态，并且可以用来加速解码 (参见past_key_values)。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor形状为(sequence_length), 可选) — 表示输入序列令牌在序列中的位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - start_positions (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算令牌分类损失的标记跨度的开始位置 (索引) 的标签。位置被限制在序列的长度 (sequence_length) 内。序列外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算令牌分类损失的标记跨度的结束位置 (索引) 的标签。位置被限制在序列的长度 (sequence_length) 内。序列外的位置不会被考虑用于计算损失。
The NemotronForQuestionAnswering forward method, overrides the __call__ special method.
虽然前向传递的步骤需要在此函数内定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
NemotronForTokenClassification
class transformers.NemotronForTokenClassification
< 源代码 >( config )
参数
- config (NemotronConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
The Nemotron Model transformer with a token classification head on top (a linear layer on top of the hidden-states output) e.g. for Named-Entity-Recognition (NER) tasks.
此模型继承自 PreTrainedModel。 检查超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- 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 表示掩码的标记。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个input_ids（其过去键值状态未提供给此模型）的形状为(batch_size, 1)，而不是所有input_ids的形状为(batch_size, sequence_length)。如果您想更改填充行为，则应阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示头部未掩码，
- 0 表示头部掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加快顺序解码速度。这通常包括模型在解码先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组都有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也被称为传统缓存格式。
模型将输出与输入相同格式的缓存。如果没有传递
past_key_values，将返回传统缓存格式。如果使用
past_key_values，用户可以选择仅输入最后一个input_ids（其过去键值状态未提供给此模型）的形状为(batch_size, 1)，而不是所有input_ids的形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要比模型的内部嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这将很有用。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加快解码速度（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - cache_position (
torch.LongTensor形状为(sequence_length), 可选) — 表示输入序列标记在序列中的位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
The NemotronForTokenClassification forward method, overrides the __call__ special method.
虽然前向传递的步骤需要在此函数内定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。