Transformers 文件
Nemotron
並獲得增強的文件體驗
開始使用
Nemotron
許可
此模型的使用受NVIDIA AI 基礎模型社群許可協議的約束。
描述
Nemotron-4 是一系列企業級生成文字模型，與NVIDIA NeMo 框架相容。
NVIDIA NeMo 是一個端到端、雲原生的平臺，用於在任何地方構建、定製和部署生成式 AI 模型。它包括訓練和推理框架、護欄工具包、資料整理工具和預訓練模型，為企業提供了一種簡單、經濟高效、快速的生成式 AI 採用方式。要訪問 NeMo 框架，請透過此連結註冊。
參考
模型架構
架構型別： Transformer
網路架構： Transformer 解碼器（自迴歸語言模型）。
Minitron
Minitron 4B Base
Minitron 是透過修剪 NVIDIA 的 Nemotron-4 15B 模型獲得的小型語言模型（SLM）家族。我們修剪了模型的嵌入大小、注意力頭和 MLP 中間維度，然後透過蒸餾進行持續訓練，從而得到最終模型。
與從頭開始訓練相比，使用我們的方法從基礎 15B 模型派生 Minitron 8B 和 4B 模型所需的每個模型的訓練令牌減少多達 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-shot 效能。 使用 Massive Multitask Language Understanding 評估語言理解
| 平均分 |
|---|
| 58.6 |
Zero-shot 效能。 使用 LM Evaluation Harness 中的部分資料集進行評估，並有額外補充
| 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 解碼器中每個注意力層的注意力頭數量。 - head_dim (
int, 可選) — 多頭注意力中的投影權重維度。如果為 None，則設定為 hidden_size // num_attention_heads。 - 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或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) — 是否繫結詞嵌入。 - rope_theta (
float, 可選, 預設為 10000.0) — RoPE 嵌入的基礎週期。 - partial_rotary_factor (
float, 可選, 預設為 0.5) — 將具有旋轉嵌入的查詢和鍵的百分比。 - attention_bias (
bool, 可選, 預設為False) — 在自注意力過程中，是否在查詢、鍵、值和輸出投影層中使用偏差。 - attention_dropout (
float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。 - 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 )
引數
- 配置 (NemotronConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
裸的 Nemotron 模型，輸出原始隱藏狀態，不帶任何特定頭部。
此模型繼承自 PreTrainedModel。有關庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等），請查閱其超類文件。
此模型也是 PyTorch torch.nn.Module 的子類。請將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件瞭解所有與一般用法和行為相關的事項。
前向傳播
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, list[torch.FloatTensor], NoneType] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 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 (
Union[~cache_utils.Cache, list[torch.FloatTensor], NoneType]) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
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（即沒有將過去鍵值狀態提供給此模型的那些），而不是形狀為(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。 - cache_position (
torch.LongTensor，形狀為(sequence_length)，可選) — 表示輸入序列標記在序列中的位置的索引。與position_ids不同，此張量不受填充影響。它用於在正確位置更新快取並推斷完整的序列長度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPast 或一個 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (NemotronConfig) 和輸入的不同元素。
-
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 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值，如果
config.is_encoder_decoder=True，則可選地包含交叉注意力塊中的鍵和值），可用於（參見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 後的注意力權重，用於計算自注意力頭中的加權平均值。
NemotronModel 的前向傳播方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但隨後應該呼叫 Module 例項而不是該函式，因為前者負責執行預處理和後處理步驟，而後者則會靜默忽略它們。
NemotronForCausalLM
前向傳播
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, list[torch.FloatTensor], NoneType] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **loss_kwargs ) → 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 (
Union[~cache_utils.Cache, list[torch.FloatTensor], NoneType]) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
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（即沒有將過去鍵值狀態提供給此模型的那些），而不是形狀為(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）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量中的hidden_states。 - 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 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithPast 或一個 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (NemotronConfig) 和輸入的不同元素。
-
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), 可選, 當傳入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 後的注意力權重，用於計算自注意力頭中的加權平均值。
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
< 源 >( 配置 )
引數
- 配置 (NemotronForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Nemotron 模型 Transformer，頂部帶有一個序列分類頭（線性層）。
NemotronForSequenceClassification 使用最後一個標記進行分類，與其他因果模型（如 GPT-2）一樣。
由於它對最後一個標記進行分類，因此需要知道最後一個標記的位置。如果在配置中定義了 pad_token_id，它會在每一行中找到不是填充標記的最後一個標記。如果沒有定義 pad_token_id，它只取批處理中每一行的最後一個值。由於當傳入 inputs_embeds 而不是 input_ids 時，它無法猜測填充標記，因此它會做同樣的操作（取批處理中每一行的最後一個值）。
此模型繼承自 PreTrainedModel。有關庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等），請查閱其超類文件。
此模型也是 PyTorch torch.nn.Module 的子類。請將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件瞭解所有與一般用法和行為相關的事項。
前向傳播
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 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 快取指南；
- 長度為
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（即沒有將過去鍵值狀態提供給此模型的那些），而不是形狀為(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,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]之間。如果config.num_labels == 1，則計算迴歸損失（均方損失）；如果config.num_labels > 1，則計算分類損失（交叉熵）。 - use_cache (
bool, 可選) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量中的hidden_states。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一個 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），其中包含根據配置 (NemotronConfig) 和輸入的不同元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
past_key_values (
Cache, 可選，當傳入use_cache=True或當config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
NemotronForSequenceClassification 的前向傳播方法，覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但隨後應該呼叫 Module 例項而不是該函式，因為前者負責執行預處理和後處理步驟，而後者則會靜默忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, NemotronForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> model = NemotronForSequenceClassification.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = NemotronForSequenceClassification.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, NemotronForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> model = NemotronForSequenceClassification.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = NemotronForSequenceClassification.from_pretrained(
... "nvidia/nemotron-3-8b-base-4k-hf", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossNemotronForQuestionAnswering
class transformers.NemotronForQuestionAnswering
< 源 >( 配置 )
引數
- 配置 (NemotronForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Nemotron transformer，頂部帶有一個用於提取式問答任務（如 SQuAD）的跨度分類頭（在隱藏狀態輸出之上的一層線性層，用於計算 span start logits 和 span end logits）。
此模型繼承自 PreTrainedModel。有關庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等），請查閱其超類文件。
此模型也是 PyTorch torch.nn.Module 的子類。請將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件瞭解所有與一般用法和行為相關的事項。
前向傳播
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 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 快取指南；
- 長度為
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（那些沒有將過去的鍵值狀態提供給此模型的），而不是形狀為(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可選) — 可選地，除了傳遞input_ids，您還可以選擇直接傳遞嵌入表示。如果您希望對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - start_positions (形狀為
(batch_size,)的torch.LongTensor，可選) — 用於計算標記分類損失的標記跨度起始位置（索引）的標籤。位置將被限制在序列的長度（sequence_length）內。序列外的位置不計入損失計算。 - end_positions (形狀為
(batch_size,)的torch.LongTensor，可選) — 用於計算標記分類損失的標記跨度結束位置（索引）的標籤。位置將被限制在序列的長度（sequence_length）內。序列外的位置不計入損失計算。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的hidden_states。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含根據配置（NemotronConfig）和輸入而定的各種元素。
-
loss (
torch.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
NemotronForQuestionAnswering 的 forward 方法，它覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但隨後應該呼叫 Module 例項而不是該函式，因為前者負責執行預處理和後處理步驟，而後者則會靜默忽略它們。
示例
>>> from transformers import AutoTokenizer, NemotronForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> model = NemotronForQuestionAnswering.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...NemotronForTokenClassification
class transformers.NemotronForTokenClassification
< source >( 配置 )
引數
- config (NemotronForTokenClassification) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Nemotron transformer，頂部帶有一個標記分類頭（隱藏狀態輸出頂部的一個線性層），例如用於命名實體識別（NER）任務。
此模型繼承自 PreTrainedModel。有關庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等），請查閱其超類文件。
此模型也是 PyTorch torch.nn.Module 的子類。請將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件瞭解所有與一般用法和行為相關的事項。
前向傳播
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 詞彙表中輸入序列 token 的索引。預設情況下，填充將被忽略。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor，可選) — 掩碼，用於避免對填充 token 索引執行注意力操作。掩碼值選擇範圍為[0, 1]：- 1 表示 未被掩蓋 的 token，
- 0 表示 被掩蓋 的 token。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼前期返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
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（那些沒有將過去的鍵值狀態提供給此模型的），而不是形狀為(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可選) — 可選地，除了傳遞input_ids，您還可以選擇直接傳遞嵌入表示。如果您希望對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - labels (形狀為
(batch_size,)的torch.LongTensor，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方誤差損失）；如果config.num_labels > 1，則計算分類損失（交叉熵損失）。 - use_cache (
bool, 可選) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加速解碼（請參見past_key_values）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的hidden_states。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含根據配置（NemotronConfig）和輸入而定的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
NemotronForTokenClassification 的 forward 方法，它覆蓋了 __call__ 特殊方法。
儘管前向傳播的實現需要在該函式中定義，但隨後應該呼叫 Module 例項而不是該函式，因為前者負責執行預處理和後處理步驟，而後者則會靜默忽略它們。
示例
>>> from transformers import AutoTokenizer, NemotronForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> model = NemotronForTokenClassification.from_pretrained("nvidia/nemotron-3-8b-base-4k-hf")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...