Transformers 文件
GPT-NeoX
並獲得增強的文件體驗
開始使用
GPT-NeoX
概述
我們介紹了 GPT-NeoX-20B，這是一個在 Pile 上訓練的 200 億引數自迴歸語言模型，其權重將透過寬鬆許可證免費向公眾開放。據我們所知，在提交時，它是最大規模的、權重公開可用的密集型自迴歸模型。在這項工作中，我們描述了 GPT-NeoX-20B 的架構和訓練，並在一系列語言理解、數學和基於知識的任務上評估了其效能。我們發現 GPT-NeoX-20B 是一個特別強大的少樣本推理器，在五樣本評估時，其效能增益遠超同等規模的 GPT-3 和 FairSeq 模型。我們在 https://github.com/EleutherAI/gpt-neox 上開源了訓練和評估程式碼以及模型權重。
該模型的開發由 Sid Black、Stella Biderman 和 Eric Hallahan 領導，並得到了 CoreWeave 的慷慨支援。
GPT-NeoX-20B 使用 fp16 進行訓練，因此建議按如下方式初始化模型
model = GPTNeoXForCausalLM.from_pretrained("EleutherAI/gpt-neox-20b").half().cuda()GPT-NeoX-20B 的分詞器也與 GPT-J-6B 和 GPT-Neo 中使用的不同。新的分詞器為空白字元分配了額外的詞元，使模型更適合某些任務，如程式碼生成。
用法示例
可以使用 `generate()` 方法來使用 GPT Neo 模型生成文字。
>>> from transformers import GPTNeoXForCausalLM, GPTNeoXTokenizerFast
>>> model = GPTNeoXForCausalLM.from_pretrained("EleutherAI/gpt-neox-20b")
>>> tokenizer = GPTNeoXTokenizerFast.from_pretrained("EleutherAI/gpt-neox-20b")
>>> prompt = "GPTNeoX20B is a 20B-parameter autoregressive Transformer model developed by EleutherAI."
>>> input_ids = tokenizer(prompt, return_tensors="pt").input_ids
>>> gen_tokens = model.generate(
... input_ids,
... do_sample=True,
... temperature=0.9,
... max_length=100,
... )
>>> gen_text = tokenizer.batch_decode(gen_tokens)[0]使用 Flash Attention 2
Flash Attention 2 是一個更快、更最佳化的模型版本。
安裝
首先，檢查您的硬體是否與 Flash Attention 2 相容。最新的相容硬體列表可以在官方文件中找到。如果您的硬體與 Flash Attention 2 不相容，您仍然可以透過上面提到的 Better Transformer 支援來受益於注意力核最佳化。
接下來，安裝 最新版本的 Flash Attention 2
pip install -U flash-attn --no-build-isolation
用法
要使用 Flash Attention 2 載入模型，我們可以將引數 `attn_implementation="flash_attention_2"` 傳遞給 `.from_pretrained`。我們還將以半精度（例如 `torch.float16`）載入模型，因為它幾乎不會降低音訊質量，但能顯著降低記憶體使用並加快推理速度。
>>> from transformers import GPTNeoXForCausalLM, GPTNeoXTokenizerFast
model = GPTNeoXForCausalLM.from_pretrained("EleutherAI/gpt-neox-20b", torch_dtype=torch.float16, attn_implementation="flash_attention_2").to(device)
...預期加速
以下是一個預期加速圖，比較了使用 `stockmark/gpt-neox-japanese-1.4b` checkpoint 的原生 transformers 實現與 Flash Attention 2 版本的模型在序列長度為 2048 時的純推理時間。
使用縮放點積注意力 (SDPA)
PyTorch 在 `torch.nn.functional` 中包含了一個原生的縮放點積注意力（SDPA）運算元。該函式包含多種實現，可根據輸入和所用硬體進行應用。更多資訊請參見官方文件或GPU 推理頁面。
當實現可用時，SDPA 預設用於 `torch>=2.1.1`，但你也可以在 `from_pretrained()` 中設定 `attn_implementation="sdpa"` 來明確請求使用 SDPA。
from transformers import GPTNeoXForCausalLM
model = GPTNeoXForCausalLM.from_pretrained("EleutherAI/gpt-neox-20b", torch_dtype=torch.float16, attn_implementation="sdpa")
...為了獲得最佳加速效果，我們建議以半精度（例如 `torch.float16` 或 `torch.bfloat16`）載入模型。
在本地基準測試（rtx3080ti-16GB, PyTorch 2.2.1, OS Ubuntu 22.04）中使用 `float16` 和 pythia-410m-deduped，我們在訓練和推理期間觀察到以下加速。
訓練
| 批次大小 | 序列長度 | 每批處理時間（Eager - 秒） | 每批處理時間（SDPA - 秒） | 加速（%） | Eager 峰值記憶體（MB） | SDPA 峰值記憶體（MB） | 記憶體節省（%） |
|---|---|---|---|---|---|---|---|
| 1 | 128 | 0.024 | 0.019 | 28.945 | 1789.95 | 1789.95 | 0 |
| 1 | 256 | 0.039 | 0.031 | 23.18 | 1845.83 | 1844.84 | 0.053 |
| 1 | 512 | 0.08 | 0.055 | 45.524 | 2278.38 | 1953.76 | 16.615 |
| 1 | 1024 | 0.19 | 0.102 | 86.777 | 4772.36 | 2408.35 | 98.159 |
| 1 | 2048 | 0.565 | 0.204 | 177.098 | 13484.1 | 3882.01 | 247.348 |
| 2 | 128 | 0.037 | 0.032 | 15.121 | 1843.86 | 1844.78 | -0.05 |
| 2 | 256 | 0.067 | 0.055 | 21.706 | 1999.72 | 1951.67 | 2.462 |
| 2 | 512 | 0.144 | 0.096 | 50.046 | 3613.16 | 2406.77 | 50.125 |
| 2 | 1024 | 0.366 | 0.193 | 89.666 | 8707.55 | 3878.86 | 124.487 |
| 2 | 2048 | OOM（記憶體不足） | 0.379 | / | OOM（記憶體不足） | 6825.13 | SDPA 不會 OOM |
| 4 | 128 | 0.06 | 0.054 | 11.539 | 1947.6 | 1952.06 | -0.228 |
| 4 | 256 | 0.119 | 0.093 | 28.072 | 3008.39 | 2405.99 | 25.038 |
| 4 | 512 | 0.275 | 0.187 | 47.145 | 6290.58 | 3877.29 | 62.242 |
| 4 | 1024 | OOM（記憶體不足） | 0.36 | / | OOM（記憶體不足） | 6821.98 | SDPA 不會 OOM |
| 4 | 2048 | OOM（記憶體不足） | 0.731 | / | OOM（記憶體不足） | 12705.1 | SDPA 不會 OOM |
推理
| 批次大小 | 序列長度 | 每個詞元的延遲 Eager (ms) | 每個詞元的延遲 SDPA (ms) | 加速（%） | 記憶體 Eager (MB) | 記憶體 SDPA (MB) | 記憶體節省 (%) |
|---|---|---|---|---|---|---|---|
| 1 | 128 | 6.569 | 5.858 | 12.14 | 974.831 | 974.826 | 0 |
| 1 | 256 | 7.009 | 5.863 | 19.542 | 1029.01 | 1028.08 | 0.09 |
| 1 | 512 | 7.157 | 5.965 | 19.983 | 1137.54 | 1137.52 | 0.001 |
| 1 | 1024 | 7.523 | 6.506 | 15.637 | 1329.3 | 1329.26 | 0.003 |
| 1 | 2048 | 9.271 | 9.205 | 0.713 | 1752.47 | 1734.51 | 1.036 |
| 2 | 128 | 7.239 | 5.959 | 21.493 | 1044.8 | 1028.37 | 1.597 |
| 2 | 256 | 7.228 | 6.036 | 19.757 | 1167.32 | 1137.73 | 2.601 |
| 2 | 512 | 7.538 | 6.693 | 12.628 | 1352.93 | 1329.55 | 1.758 |
| 2 | 1024 | 8.916 | 8.632 | 3.291 | 1752.56 | 1734.62 | 1.034 |
| 2 | 2048 | 12.628 | 12.606 | 0.181 | 2558.72 | 2545.8 | 0.508 |
| 4 | 128 | 7.278 | 6.046 | 20.373 | 1168.41 | 1137.79 | 2.691 |
| 4 | 256 | 7.614 | 6.588 | 15.574 | 1353.1 | 1329.79 | 1.753 |
| 4 | 512 | 8.798 | 8.144 | 8.028 | 1752.76 | 1734.85 | 1.032 |
| 4 | 1024 | 11.765 | 11.303 | 4.09 | 2558.96 | 2546.04 | 0.508 |
| 4 | 2048 | 19.568 | 17.735 | 10.33 | 4175.5 | 4165.26 | 0.246 |
資源
GPTNeoXConfig
class transformers.GPTNeoXConfig
< 來源 >( vocab_size = 50432 hidden_size = 6144 num_hidden_layers = 44 num_attention_heads = 64 intermediate_size = 24576 hidden_act = 'gelu' rotary_pct = 0.25 rotary_emb_base = 10000 attention_dropout = 0.0 hidden_dropout = 0.0 classifier_dropout = 0.1 max_position_embeddings = 2048 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True bos_token_id = 0 eos_token_id = 2 tie_word_embeddings = False use_parallel_residual = True rope_scaling = None attention_bias = True **kwargs )
引數
- vocab_size (
int, 可選, 預設為 50432) — GPTNeoX 模型的詞彙表大小。定義了呼叫 GPTNeoXModel 時傳遞的 `inputs_ids` 可以表示的不同詞元的數量。 - hidden_size (
int, 可選, 預設為 6144) — 編碼器層和池化層的維度。 - num_hidden_layers (
int, 可選, 預設為 44) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 64) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int, 可選, 預設為 24576) — Transformer 編碼器中“中間”（即前饋）層的維度。 - hidden_act (
str或 `function`, 可選, 預設為 `"gelu"`) — 編碼器和池化層中的非線性啟用函式（函式或字串）。如果是字串，支援 `"gelu"`、`"relu"`、`"selu"` 和 `"gelu_new"`。 - rotary_pct (`float`, *可選*, 預設為 0.25) — 分配給旋轉嵌入的隱藏維度百分比。
- rotary_emb_base (`int`, *可選*, 預設為 10000) — 用於計算旋轉嵌入頻率的基數。
- attention_dropout (`float`, *可選*, 預設為 0.0) — 注意力分數的丟棄率機率。
- hidden_dropout (`float`, *可選*, 預設為 0.0) — (1) 詞嵌入、(2) 注意力後隱藏狀態和 (3) mlp 後隱藏狀態的丟棄率。
- classifier_dropout (`float`, *可選*, 預設為 0.1) — 在進行詞元分類時使用的引數，用於模型 GPTNeoXForTokenClassification。
隱藏層的丟棄率。
- max_position_embeddings (
int, 可選, 預設為 2048) — 該模型可能使用的最大序列長度。通常將其設定為較大的值以備不時之需（例如，512、1024 或 2048）。 - initializer_range (`float`, *可選*, 預設為 1e-5) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。
- layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - use_cache (
bool, 可選, 預設為 `True`) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅當 `config.is_decoder=True` 時相關。 - use_parallel_residual (
bool, 可選, 預設為 `True`) — 是否在每個 Transformer 層中使用“並行”公式，這可以在大規模（例如 20B）訓練時提供輕微的速度提升。 - rope_scaling (
Dict, *可選*) — 包含 RoPE 嵌入縮放配置的字典。注意：如果您應用了新的 rope 型別，並期望模型能在更長的 `max_position_embeddings` 上工作，我們建議您相應地更新此值。預期內容：`rope_type` (str)：要使用的 RoPE 子變體。可以是 [‘default’, ‘linear’, ‘dynamic’, ‘yarn’, ‘longrope’, ‘llama3’] 之一，其中 ‘default’ 是原始的 RoPE 實現。`factor` (float, *可選*)：與除 ‘default’ 外的所有 rope 型別一起使用。應用於 RoPE 嵌入的縮放因子。在大多數縮放型別中，`factor` 為 x 將使模型能夠處理長度為 x * 原始最大預訓練長度的序列。`original_max_position_embeddings` (int, *可選*)：與 ‘dynamic’、‘longrope’ 和 ‘llama3’ 一起使用。預訓練期間使用的原始最大位置嵌入。`attention_factor` (float, *可選*)：與 ‘yarn’ 和 ‘longrope’ 一起使用。應用於注意力計算的縮放因子。如果未指定，則預設為實現推薦的值，並使用 `factor` 欄位推斷建議值。`beta_fast` (float, *可選*)：僅與 ‘yarn’ 一起使用。用於設定線性斜坡函式中外推（僅）邊界的引數。如果未指定，則預設為 32。`beta_slow` (float, *可選*)：僅與 ‘yarn’ 一起使用。用於設定線性斜坡函式中插值（僅）邊界的引數。如果未指定，則預設為 1。`short_factor` (list[float], *可選*)：僅與 ‘longrope’ 一起使用。應用於短上下文（< `original_max_position_embeddings`）的縮放因子。必須是與隱藏大小除以注意力頭數再除以 2 相同長度的數字列表。`long_factor` (list[float], *可選*)：僅與 ‘longrope’ 一起使用。應用於長上下文（> `original_max_position_embeddings`）的縮放因子。必須是與隱藏大小除以注意力頭數再除以 2 相同長度的數字列表。`low_freq_factor` (float, *可選*)：僅與 ‘llama3’ 一起使用。應用於 RoPE 低頻分量的縮放因子。`high_freq_factor` (float, *可選*)：僅與 ‘llama3’ 一起使用。應用於 RoPE 高頻分量的縮放因子。 - attention_bias (
bool, 可選, 預設為True) — 在自注意力機制中，是否在查詢、鍵、值和輸出投影層中使用偏置。 - 示例 —
這是一個用於儲存 GPTNeoXModel 配置的配置類。它用於根據指定的引數例項化一個 GPTNeoX 模型，定義模型架構。使用預設值例項化配置將產生與 GPTNeoX EleutherAI/gpt-neox-20b 架構類似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。
>>> from transformers import GPTNeoXConfig, GPTNeoXModel
>>> # Initializing a GPTNeoX gpt-neox-20b style configuration
>>> configuration = GPTNeoXConfig()
>>> # Initializing a model (with random weights) from the gpt-neox-20b style configuration
>>> model = GPTNeoXModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGPTNeoXTokenizerFast
class transformers.GPTNeoXTokenizerFast
< 來源 >( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' pad_token = None add_bos_token = False add_eos_token = False add_prefix_space = False **kwargs )
引數
- vocab_file (
str) — 詞彙表文件的路徑。 - merges_file (
str) — 合併檔案的路徑。 - errors (
str, 可選, 預設為"replace") — 將位元組解碼為 UTF-8 時遵循的正規化。有關更多資訊，請參閱 bytes.decode。 - unk_token (
str, 可選, 預設為<|endoftext|>) — 未知詞元。不在詞彙表中的詞元無法轉換為 ID，將被設定為此詞元。 - bos_token (
str, 可選, 預設為<|endoftext|>) — 序列開始詞元。 - eos_token (
str, 可選, 預設為<|endoftext|>) — 序列結束詞元。 - pad_token (
str, 可選) — 用於填充序列的詞元。 - add_prefix_space (
bool, 可選, 預設為False) — 是否在輸入前新增一個初始空格。這允許將開頭的單詞像其他單詞一樣處理。（GPTNeoX 分詞器透過前面的空格來檢測單詞的開頭）。 - add_bos_token (
bool, 可選, 預設為False) — 是否在序列開頭新增一個bos_token。 - add_eos_token (
bool, 可選, 預設為False) — 是否在序列末尾新增一個eos_token。 - trim_offsets (
bool, 可選, 預設為True) — 後處理步驟是否應修剪偏移量以避免包含空格。
構建一個“快速”的 GPT-NeoX-20B 分詞器（由 HuggingFace 的 tokenizers 庫支援）。基於位元組級的位元組對編碼（Byte-Pair-Encoding）。
這個分詞器經過訓練，將空格視為詞元的一部分（有點像 sentencepiece），所以一個詞會
無論是否在句子開頭（無空格），編碼方式都會不同
>>> from transformers import GPTNeoXTokenizerFast
>>> tokenizer = GPTNeoXTokenizerFast.from_pretrained("openai-community/gpt2")
>>> tokenizer("Hello world")["input_ids"]
[15496, 995]
>>> tokenizer(" Hello world")["input_ids"]
[18435, 995]您可以透過在例項化此分詞器時傳遞 add_prefix_space=True 來繞過此行為，但由於模型並非以此方式進行預訓練，這可能會導致效能下降。
當與 is_split_into_words=True 一起使用時，此分詞器需要以 add_prefix_space=True 進行例項化。
此分詞器繼承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
get_special_tokens_mask
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → list[int]
從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。
使用當前的 bos_token 和 eos_token 更新底層後處理器。
GPTNeoXModel
class transformers.GPTNeoXModel
< 來源 >( config )
引數
- config (GPTNeoXModel) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
基礎的 Gpt Neox 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭。
該模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 來源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = 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 **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列詞元的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭被掩碼。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為相關向量，這會很有用。 - 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`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的 `input_ids`），形狀為 `(batch_size, 1)`，而不是所有 `input_ids` 的形狀 `(batch_size, sequence_length)`。
- 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`），根據配置（GPTNeoXConfig）和輸入，包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
GPTNeoXModel 的前向方法會覆蓋 `__call__` 特殊方法。
儘管前向傳遞的邏輯需要在此函式中定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會默默地忽略它們。
GPTNeoXForCausalLM
class transformers.GPTNeoXForCausalLM
< 來源 >( config )
引數
- config (GPTNeoXForCausalLM) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
GPTNeoX 模型，其頂部帶有一個用於 CLM 微調的 `語言建模` 頭。
該模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 來源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, tuple[tuple[torch.FloatTensor]], NoneType] = 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 **kwargs: typing_extensions.Unpack[transformers.models.gpt_neox.modeling_gpt_neox.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列詞元的索引。預設情況下會忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length), 可選) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 位置嵌入中每個輸入序列詞元的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣更多地控制如何將 `input_ids` 索引轉換為相關向量，這會很有用。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads), 可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭被掩碼。
- past_key_values (
Union[~cache_utils.Cache, tuple[tuple[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`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的 `input_ids`），形狀為 `(batch_size, 1)`，而不是所有 `input_ids` 的形狀 `(batch_size, sequence_length)`。
- labels (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 用於計算從左到右語言建模損失（下一個詞預測）的標籤。索引應在 `[-100, 0, ..., config.vocab_size]` 範圍內（請參閱 `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 (形狀為 `(sequence_length)` 的 `torch.LongTensor`，可選) — 描述輸入序列中標記（token）在序列中位置的索引。與 `position_ids` 不同，此張量不受填充（padding）的影響。它用於在正確的位置更新快取，並推斷完整的序列長度。
- logits_to_keep (
Union[int, torch.Tensor], 預設為 `0`) — 如果是 `int`，則為最後的 `logits_to_keep` 個標記計算 logits。如果是 `0`，則為所有 `input_ids` 計算 logits（特殊情況）。在生成任務中，通常只需要最後一個標記的 logits，僅為此標記計算可以節省記憶體，這對於長序列或大詞彙表來說非常重要。如果是 `torch.Tensor`，則必須是對應於序列長度維度中要保留的索引的一維張量。這在使用打包張量格式（批次和序列長度使用單一維度）時非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithPast 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（GPTNeoXConfig）和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
GPTNeoXForCausalLM 的 forward 方法，覆蓋了 `__call__` 特殊方法。
儘管前向傳遞的邏輯需要在此函式中定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, GPTNeoXForCausalLM, GPTNeoXConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neox-20b")
>>> config = GPTNeoXConfig.from_pretrained("EleutherAI/gpt-neox-20b")
>>> config.is_decoder = True
>>> model = GPTNeoXForCausalLM.from_pretrained("EleutherAI/gpt-neox-20b", config=config)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsGPTNeoXForQuestionAnswering
class transformers.GPTNeoXForQuestionAnswering
< 原始碼 >( config )
引數
- config (GPTNeoXForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Gpt Neox Transformer 模型，其頂部帶有一個用於抽取式問答任務（如 SQuAD）的片段分類頭（一個線性層位於隱藏狀態輸出之上，用於計算 `span start logits` 和 `span end logits`）。
該模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = 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 ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 `tuple(torch.FloatTensor)`
引數
- input_ids (形狀為 `(batch_size, sequence_length)` 的 `torch.LongTensor`，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。
可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為 `(batch_size, sequence_length)` 的 `torch.FloatTensor`，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 `[0, 1]`：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- token_type_ids (形狀為 `(batch_size, sequence_length)` 的 `torch.LongTensor`，可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引選自 `[0, 1]`：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
- position_ids (形狀為 `(batch_size, sequence_length)` 的 `torch.LongTensor`，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自 `[0, config.n_positions - 1]` 範圍。
- head_mask (形狀為 `(num_heads,)` 或 `(num_layers, num_heads)` 的 `torch.FloatTensor`，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 `[0, 1]`：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- 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`），根據配置（GPTNeoXConfig）和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
GPTNeoXForQuestionAnswering 的 forward 方法，覆蓋了 `__call__` 特殊方法。
儘管前向傳遞的邏輯需要在此函式中定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, GPTNeoXForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neox-20b")
>>> model = GPTNeoXForQuestionAnswering.from_pretrained("EleutherAI/gpt-neox-20b")
>>> 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)
...GPTNeoXForSequenceClassification
class transformers.GPTNeoXForSequenceClassification
< 原始碼 >( config )
引數
- config (GPTNeoXForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
GPTNeoX Model Transformer，其頂部帶有一個序列分類頭（線性層）。
GPTNeoXForSequenceClassification 使用最後一個標記來進行分類，這與其他因果模型（例如 GPT-1）的做法相同。
由於它在最後一個標記上進行分類，因此需要知道最後一個標記的位置。如果配置中定義了 `pad_token_id`，它會在每一行中找到最後一個非填充標記。如果沒有定義 `pad_token_id`，它會簡單地取批次中每一行的最後一個值。由於當傳遞 `inputs_embeds` 而不是 `input_ids` 時，它無法猜測填充標記，因此它會做同樣的操作（取批次中每一行的最後一個值）。
該模型繼承自 PreTrainedModel。請檢視超類的文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, tuple[tuple[torch.FloatTensor]], NoneType] = 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 (形狀為 `(batch_size, sequence_length)` 的 `torch.LongTensor`，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。
可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為 `(batch_size, sequence_length)` 的 `torch.FloatTensor`，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 `[0, 1]`：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- position_ids (形狀為 `(batch_size, sequence_length)` 的 `torch.LongTensor`，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自 `[0, config.n_positions - 1]` 範圍。
- inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `torch.FloatTensor`，可選) — 可選地，你可以選擇直接傳遞嵌入表示而不是 `input_ids`。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 `input_ids` 索引轉換為相關向量，這將非常有用。
- head_mask (形狀為 `(num_heads,)` 或 `(num_layers, num_heads)` 的 `torch.FloatTensor`，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 `[0, 1]`：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- past_key_values (
Union[~cache_utils.Cache, tuple[tuple[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`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的標記），形狀為 `(batch_size, 1)`，而不是所有 `input_ids`，形狀為 `(batch_size, sequence_length)`。
- 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.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一個 `transformers.modeling_outputs.SequenceClassifierOutputWithPast` 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（GPTNeoXConfig）和輸入包含各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
GPTNeoXForSequenceClassification 的 forward 方法，覆蓋了 `__call__` 特殊方法。
儘管前向傳遞的邏輯需要在此函式中定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, GPTNeoXForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neox-20b")
>>> model = GPTNeoXForSequenceClassification.from_pretrained("EleutherAI/gpt-neox-20b")
>>> 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 = GPTNeoXForSequenceClassification.from_pretrained("EleutherAI/gpt-neox-20b", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, GPTNeoXForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neox-20b")
>>> model = GPTNeoXForSequenceClassification.from_pretrained("EleutherAI/gpt-neox-20b", 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 = GPTNeoXForSequenceClassification.from_pretrained(
... "EleutherAI/gpt-neox-20b", 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).lossGPTNeoXForTokenClassification
forward
< 原始碼 >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[transformers.cache_utils.Cache, tuple[tuple[torch.Tensor]], NoneType] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = 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`，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。
可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Union[~cache_utils.Cache, tuple[tuple[torch.Tensor]], 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`，使用者可以選擇只輸入最後一個 `input_ids`（那些沒有為其提供過去鍵值狀態的標記），形狀為 `(batch_size, 1)`，而不是所有 `input_ids`，形狀為 `(batch_size, sequence_length)`。
- attention_mask (形狀為 `(batch_size, sequence_length)` 的 `torch.FloatTensor`，可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自 `[0, 1]`：
- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- token_type_ids (形狀為 `(batch_size, sequence_length)` 的 `torch.LongTensor`，可選) — 用於指示輸入的第一部分和第二部分的片段標記索引。索引選自 `[0, 1]`：
- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
- position_ids (形狀為 `(batch_size, sequence_length)` 的 `torch.LongTensor`，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自 `[0, config.n_positions - 1]` 範圍。
- head_mask (形狀為 `(num_heads,)` 或 `(num_layers, num_heads)` 的 `torch.FloatTensor`，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 `[0, 1]`：
- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- inputs_embeds (形狀為 `(batch_size, sequence_length, hidden_size)` 的 `torch.FloatTensor`，可選) — 可選地，你可以選擇直接傳遞嵌入表示而不是 `input_ids`。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 `input_ids` 索引轉換為相關向量，這將非常有用。
- labels (形狀為 `(batch_size, sequence_length)` 的 `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 時），它包含多個元素，具體取決於配置（GPTNeoXConfig）和輸入。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
GPTNeoXForTokenClassification 的 forward 方法覆蓋了 __call__ 特殊方法。
儘管前向傳遞的邏輯需要在此函式中定義，但之後應該呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, GPTNeoXForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neox-20b")
>>> model = GPTNeoXForTokenClassification.from_pretrained("EleutherAI/gpt-neox-20b")
>>> 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)
...