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 支持受益于 attention 内核优化。
接下来,安装 最新版本的 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)
...
预期加速
以下是预期加速图,它比较了 transformers 中使用 stockmark/gpt-neox-japanese-1.4b
检查点 的本机实现与使用序列长度为 2048 的 Flash Attention 2 版本模型之间的纯推理时间。
使用缩放点积注意力 (SDPA)
PyTorch 将本机缩放点积注意力 (SDPA) 运算符作为 torch.nn.functional
的一部分包含在内。此函数包含可根据输入和使用的硬件应用的多种实现。有关详细信息,请参阅官方文档或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
) 加载模型。
在使用 pythia-410m-deduped 的本地基准测试 (rtx3080ti-16GB、PyTorch 2.2.1、操作系统 Ubuntu 22.04) 中,我们使用 float16
在训练和推理期间看到了以下加速。
训练
批次大小 | 序列长度 | 每批次时间 (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 (毫秒) | 每个令牌延迟 SDPA (毫秒) | 加速 (%) | 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
这是一个用于存储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.config
GPTNeoXTokenizerFast
class transformers.GPTNeoXTokenizerFast
< source >( 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 库支持)。 基于字节级字节对编码。
此标记器经过训练,将空格视为标记的一部分(有点像 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: Optional = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列 ID。 当使用标记器 prepare_for_model
方法添加特殊标记时,会调用此方法。
使用当前的 bos_token
和 eos_token
更新底层的后处理器。
GPTNeoXModel
class transformers.GPTNeoXModel
< source >( config )
参数
- config (~GPTNeoXConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看from_pretrained() 方法来加载模型权重。
基本的 GPTNeoX 模型变压器,输出原始隐藏状态,没有任何特定的头部。此模型是 PyTorch torch.nn.Module 子类。将其用作常规的 PyTorch 模块,并参考 PyTorch 文档以了解有关一般使用和行为的所有事宜。
forward
< source > ( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None past_key_values: Union = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
) — 输入序列标记在词汇表中的索引。索引可以使用AutoTokenizer 获取。查看PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详情。
- attention_mask (
torch.FloatTensor
of shape(batch_size, sequence_length)
, optional) — 用于避免在填充标记索引上执行注意的掩码。在[0, 1]
中选择的掩码值:- 1 表示未屏蔽的标记,
- 0 表示屏蔽的标记。
- position_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
, optional) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]
范围内选择。 - head_mask (
torch.FloatTensor
of shape(num_heads,)
or(num_layers, num_heads)
, optional) — 用于使自注意力模块中选定的头部无效的掩码。在[0, 1]
中选择的掩码值:- 1 表示未屏蔽的头部,
- 0 表示屏蔽的头部。
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量中的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量中的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor
形状为(sequence_length)
, 可选) — 表示输入序列令牌在序列中的位置的索引。 与position_ids
相反,此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整序列长度。 - use_cache (
bool
, 可选) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(请参阅past_key_values
)。
返回
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 (
tuple(tuple(torch.FloatTensor))
, 可选, 在use_cache=True
传递或config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
) 的张量,以及可选地,如果config.is_encoder_decoder=True
,则包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的额外张量。包含预先计算的隐藏状态(自注意力块中的键和值,以及可选地,如果
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
实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
此示例使用随机模型,因为真实模型都非常大。 为了获得正确的结果,您应该使用 EleutherAI/gpt-neox-20b 而不是 trl-internal-testing/tiny-random-GPTNeoXForCausalLM。 如果在加载该检查点时出现内存不足的情况,您可以在 from_pretrained
调用中尝试添加 device_map="auto"
。
示例
>>> from transformers import AutoTokenizer, GPTNeoXModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM")
>>> model = GPTNeoXModel.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
GPTNeoXForCausalLM
class transformers.GPTNeoXForCausalLM
< 来源 >( config )
参数
- config (~GPTNeoXConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。查看 from_pretrained() 方法加载模型权重。
GPTNeoX 模型,顶部带有一个 语言建模
头,用于 CLM 微调。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块,并参考 PyTorch 文档了解所有与常规使用和行为相关的内容。
forward
< source > ( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None inputs_embeds: Optional = None head_mask: Optional = None past_key_values: Union = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 输入序列标记在词汇表中的索引。索引可以使用 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
或tuple(tuple(torch.FloatTensor))
, 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。 这通常包含在模型在解码的先前阶段返回的past_key_values
中,当use_cache=True
或config.use_cache=True
时。允许两种格式:
- 一个 Cache 实例,请参阅我们的 kv 缓存指南;
- 长度为
config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含两个形状为(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
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量中的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量中的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor
形状为(sequence_length)
, 可选) — 指示输入序列令牌在序列中的位置的索引。 与position_ids
相反,此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor
形状为(batch_size, sequence_length)
, 可选) — 用于计算从左到右的语言建模损失(下一个词预测)的标签。 索引应在[-100, 0, ..., config.vocab_size]
中(请参阅input_ids
文档字符串) 索引设置为-100
的令牌将被忽略(屏蔽),损失仅针对标签为[0, ..., config.vocab_size]
的令牌计算。 - use_cache (
bool
, 可选) — 如果设置为True
,则将返回past_key_values
键值状态,可用于加速解码(请参阅past_key_values
)。
返回
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
时返回) — 语言建模损失(用于下一个令牌预测)。 -
logits (
torch.FloatTensor
形状为(batch_size, sequence_length, config.vocab_size)
) — 语言建模头的预测分数(在 SoftMax 之前每个词汇表令牌的分数)。 -
past_key_values (
tuple(tuple(torch.FloatTensor))
, 可选, 当传递use_cache=True
或当config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量)包含预先计算的隐藏状态(自注意力块中的键和值),可用于(请参阅
past_key_values
输入)加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 在output_hidden_states=True
传递或config.output_hidden_states=True
时返回) —torch.FloatTensor
元组(一个用于嵌入输出,如果模型具有嵌入层,另一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 在output_attentions=True
传递或config.output_attentions=True
时返回) —torch.FloatTensor
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
The GPTNeoXForCausalLM 前向方法,覆盖 __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.logits
GPTNeoXForQuestionAnswering
class transformers.GPTNeoXForQuestionAnswering
< 源代码 >( config )
参数
- config (~GPTNeoXConfig) — 模型配置类,包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
GPT-NeoX 模型转换器,在其顶部带有跨度分类头,用于提取式问答任务,例如 SQuAD(在隐藏状态输出之上添加一个线性层,以计算 span start logits
和 span end logits
)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解有关一般使用和行为的所有事宜。
forward
< 源代码 > ( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 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
或tuple(tuple(torch.FloatTensor))
, 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。 这通常包含在模型在解码的先前阶段返回的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
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。 - cache_position (形状为
(sequence_length)
的torch.LongTensor
, 可选) — 表示输入序列令牌在序列中的位置的索引。 与position_ids
相反,此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。 - start_positions (形状为
(batch_size,)
的torch.LongTensor
, 可选) — 用于计算令牌分类损失的标记跨度的开始位置(索引)的标签。 位置被限制在序列的长度(sequence_length
)内。 序列之外的位置不会被考虑用于计算损失。 - end_positions (形状为
(batch_size,)
的torch.LongTensor
, 可选) — 用于计算令牌分类损失的标记跨度的结束位置(索引)的标签。 位置被限制在序列的长度(sequence_length
)内。 序列之外的位置不会被考虑用于计算损失。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
时),包含根据配置(GPTNeoXConfig)和输入而变化的各种元素。
-
loss (形状为
(1,)
的torch.FloatTensor
, 可选,当提供labels
时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。 -
start_logits (形状为
(batch_size, sequence_length)
的torch.FloatTensor
) — 跨度开始得分(在 SoftMax 之前)。 -
end_logits (形状为
(batch_size, sequence_length)
的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 之后的注意力权重,用于计算自注意力头中的加权平均值。
GPTNeoXForQuestionAnswering 正向方法,覆盖了 __call__
特殊方法。
虽然正向传递的配方需要在此函数中定义,但之后应该调用 Module
实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
此示例使用随机模型,因为真实模型都非常大。 为了获得正确的结果,您应该使用 EleutherAI/gpt-neox-20b 而不是 trl-internal-testing/tiny-random-GPTNeoXForCausalLM。 如果在加载该检查点时出现内存不足的情况,您可以在 from_pretrained
调用中尝试添加 device_map="auto"
。
示例
>>> from transformers import AutoTokenizer, GPTNeoXForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM")
>>> model = GPTNeoXForQuestionAnswering.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM")
>>> 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]
>>> # 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
GPTNeoXForSequenceClassification
class transformers.GPTNeoXForSequenceClassification
< 源代码 >( config )
参数
- config (~GPTNeoXConfig) — 模型配置类,包含模型的所有参数。 使用配置文件初始化不会加载与模型相关的权重,只加载配置。 查看 from_pretrained() 方法来加载模型权重。
GPTNeoX 模型转换器,在其之上有一个序列分类头(线性层)。
GPTNeoXForSequenceClassification 使用最后一个 token 进行分类,就像其他因果模型(例如 GPT-1)一样。
由于它对最后一个 token 进行分类,因此它需要知道最后一个 token 的位置。 如果在配置中定义了 pad_token_id
,它会找到每行中不是填充 token 的最后一个 token。 如果未定义 pad_token_id
,它只是获取批次中每行的最后一个值。 由于它无法在传递 inputs_embeds
而不是 input_ids
时猜测填充 token,因此它会执行相同的操作(获取批次中每行的最后一个值)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解有关一般使用和行为的所有事宜。
forward
< 源代码 > ( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None inputs_embeds: Optional = None head_mask: Optional = None past_key_values: Union = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast
or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为({0})
) — 输入序列 token 在词汇表中的索引。可以使用 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
- attention_mask (
torch.FloatTensor
形状为({0})
, 可选) — 掩码以避免对填充 token 索引执行注意力。 在[0, 1]
中选择掩码值:- 1 表示 未被掩码 的 token,
- 0 表示 被掩码 的 token。
- position_ids (
torch.LongTensor
形状为({0})
, 可选) — 输入序列 token 在位置嵌入中的位置索引。 在[0, config.n_positions - 1]
范围内选择。 - head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 掩码以使自注意力模块中选定的头无效。 在[0, 1]
中选择掩码值:- 1 表示 未被掩码 的头,
- 0 表示 被掩码 的头。
- inputs_embeds (
torch.FloatTensor
形状为({0}, hidden_size)
, 可选) — 可选地,您可以选择直接传递嵌入式表示,而不是传递input_ids
。 如果您希望对如何将 input_ids 索引转换为关联向量有更多控制权,而不是模型的内部嵌入查找矩阵,这很有用。 - past_key_values (
Cache
或tuple(tuple(torch.FloatTensor))
, 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。 这通常由模型在解码的先前阶段返回的past_key_values
组成,当use_cache=True
或config.use_cache=True
时。允许两种格式:
- 一个 Cache 实例,请参见我们的 kv 缓存指南;
- 长度为
config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量。 这也被称为旧缓存格式。
模型将输出与输入相同的缓存格式。 如果未传递
past_key_values
,则将返回旧缓存格式。如果使用
past_key_values
,用户可以选择仅输入最后一个input_ids
(那些没有将其过去键值状态提供给此模型的)形状为(batch_size, 1)
而不是所有形状为(batch_size, sequence_length)
的input_ids
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(sequence_length)
的torch.LongTensor
, 可选) — 表示输入序列令牌在序列中的位置的索引。 与position_ids
相反,此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (形状为
(batch_size,)
的torch.LongTensor
, 可选) — 用于计算序列分类/回归损失的标签。 索引应在[0, ..., config.num_labels - 1]
中。 如果config.num_labels == 1
,则计算回归损失(均方误差损失),如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回
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 (
tuple(tuple(torch.FloatTensor))
, 可选, 当传递use_cache=True
或当config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量)包含预先计算的隐藏状态(自注意力块中的键和值),可用于(请参阅
past_key_values
输入)加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 在output_hidden_states=True
传递或config.output_hidden_states=True
时返回) —torch.FloatTensor
元组(一个用于嵌入输出,如果模型具有嵌入层,另一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 在output_attentions=True
传递或config.output_attentions=True
时返回) —torch.FloatTensor
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
The GPTNeoXForSequenceClassification forward method, overrides the __call__
special method.
虽然正向传递的配方需要在此函数中定义,但之后应该调用 Module
实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
单标签分类的示例
>>> import torch
>>> from transformers import AutoTokenizer, GPTNeoXForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM")
>>> model = GPTNeoXForSequenceClassification.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # 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("trl-internal-testing/tiny-random-GPTNeoXForCausalLM", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
多标签分类的示例
>>> import torch
>>> from transformers import AutoTokenizer, GPTNeoXForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM")
>>> model = GPTNeoXForSequenceClassification.from_pretrained("trl-internal-testing/tiny-random-GPTNeoXForCausalLM", 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(
... "trl-internal-testing/tiny-random-GPTNeoXForCausalLM", 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).loss
GPTNeoXForTokenClassification
forward
< 源代码 > ( input_ids: Optional = None past_key_values: Union = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为({0})
) — 输入序列词元的词汇表索引。索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor
形状为({0})
, 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选择在[0, 1]
之间:- 1 表示未屏蔽的词元,
- 0 表示屏蔽的词元.
- position_ids (
torch.LongTensor
形状为({0})
, 可选) — 输入序列词元在位置嵌入中的位置索引。选择范围在[0, config.n_positions - 1]
之间。 - head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于使自注意力模块中选定的头部无效的掩码。掩码值选择在[0, 1]
之间:- 1 表示未屏蔽的头部,
- 0 表示屏蔽的头部.
- inputs_embeds (
torch.FloatTensor
形状为({0}, hidden_size)
, 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您想比模型内部嵌入查找矩阵更精确地控制如何将input_ids 索引转换为关联的向量,这将很有用。 - past_key_values (
Cache
或tuple(tuple(torch.FloatTensor))
, 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括在解码的先前阶段由模型返回的past_key_values
,此时use_cache=True
或config.use_cache=True
。允许两种格式:
- 一个 Cache 实例,请参阅我们的 kv 缓存指南;
tuple(torch.FloatTensor)
的元组,长度为config.n_layers
,每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量)。这也被称为传统缓存格式。
模型将输出与输入作为输入的相同缓存格式。如果没有传递
past_key_values
,则将返回传统缓存格式。如果使用
past_key_values
,用户可以选择仅输入形状为(batch_size, 1)
的最后一个input_ids
(那些没有将其过去键值状态提供给该模型的input_ids
),而不是形状为(batch_size, sequence_length)
的所有input_ids
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor
形状为(sequence_length)
, 可选) — 表示输入序列令牌在序列中的位置的索引。 与position_ids
相反,此张量不受填充影响。 它用于在正确的位置更新缓存并推断完整序列长度。 - labels (
torch.LongTensor
形状为(batch_size, sequence_length)
, 可选) — 用于计算序列分类/回归损失的标签。 索引应在[0, ..., config.num_labels - 1]
中。 如果config.num_labels == 1
,则计算回归损失(均方损失),如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含取决于配置 (GPTNeoXConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor
形状为(1,)
, 可选,在提供labels
时返回) — 分类损失。 -
logits (
torch.FloatTensor
形状为(batch_size, sequence_length, config.num_labels)
) — 分类分数(在 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 之后的注意力权重,用于计算自注意力头中的加权平均值。
The GPTNeoXForTokenClassification forward method, overrides the __call__
special method.
虽然正向传递的配方需要在此函数中定义,但之后应该调用 Module
实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GPTNeoXForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("LarsJonasson/pythia-410m-deduped-sft-swedish")
>>> model = GPTNeoXForTokenClassification.from_pretrained("LarsJonasson/pythia-410m-deduped-sft-swedish")
>>> 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]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.25