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)
...