Transformers 文档
OpenAI GPT2
并获得增强的文档体验
开始
OpenAI GPT2
概述
OpenAI GPT-2 模型由 Alec Radford、Jeffrey Wu、Rewon Child、David Luan、Dario Amodei 和 Ilya Sutskever 于 Language Models are Unsupervised Multitask Learners 论文中提出，他们均来自 OpenAI。它是一个因果（单向） Transformer 模型，使用语言建模在约 40 GB 的超大型文本数据集上进行预训练。
该论文的摘要如下：
GPT-2 是一个基于大型 Transformer 的语言模型，拥有 15 亿参数，并在包含 800 万个网页的数据集 [1] 上进行训练。GPT-2 的训练目标很简单：预测给定文本中所有先前词语的下一个词语。数据集的多样性使得这个简单的目标能够自然地包含跨多个领域的许多任务演示。GPT-2 是 GPT 的直接放大版本，参数量和训练数据量都超过了 10 倍。
Write With Transformer 是 Hugging Face 创建和托管的 Web 应用程序，展示了几种模型的生成能力。GPT-2 是其中之一，并提供五种不同尺寸的版本：small、medium、large、xl 以及 small 检查点的精馏版本：distilgpt-2。
使用技巧
- GPT-2 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
- GPT-2 使用因果语言建模 (CLM) 目标进行训练，因此在预测序列中的下一个 token 方面非常强大。利用此功能，GPT-2 可以生成语法连贯的文本，正如在 run_generation.py 示例脚本中所观察到的那样。
- 该模型可以将 past_key_values（对于 PyTorch）或 past（对于 TF）作为输入，这是先前计算的键/值注意力对。使用此值（past_key_values 或 past）可以防止模型在文本生成上下文中重新计算预先计算的值。对于 PyTorch，请参阅 GPT2Model.forward() 方法的 past_key_values 参数，或者对于 TF，请参阅 TFGPT2Model.call() 方法的 past 参数，以获取有关其用法的更多信息。
- 启用 scale_attn_by_inverse_layer_idx 和 reorder_and_upcast_attn 标志将应用来自 Mistral 的训练稳定性改进（仅适用于 PyTorch）。
使用示例
generate() 方法可用于使用 GPT2 模型生成文本。
>>> from transformers import AutoModelForCausalLM, AutoTokenizer
>>> model = AutoModelForCausalLM.from_pretrained("gpt2")
>>> tokenizer = AutoTokenizer.from_pretrained("gpt2")
>>> prompt = "GPT2 is a model developed by OpenAI."
>>> 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 是注意力分数计算的更快、优化的版本，它依赖于 cuda 内核。
安装
首先，检查您的硬件是否与 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) 加载模型，因为它几乎不会降低音频质量，但可以显著降低内存使用量并加快推理速度
>>> import torch
>>> from transformers import AutoModelForCausalLM, AutoTokenizer
>>> device = "cuda" # the device to load the model onto
>>> model = AutoModelForCausalLM.from_pretrained("gpt2", torch_dtype=torch.float16, attn_implementation="flash_attention_2")
>>> tokenizer = AutoTokenizer.from_pretrained("gpt2")
>>> prompt = "def hello_world():"
>>> model_inputs = tokenizer([prompt], return_tensors="pt").to(device)
>>> model.to(device)
>>> generated_ids = model.generate(**model_inputs, max_new_tokens=100, do_sample=True)
>>> tokenizer.batch_decode(generated_ids)[0]预期加速
下图是一个预期加速图，比较了使用 gpt2 检查点的 transformers 中的原生实现与使用序列长度为 512 的模型的 Flash Attention 2 版本之间的纯推理时间。
使用缩放点积注意力 (SDPA)
PyTorch 包含一个原生缩放点积注意力 (SDPA) 运算符，作为 torch.nn.functional 的一部分。此函数包含多个实现，可以根据输入和正在使用的硬件应用。有关更多信息，请参阅 官方文档 或 GPU 推理 页面。
当实现可用时，torch>=2.1.1 默认使用 SDPA，但您也可以在 from_pretrained() 中设置 attn_implementation="sdpa" 以显式请求使用 SDPA。
from transformers import AutoModelForCausalLM
model = AutoModelForCausalLM.from_pretrained("gpt2", torch_dtype=torch.float16, attn_implementation="sdpa")
...为了获得最佳加速效果，我们建议以半精度 (例如 torch.float16 或 torch.bfloat16) 加载模型。
在本地基准测试（rtx3080ti-16GB，PyTorch 2.2.1，OS Ubuntu 22.04）中使用 float16 和 gpt2-large，我们在训练和推理期间看到了以下加速效果。
训练
| Batch size (批大小) | Seq len (序列长度) | Time per batch (Eager - s) (每个批次的时间 (Eager - 秒)) | Time per batch (SDPA - s) (每个批次的时间 (SDPA - 秒)) | Speedup (%) (加速百分比) | Eager peak mem (MB) (Eager 峰值内存 (MB)) | SDPA peak mem (MB) (SDPA 峰值内存 (MB)) | Mem saving (%) (内存节省百分比) |
|---|---|---|---|---|---|---|---|
| 1 | 128 | 0.039 | 0.032 | 23.042 | 3482.32 | 3494.62 | -0.352 |
| 1 | 256 | 0.073 | 0.059 | 25.15 | 3546.66 | 3552.6 | -0.167 |
| 1 | 512 | 0.155 | 0.118 | 30.96 | 4230.1 | 3665.59 | 15.4 |
| 1 | 1024 | 0.316 | 0.209 | 50.839 | 8682.26 | 4881.09 | 77.875 |
| 2 | 128 | 0.07 | 0.06 | 15.324 | 3557.8 | 3545.91 | 0.335 |
| 2 | 256 | 0.143 | 0.122 | 16.53 | 3901.5 | 3657.68 | 6.666 |
| 2 | 512 | 0.267 | 0.213 | 25.626 | 7062.21 | 4876.47 | 44.822 |
| 2 | 1024 | OOM (内存溢出) | 0.404 | / | OOM (内存溢出) | 8096.35 | SDPA does not OOM (SDPA 不会内存溢出) |
| 4 | 128 | 0.134 | 0.128 | 4.412 | 3675.79 | 3648.72 | 0.742 |
| 4 | 256 | 0.243 | 0.217 | 12.292 | 6129.76 | 4871.12 | 25.839 |
| 4 | 512 | 0.494 | 0.406 | 21.687 | 12466.6 | 8102.64 | 53.858 |
| 4 | 1024 | OOM (内存溢出) | 0.795 | / | OOM (内存溢出) | 14568.2 | SDPA does not OOM (SDPA 不会内存溢出) |
推理
| Batch size (批大小) | Seq len (序列长度) | Per token latency Eager (ms) (每个 token 的延迟 Eager (毫秒)) | Per token latency SDPA (ms) (每个 token 的延迟 SDPA (毫秒)) | Speedup (%) (加速百分比) | Mem Eager (MB) (内存 Eager (MB)) | Mem SDPA (MB) (内存 SDPA (MB)) | Mem saved (%) (内存节省百分比) |
|---|---|---|---|---|---|---|---|
| 1 | 128 | 7.991 | 6.968 | 14.681 | 1685.2 | 1701.32 | -0.947 |
| 1 | 256 | 8.462 | 7.199 | 17.536 | 1745.49 | 1770.78 | -1.428 |
| 1 | 512 | 8.68 | 7.853 | 10.529 | 1907.69 | 1921.29 | -0.708 |
| 1 | 768 | 9.101 | 8.365 | 8.791 | 2032.93 | 2068.12 | -1.701 |
| 2 | 128 | 9.169 | 9.001 | 1.861 | 1803.84 | 1811.4 | -0.418 |
| 2 | 256 | 9.907 | 9.78 | 1.294 | 1907.72 | 1921.44 | -0.714 |
| 2 | 512 | 11.519 | 11.644 | -1.071 | 2176.86 | 2197.75 | -0.951 |
| 2 | 768 | 13.022 | 13.407 | -2.873 | 2464.3 | 2491.06 | -1.074 |
| 4 | 128 | 10.097 | 9.831 | 2.709 | 1942.25 | 1985.13 | -2.16 |
| 4 | 256 | 11.599 | 11.398 | 1.764 | 2177.28 | 2197.86 | -0.937 |
| 4 | 512 | 14.653 | 14.45 | 1.411 | 2753.16 | 2772.57 | -0.7 |
| 4 | 768 | 17.846 | 17.617 | 1.299 | 3327.04 | 3343.97 | -0.506 |
资源
以下是官方 Hugging Face 和社区（🌎 表示）资源的列表，可帮助您开始使用 GPT2。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！理想情况下，该资源应演示一些新的内容，而不是重复现有资源。
- 一篇关于如何使用 Hugging Face 微调非英语 GPT-2 模型的博客。
- 一篇关于 如何生成文本：使用不同的解码方法，通过 Transformers 进行语言生成 (使用 GPT-2) 的博客。
- 一篇关于 从零开始训练 CodeParrot 🦜 (一个大型 GPT-2 模型) 的博客。
- 一篇关于使用 GPT-2 进行 TensorFlow 和 XLA 加速文本生成 的博客。
- 一篇关于如何使用 GPT-2 模型通过 Megatron-LM 训练语言模型 的博客。
- 一个关于如何 微调 GPT2 以生成您最喜欢的艺术家的风格的歌词 的 notebook。🌎
- 一个关于如何 微调 GPT2 以生成您最喜欢的 Twitter 用户的风格的推文 的 notebook。🌎
- 因果语言建模 🤗 Hugging Face 课程章节。
- GPT2LMHeadModel 由此 因果语言建模示例脚本、文本生成示例脚本 和 notebook 支持。
- TFGPT2LMHeadModel 由此 因果语言建模示例脚本 和 notebook 支持。
- FlaxGPT2LMHeadModel 由此 因果语言建模示例脚本 和 notebook 支持。
- 文本分类任务指南
- Token 分类任务指南
- 因果语言建模任务指南
GPT2Config
class transformers.GPT2Config
< source >( vocab_size = 50257 n_positions = 1024 n_embd = 768 n_layer = 12 n_head = 12 n_inner = None activation_function = 'gelu_new' resid_pdrop = 0.1 embd_pdrop = 0.1 attn_pdrop = 0.1 layer_norm_epsilon = 1e-05 initializer_range = 0.02 summary_type = 'cls_index' summary_use_proj = True summary_activation = None summary_proj_to_labels = True summary_first_dropout = 0.1 scale_attn_weights = True use_cache = True bos_token_id = 50256 eos_token_id = 50256 scale_attn_by_inverse_layer_idx = False reorder_and_upcast_attn = False **kwargs )
参数
- vocab_size (
int, 可选, 默认为 50257) — GPT-2 模型的词汇表大小。定义了在调用 GPT2Model 或 TFGPT2Model 时传递的inputs_ids可以表示的不同 token 的数量。 - n_positions (
int, 可选, 默认为 1024) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。 - n_embd (
int, 可选, 默认为 768) — 嵌入和隐藏状态的维度。 - n_layer (
int, 可选, 默认为 12) — Transformer 编码器中隐藏层的数量。 - n_head (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头的数量。 - n_inner (
int, 可选) — 内部前馈层的维度。None将其设置为 4 倍的 n_embd - activation_function (
str, 可选, 默认为"gelu_new") — 激活函数，需从列表["relu", "silu", "gelu", "tanh", "gelu_new"]中选择。 - resid_pdrop (
float, 可选, 默认为 0.1) — embedding 层、编码器和 pooler 中所有全连接层的 dropout 概率。 - embd_pdrop (
float, 可选, 默认为 0.1) — embedding 层的 dropout 比率。 - attn_pdrop (
float, 可选, 默认为 0.1) — attention 机制的 dropout 比率。 - layer_norm_epsilon (
float, 可选, 默认为 1e-05) — layer normalization 层中使用的 epsilon 值。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - summary_type (
string, 可选, 默认为"cls_index") — 在进行序列摘要时使用的参数，用于模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel。必须是以下选项之一：
"last": 取最后一个 token 的隐藏状态 (类似 XLNet)。"first": 取第一个 token 的隐藏状态 (类似 BERT)。"mean": 取所有 token 隐藏状态的均值。"cls_index": 提供分类 token 位置的 Tensor (类似 GPT/GPT-2)。"attn": 暂未实现，使用多头 attention 机制。
- summary_use_proj (
bool, 可选, 默认为True) — 在进行序列摘要时使用的参数，用于模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel。是否在向量提取后添加一个 projection 层。
- summary_activation (
str, 可选) — 在进行序列摘要时使用的参数。用于 GPT2DoubleHeadsModel 中的多项选择头。传递
"tanh"将 tanh 激活函数应用于输出，任何其他值将导致不进行激活。 - summary_proj_to_labels (
bool, 可选, 默认为True) — 在进行序列摘要时使用的参数，用于模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel。projection 层的输出是否应具有
config.num_labels或config.hidden_size个类别。 - summary_first_dropout (
float, 可选, 默认为 0.1) — 在进行序列摘要时使用的参数，用于模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel。在 projection 层和激活函数之后使用的 dropout 比率。
- scale_attn_weights (
bool, 可选, 默认为True) — 是否通过除以 sqrt(hidden_size) 来缩放 attention 权重。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的 key/values attention (并非所有模型都使用)。 - bos_token_id (
int, 可选, 默认为 50256) — 词汇表中句首 token 的 ID。 - eos_token_id (
int, 可选, 默认为 50256) — 词汇表中句尾 token 的 ID。 - scale_attn_by_inverse_layer_idx (
bool, 可选, 默认为False) — 是否额外地通过1 / layer_idx + 1来缩放 attention 权重。 - reorder_and_upcast_attn (
bool, 可选, 默认为False) — 是否在计算 attention (点积) 之前缩放键 (K)，并在使用混合精度训练时将 attention 点积/softmax 向上转换为 float()。
这是用于存储 GPT2Model 或 TFGPT2Model 配置的配置类。 它用于根据指定的参数实例化 GPT-2 模型，定义模型架构。 使用默认值实例化配置将产生与 GPT-2 openai-community/gpt2 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。 有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import GPT2Config, GPT2Model
>>> # Initializing a GPT2 configuration
>>> configuration = GPT2Config()
>>> # Initializing a model (with random weights) from the configuration
>>> model = GPT2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGPT2Tokenizer
class transformers.GPT2Tokenizer
< source >( vocab_file merges_file errors = 'replace' unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' pad_token = None add_prefix_space = False add_bos_token = False **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - merges_file (
str) — merges 文件的路径。 - errors (
str, 可选, 默认为"replace") — 将字节解码为 UTF-8 时遵循的范例。 有关更多信息，请参阅 bytes.decode。 - unk_token (
str, 可选, 默认为"<|endoftext|>") — 未知 token。 词汇表中不存在的 token 无法转换为 ID，而是设置为此 token。 - bos_token (
str, 可选, 默认为"<|endoftext|>") — 序列的起始 token。 - eos_token (
str, 可选, 默认为"<|endoftext|>") — 序列的结束 token。 - pad_token (
str, optional) — 用于填充的 token，例如在对不同长度的序列进行批处理时。 - add_prefix_space (
bool, optional, defaults toFalse) — 是否在输入文本前添加一个空格。这允许像处理其他单词一样处理句首单词。（GPT2 tokenizer 通过前面的空格检测单词的开头）。 - add_bos_token (
bool, optional, defaults toFalse) — 是否在输入文本前添加句首 (beginning of sentence) token。这允许像处理其他单词一样处理句首单词。
构建 GPT-2 分词器。基于字节级 Byte-Pair-Encoding。
此分词器经过训练，将空格视为 token 的一部分（有点像 sentencepiece），因此一个词
在句首（没有空格）或不在句首时，将被不同地编码
>>> from transformers import GPT2Tokenizer
>>> tokenizer = GPT2Tokenizer.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 一起使用时，此分词器将在每个单词（甚至是第一个单词）之前添加一个空格。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
GPT2TokenizerFast
class transformers.GPT2TokenizerFast
< source >( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' add_prefix_space = False **kwargs )
参数
- vocab_file (
str, optional) — 词汇表文件的路径。 - merges_file (
str, optional) — merges 文件的路径。 - tokenizer_file (
str, optional) — tokenizers 文件的路径（通常具有 .json 扩展名），其中包含加载分词器所需的一切。 - unk_token (
str, optional, defaults to"<|endoftext|>") — 未知 token。词汇表中不存在的 token 无法转换为 ID，而是设置为此 token。 - bos_token (
str, optional, defaults to"<|endoftext|>") — 序列开始 token。 - eos_token (
str, optional, defaults to"<|endoftext|>") — 序列结束 token。 - add_prefix_space (
bool, optional, defaults toFalse) — 是否在输入文本前添加一个空格。这允许像处理其他单词一样处理句首单词。（GPT2 tokenizer 通过前面的空格检测单词的开头）。
构建“快速” GPT-2 分词器（由 HuggingFace 的 tokenizers 库支持）。基于字节级 Byte-Pair-Encoding。
此分词器经过训练，将空格视为 token 的一部分（有点像 sentencepiece），因此一个词
在句首（没有空格）或不在句首时，将被不同地编码
>>> from transformers import GPT2TokenizerFast
>>> tokenizer = GPT2TokenizerFast.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，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
GPT2 特定输出
class transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None mc_loss: typing.Optional[torch.FloatTensor] = None logits: FloatTensor = None mc_logits: FloatTensor = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None )
参数
- loss (
torch.FloatTensor，形状为(1,)，optional，当提供labels时返回) — 语言建模损失。 - mc_loss (
torch.FloatTensor，形状为(1,)，optional，当提供mc_labels时返回) — 多项选择分类损失。 - logits (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 - mc_logits (
torch.FloatTensor，形状为(batch_size, num_choices)) — 多项选择分类头的预测分数（SoftMax 之前每个选项的分数）。 - past_key_values (
Tuple[Tuple[torch.Tensor]], optional，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的元组，包含形状为(batch_size, num_heads, sequence_length, embed_size_per_head)) 的 tensor 元组。包含预先计算的隐藏状态（attention 块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。 - hidden_states (
tuple(torch.FloatTensor), optional，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组 (每个 embedding 输出 + 每层输出一个)，形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的隐藏状态，加上初始 embedding 输出。
- attentions (
tuple(torch.FloatTensor), optional，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组 (每层一个)，形状为(batch_size, num_heads, sequence_length, sequence_length)。GPT2Attentions 权重在 attention softmax 之后，用于计算 self-attention 头中的加权平均值。
用于预测两个句子是否连续的模型输出的基类。
class transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput
< source >( logits: tf.Tensor = None mc_logits: tf.Tensor = None past_key_values: List[tf.Tensor] | None = None hidden_states: Tuple[tf.Tensor] | None = None attentions: Tuple[tf.Tensor] | None = None )
参数
- logits (
tf.Tensor，形状为(batch_size, num_choices, sequence_length, config.vocab_size)) — 语言模型头的预测分数（SoftMax 之前的每个词汇标记的分数）。 - mc_logits (
tf.Tensor，形状为(batch_size, num_choices)) — 多项选择分类头的预测分数（SoftMax 之前的每个选项的分数）。 - past_key_values (
List[tf.Tensor], 可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含预先计算的隐藏状态（注意力模块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。 - hidden_states (
tuple(tf.Tensor), 可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（每个层的输出一个，加上初始嵌入输出）。模型在每一层输出的隐藏状态，加上初始嵌入输出。
- attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每层一个）。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
用于预测两个句子是否连续的模型输出的基类。
GPT2Model
class transformers.GPT2Model
< source >( config )
参数
- config (GPT2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 GPT2 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的头部。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = 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 encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, input_ids_length)的torch.LongTensor) — 如果past_key_values为None，则input_ids_length=sequence_length，否则input_ids_length=past_key_values[0][0].shape[-2]（输入过去键值状态的sequence_length）。词汇表中输入序列标记的索引。如果使用
past_key_values，则仅应将未计算过去的input_ids作为input_ids传递。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (长度为
config.n_layers的Tuple[Tuple[torch.Tensor]]) — 包含模型计算的预计算隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。可用于加速顺序解码。已将过去状态提供给此模型的input_ids不应作为input_ids传递，因为它们已被计算。 - attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩蔽，
- 0 表示标记已被掩蔽。
如果使用
past_key_values，则attention_mask需要包含用于past_key_values的掩蔽策略。换句话说，attention_mask始终必须具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (形状为
(batch_size, input_ids_length)的torch.LongTensor, 可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 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索引转换为关联向量，这将非常有用。如果使用
past_key_values，则可以选择仅输入最后一个inputs_embeds（请参阅past_key_values）。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
Returns
transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层输出的隐藏状态序列。如果使用
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(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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True且config.add_cross_attention=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组 (每层一个)，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器互注意力层的注意力权重，在注意力 softmax 之后，用于计算互注意力头中的加权平均值。
GPT2Model 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GPT2Model
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2Model.from_pretrained("openai-community/gpt2")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateGPT2LMHeadModel
class transformers.GPT2LMHeadModel
< source >( config )
参数
- config (GPT2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模头的 GPT2 模型 Transformer（线性层，其权重与输入嵌入层绑定）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = 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 encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: 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 return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length，如果past_key_values为None，否则为past_key_values[0][0].shape[-2](输入过去键值状态的sequence_length)。词汇表中输入序列 tokens 的索引。如果使用
past_key_values，则只有未计算过去的input_ids应作为input_ids传递。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Tuple[Tuple[torch.Tensor]]，长度为config.n_layers) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（参见下面的past_key_values输出）。可用于加速顺序解码。已将过去状态提供给此模型的input_ids不应作为input_ids传递，因为它们已被计算过。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
如果使用
past_key_values，则attention_mask需要包含用于past_key_values的掩码策略。换句话说，attention_mask始终必须具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (
torch.LongTensor，形状为(batch_size, input_ids_length), 可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定 heads 无效的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。如果使用
past_key_values，则可以选择仅输入最后的inputs_embeds（请参阅past_key_values）。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于语言建模的标签。请注意，标签在模型内部被移动，即您可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都将被忽略（掩盖），损失仅针对[0, ..., config.vocab_size]中的标签计算。
Returns
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
loss (
torch.FloatTensor，形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组 (每层一个)，形状为(batch_size, num_heads, sequence_length, sequence_length)。互注意力 softmax 之后的互注意力权重，用于计算互注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) —torch.FloatTensor元组的元组，长度为config.n_layers，每个元组包含自注意力层的缓存键、值状态，以及互注意力层（如果模型用于编码器-解码器设置）。仅当config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力模块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。
GPT2LMHeadModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, GPT2LMHeadModel
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2LMHeadModel.from_pretrained("openai-community/gpt2")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logitsGPT2DoubleHeadsModel
class transformers.GPT2DoubleHeadsModel
< source >( config )
参数
- config (GPT2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模头和多项选择分类头的 GPT2 模型 Transformer，例如用于 RocStories/SWAG 任务。这两个头是两个线性层。语言建模头的权重与其输入嵌入层绑定，分类头将输入序列中指定的分类 token 索引的输入作为输入）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = 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 mc_token_ids: typing.Optional[torch.LongTensor] = None labels: typing.Optional[torch.LongTensor] = None mc_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 return_dict: typing.Optional[bool] = None **kwargs ) → transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length，如果past_key_values为None，否则past_key_values[0][0].shape[-2](输入 past key value 状态的sequence_length)。 词汇表中输入序列 tokens 的索引。如果使用
past_key_values，则只有未计算 past 的input_ids应作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Tuple[Tuple[torch.Tensor]]，长度为config.n_layers) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。 可用于加速顺序解码。 已将 past 提供给此模型的input_ids不应作为input_ids传递，因为它们已被计算过。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩蔽，
- 0 表示 tokens 被掩蔽。
如果使用
past_key_values，则attention_mask需要包含用于past_key_values的掩蔽策略。 换句话说，attention_mask始终必须具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)，可选) — Segment token 索引以指示输入的第一个和第二个部分。 索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 tokens 在位置嵌入中的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使 self-attention 模块的选定 head 无效的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。如果使用
past_key_values，则可以选择仅输入最后一个inputs_embeds（请参阅past_key_values）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - mc_token_ids (
torch.LongTensor，形状为(batch_size, num_choices)，可选，默认为输入中最后一个 token 的索引) — 每个输入序列中分类 token 的索引。 在范围[0, input_ids.size(-1) - 1]中选择。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于语言建模的标签。 请注意，标签在模型内部已移位，即您可以设置labels = input_ids。 索引在[-100, 0, ..., config.vocab_size - 1]中选择。 所有设置为-100的标签都将被忽略（掩蔽），损失仅针对[0, ..., config.vocab_size - 1]中的标签计算 - mc_labels (
torch.LongTensor，形状为(batch_size)，可选) — 用于计算多项选择分类损失的标签。 索引应在[0, ..., num_choices]中，其中 num_choices 是输入张量的第二个维度的大小。 （请参阅上面的 input_ids）
Returns
transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失。 -
mc_loss (
torch.FloatTensor，形状为(1,)，可选，当提供mc_labels时返回) — 多项选择分类损失。 -
logits (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
mc_logits (
torch.FloatTensor，形状为(batch_size, num_choices)) — 多项选择分类 head 的预测分数（SoftMax 之前每个选项的分数）。 -
past_key_values (
Tuple[Tuple[torch.Tensor]]，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的元组，包含形状为(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元组（embeddings 输出的元组 + 每层输出的元组），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。GPT2Attentions 权重在注意力 softmax 之后，用于计算 self-attention head 中的加权平均值。
GPT2DoubleHeadsModel forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, GPT2DoubleHeadsModel
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2DoubleHeadsModel.from_pretrained("openai-community/gpt2")
>>> # Add a [CLS] to the vocabulary (we should train it also!)
>>> num_added_tokens = tokenizer.add_special_tokens({"cls_token": "[CLS]"})
>>> # Update the model embeddings with the new vocabulary size
>>> embedding_layer = model.resize_token_embeddings(len(tokenizer))
>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> encoded_choices = [tokenizer.encode(s) for s in choices]
>>> cls_token_location = [tokens.index(tokenizer.cls_token_id) for tokens in encoded_choices]
>>> input_ids = torch.tensor(encoded_choices).unsqueeze(0) # Batch size: 1, number of choices: 2
>>> mc_token_ids = torch.tensor([cls_token_location]) # Batch size: 1
>>> outputs = model(input_ids, mc_token_ids=mc_token_ids)
>>> lm_logits = outputs.logits
>>> mc_logits = outputs.mc_logitsGPT2ForQuestionAnswering
class transformers.GPT2ForQuestionAnswering
< 源码 >( config )
参数
- config (GPT2Config) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型相关的权重，仅加载配置。 查看 from_pretrained() 方法来加载模型权重。
带有跨度分类 head 的 GPT-2 模型转换器，用于执行抽取式问答任务，例如 SQuAD（位于 hidden-states 输出顶部的线性层，用于计算 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 return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) —input_ids_length= 如果past_key_values为None，则为sequence_length，否则为past_key_values[0][0].shape[-2](输入过去键值状态的sequence_length)。 词汇表中输入序列 tokens 的索引。如果使用
past_key_values，则只有那些没有计算过 past 的input_ids应该作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Tuple[Tuple[torch.Tensor]]，长度为config.n_layers) — 包含模型计算的预计算隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。 可用于加速顺序解码。 已将其 past 提供给此模型的input_ids不应作为input_ids传递，因为它们已被计算过。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 未掩盖 的 tokens，
- 0 表示 已掩盖 的 tokens。
如果使用
past_key_values，则attention_mask需要包含用于past_key_values的掩码策略。 换句话说，attention_mask始终必须具有长度：len(past_key_values) + len(input_ids) - token_type_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)，可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定 head 无效的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想要比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。如果使用
past_key_values，则可以选择仅输入最后一个inputs_embeds（请参阅past_key_values）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的已标记跨度开始位置（索引）的标签。 位置被限制为序列的长度 (sequence_length)。 序列之外的位置不纳入损失计算的考虑范围。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的已标记跨度结束位置（索引）的标签。 位置被限制为序列的长度 (sequence_length)。 序列之外的位置不纳入损失计算的考虑范围。
Returns
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False，或者当 config.return_dict=False 时），包括各种元素，具体取决于配置 (GPT2Config) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 总跨度提取损失是开始和结束位置的交叉熵损失之和。 -
start_logits (
torch.FloatTensor，形状为(batch_size, sequence_length)) — 跨度开始得分（在 SoftMax 之前）。 -
end_logits (
torch.FloatTensor，形状为(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 之后的注意力权重，用于计算自注意力头中的加权平均值。
GPT2ForQuestionAnswering forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
此示例使用随机模型，因为真实的模型都非常大。 要获得正确的结果，您应该使用 openai-community/gpt2 而不是 openai-community/gpt2。 如果在加载该检查点时内存不足，您可以尝试在 from_pretrained 调用中添加 device_map="auto"。
示例
>>> from transformers import AutoTokenizer, GPT2ForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForQuestionAnswering.from_pretrained("openai-community/gpt2")
>>> 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.lossGPT2ForSequenceClassification
class transformers.GPT2ForSequenceClassification
< source >( config )
参数
- config (GPT2Config) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
顶端带有序列分类 head（线性层）的 GPT2 模型转换器。
GPT2ForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-1）一样。
由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。 如果在配置中定义了 pad_token_id，它会在每行中查找不是填充 token 的最后一个 token。 如果未定义 pad_token_id，它只会获取批次中每行的最后一个值。 由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测填充 token，因此它执行相同的操作（获取批次中每行的最后一个值）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = 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 return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) —input_ids_length= 如果past_key_values为None，则为sequence_length，否则为past_key_values[0][0].shape[-2](输入过去键值状态的sequence_length)。 词汇表中输入序列 tokens 的索引。如果使用
past_key_values，则只有那些没有计算过 past 的input_ids应该作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (
Tuple[Tuple[torch.Tensor]]，长度为config.n_layers) — 包含模型计算的预计算隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。 可用于加速顺序解码。 已将其 past 提供给此模型的input_ids不应作为input_ids传递，因为它们已被计算过。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 未掩盖 的 tokens，
- 0 表示 已掩盖 的 tokens。
如果使用
past_key_values，则attention_mask需要包含用于past_key_values的掩码策略。 换句话说，attention_mask始终必须具有长度：len(past_key_values) + len(input_ids) - token_type_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)，可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引从[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。从范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定 head 的掩码。掩码值从[0, 1]中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。如果使用了
past_key_values，则可以选择仅输入最后一个inputs_embeds（请参阅past_key_values）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失）。如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
Returns
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 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)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量)包含预先计算的隐藏状态（自注意力模块中的键和值），这些状态可以用于（请参阅
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则为嵌入输出的输出 + 每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
GPT2ForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, GPT2ForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/DialogRPT-updown")
>>> model = GPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown")
>>> 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 = GPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, GPT2ForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/DialogRPT-updown")
>>> model = GPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown", 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 = GPT2ForSequenceClassification.from_pretrained(
... "microsoft/DialogRPT-updown", 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).lossGPT2ForTokenClassification
class transformers.GPT2ForTokenClassification
< source >( config )
参数
- config (GPT2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
GPT2 模型，顶部带有一个 token 分类 head（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = 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 return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length如果past_key_values为None，否则为past_key_values[0][0].shape[-2]（输入 past key value 状态的sequence_length）。词汇表中输入序列 token 的索引。如果使用了
past_key_values，则只有未计算其 past 的input_ids应作为input_ids传递。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- past_key_values (长度为
config.n_layers的Tuple[Tuple[torch.Tensor]]) — 包含模型计算的预计算隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。可用于加速顺序解码。已将其 past 提供给此模型的input_ids不应作为input_ids传递，因为它们已被计算出来。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对 padding token 索引执行注意力的掩码。掩码值从[0, 1]中选择：- 1 表示 token 未被掩蔽，
- 0 表示 token 被掩蔽。
如果使用了
past_key_values，则attention_mask需要包含用于past_key_values的掩蔽策略。换句话说，attention_mask始终必须具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)，可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引从[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。从范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定 head 的掩码。掩码值从[0, 1]中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。如果使用了
past_key_values，则可以选择仅输入最后一个inputs_embeds（请参阅past_key_values）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的hidden_states部分了解更多细节。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算序列分类/回归损失的标签。 索引应在[0, ..., config.num_labels - 1]中。 如果config.num_labels == 1，则计算回归损失（均方误差损失）；如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
Returns
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
GPT2ForTokenClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GPT2ForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("brad1141/gpt2-finetuned-comp2")
>>> model = GPT2ForTokenClassification.from_pretrained("brad1141/gpt2-finetuned-comp2")
>>> 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
['Lead', 'Lead', 'Lead', 'Position', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead']
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.25TFGPT2Model
class transformers.TFGPT2Model
< source >( config *inputs **kwargs )
参数
- config (GPT2Config) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
裸 GPT2 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的头部。
该模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。 由于这种支持，当使用 model.fit() 等方法时，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 仅包含
input_ids且不包含其他内容的单个张量：model(input_ids) - 具有不同长度的列表，其中包含一个或多个输入张量，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length如果past_key_values为None，否则为past_key_values[0].shape[-2](输入过去键值状态的sequence_length)。 词汇表中输入序列标记的索引。如果使用
past_key_values，则仅应将未计算过去的输入 ID 作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 。
- past_key_values (长度为
config.n_layers的List[tf.Tensor]) — 包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的past_key_values输出）。 可用于加速顺序解码。 已将其过去状态提供给此模型的令牌 ID 不应作为输入 ID 传递，因为它们已被计算。 - attention_mask (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在填充令牌索引上执行注意力机制。 掩码值在[0, 1]中选择：- 1 表示令牌未被掩盖，
- 0 表示令牌被掩盖。
如果使用
past_key_values，则attention_mask需要包含用于past_key_values的掩码策略。 换句话说，attention_mask始终需要具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 段落令牌索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于句子 A 令牌，
- 1 对应于句子 B 令牌。
- position_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。 在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头无效的掩码。 掩码值在[0, 1]中选择：- 1 表示头未被掩盖，
- 0 表示头被掩盖。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。 此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（dropout 模块等某些模块在训练和评估之间具有不同的行为）。 - encoder_hidden_states (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。 如果模型配置为解码器，则在交叉注意力机制中使用。 - encoder_attention_mask (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对编码器输入的填充令牌索引执行注意力机制。 如果模型配置为解码器，则此掩码在交叉注意力机制中使用。 掩码值在[0, 1]中选择：- 1 表示令牌未被掩盖，
- 0 表示令牌被掩盖。
- past_key_values (长度为
config.n_layers的Tuple[Tuple[tf.Tensor]]) — 包含注意力块的预计算键和值隐藏状态。 可用于加速解码。 如果使用past，则用户可以选择仅输入最后decoder_input_ids（那些没有将其过去键值状态提供给此模型的）形状为(batch_size, 1)而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, 可选, 默认为True) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past）。 在训练期间设置为False，在生成期间设置为True
Returns
transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
last_hidden_state (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
List[tf.Tensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，其中每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)）。包含预先计算的隐藏状态（注意力模块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（每个嵌入输出 + 每个层的输出对应一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层对应一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层对应一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器互注意力层的注意力权重，在注意力 softmax 之后，用于计算互注意力头中的加权平均值。
TFGPT2Model 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFGPT2Model
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2Model.from_pretrained("openai-community/gpt2")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFGPT2LMHeadModel
class transformers.TFGPT2LMHeadModel
< source >( config *inputs **kwargs )
参数
- config (GPT2Config) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有语言建模头的 GPT2 模型 Transformer（线性层，其权重与输入嵌入层绑定）。
该模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。 由于这种支持，当使用 model.fit() 等方法时，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 仅包含
input_ids且不包含其他内容的单个张量：model(input_ids) - 具有不同长度的列表，其中包含一个或多个输入张量，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (形状为
(batch_size, input_ids_length)的Numpy array或tf.Tensor) —input_ids_length= 如果past_key_values为None则为sequence_length，否则为past_key_values[0].shape[-2](输入过去键值状态的sequence_length)。词汇表中输入序列 tokens 的索引。如果使用
past_key_values，则只有未计算过去的输入 ID 应作为input_ids传递。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past_key_values (长度为
config.n_layers的List[tf.Tensor]) — 包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的past_key_values输出）。可用于加速顺序解码。已将过去状态提供给此模型的 token ids 不应作为输入 ids 传递，因为它们已经被计算过。 - attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 用于避免在 padding token 索引上执行注意力的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 被 Mask。
如果使用
past_key_values，则attention_mask需要包含用于past_key_values的 Mask 策略。换句话说，attention_mask始终必须具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor, 可选) — 用于使自注意力模块的选定 head 无效的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 被 Mask。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（dropout 模块等某些模块在训练和评估之间具有不同的行为）。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — 编码器最后一层输出端的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor, 可选) — 用于避免对编码器输入的 padding token 索引执行注意力的 Mask。如果模型配置为解码器，则此 Mask 在交叉注意力中使用。 Mask 值在[0, 1]中选择：- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 被 Mask。
- past_key_values (长度为
config.n_layers的Tuple[Tuple[tf.Tensor]]) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用past，用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - use_cache (
bool, 可选, 默认为True) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past）。在训练期间设置为False，在生成期间设置为True - labels (形状为
(batch_size, sequence_length)的tf.Tensor, 可选) — 用于计算交叉熵分类损失的标签。索引应在[0, ..., config.vocab_size - 1]中。
Returns
transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个 tf.Tensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (GPT2Config) 和输入的各种元素。
-
loss (形状为
(n,)的tf.Tensor, 可选，其中 n 是非 Mask 标签的数量，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的tf.Tensor) — 语言建模 head 的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的 Tuple（embeddings 的输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层对应一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层对应一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器互注意力层的注意力权重，在注意力 softmax 之后，用于计算互注意力头中的加权平均值。
-
past_key_values (
List[tf.Tensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，其中每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)）。包含预先计算的隐藏状态（注意力模块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。
TFGPT2LMHeadModel 前向方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFGPT2LMHeadModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2LMHeadModel.from_pretrained("openai-community/gpt2")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFGPT2DoubleHeadsModel
class transformers.TFGPT2DoubleHeadsModel
< source >( config *inputs **kwargs )
参数
- config (GPT2Config) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有语言建模头和多项选择分类头的 GPT2 模型 Transformer，例如用于 RocStories/SWAG 任务。这两个头是两个线性层。语言建模头的权重与其输入嵌入层绑定，分类头将输入序列中指定的分类 token 索引的输入作为输入）。
该模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。 由于这种支持，当使用 model.fit() 等方法时，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 仅包含
input_ids且不包含其他内容的单个张量：model(input_ids) - 具有不同长度的列表，其中包含一个或多个输入张量，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None mc_token_ids: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (形状为
(batch_size, input_ids_length)的Numpy array或tf.Tensor) — 如果past_key_values为None，则input_ids_length=sequence_length，否则input_ids_length=past_key_values[0].shape[-2](输入过去键值状态的sequence_length)。 词汇表中输入序列 tokens 的索引。如果使用了
past_key_values，则只有未计算过去值的 input IDs 应作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past_key_values (长度为
config.n_layers的List[tf.Tensor]) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。 可以用于加速顺序解码。 已经为此模型提供过去值的 token IDs 不应作为 input IDs 传递，因为它们已经被计算过了。 - attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 掩码，用于避免在 padding token 索引上执行注意力机制。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩码，
- 0 表示 tokens 被掩码。
如果使用了
past_key_values，则attention_mask需要包含用于past_key_values的掩码策略。 换句话说，attention_mask始终必须具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor, 可选) — 掩码，用于使自注意力模块的选定 head 失效。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。 此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用该模型（dropout 模块等某些模块在训练和评估之间具有不同的行为）。 - mc_token_ids (形状为
(batch_size, num_choices)的tf.Tensor或Numpy array, 可选, 默认为输入的最后一个 token 的索引) — 每个输入序列中分类 token 的索引。 在范围[0, input_ids.size(-1) - 1]中选择。
Returns
transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或 tuple(tf.Tensor)
一个 transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或 tf.Tensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
logits (形状为
(batch_size, num_choices, sequence_length, config.vocab_size)的tf.Tensor) — 语言建模 head 的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
mc_logits (形状为
(batch_size, num_choices)的tf.Tensor) — 多项选择分类 head 的预测分数（SoftMax 之前每个选项的分数）。 -
past_key_values (
List[tf.Tensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，其中每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)）。包含预先计算的隐藏状态（注意力模块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的 Tuple（embeddings 的输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层对应一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFGPT2DoubleHeadsModel forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFGPT2DoubleHeadsModel
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2DoubleHeadsModel.from_pretrained("openai-community/gpt2")
>>> # Add a [CLS] to the vocabulary (we should train it also!)
>>> num_added_tokens = tokenizer.add_special_tokens({"cls_token": "[CLS]"})
>>> embedding_layer = model.resize_token_embeddings(
... len(tokenizer)
... ) # Update the model embeddings with the new vocabulary size
>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> encoded_choices = [tokenizer.encode(s) for s in choices]
>>> cls_token_location = [tokens.index(tokenizer.cls_token_id) for tokens in encoded_choices]
>>> input_ids = tf.constant(encoded_choices)[None, :] # Batch size: 1, number of choices: 2
>>> mc_token_ids = tf.constant([cls_token_location]) # Batch size: 1
>>> outputs = model(input_ids, mc_token_ids=mc_token_ids)
>>> lm_prediction_scores, mc_prediction_scores = outputs[:2]TFGPT2ForSequenceClassification
class transformers.TFGPT2ForSequenceClassification
< source >( config *inputs **kwargs )
参数
- config (GPT2Config) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
顶端带有序列分类 head（线性层）的 GPT2 模型转换器。
TFGPT2ForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-1）一样。
由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。 如果在配置中定义了 pad_token_id，它会在每行中查找不是填充 token 的最后一个 token。 如果未定义 pad_token_id，它只会获取批次中每行的最后一个值。 由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测填充 token，因此它执行相同的操作（获取批次中每行的最后一个值）。
该模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。 由于这种支持，当使用 model.fit() 等方法时，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 仅包含
input_ids且不包含其他内容的单个张量：model(input_ids) - 具有不同长度的列表，其中包含一个或多个输入张量，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 subclassing 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或 tuple(tf.Tensor)
参数
- input_ids (形状为
(batch_size, input_ids_length)的Numpy array或tf.Tensor) — 如果past_key_values为None，则input_ids_length=sequence_length，否则input_ids_length=past_key_values[0].shape[-2](输入过去键值状态的sequence_length)。 词汇表中输入序列 tokens 的索引。如果使用了
past_key_values，则只有未计算过去值的 input IDs 应作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past_key_values (长度为
config.n_layers的List[tf.Tensor]) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。 可以用于加速顺序解码。 已经为此模型提供过去值的 token IDs 不应作为 input IDs 传递，因为它们已经被计算过了。 - attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 掩码，用于避免在 padding token 索引上执行注意力机制。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩码，
- 0 表示 tokens 被掩码。
如果使用了
past_key_values，则attention_mask需要包含用于past_key_values的掩码策略。 换句话说，attention_mask始终必须具有以下长度：len(past_key_values) + len(input_ids) - token_type_ids (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 不被屏蔽，
- 0 表示 head 被屏蔽。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于计算交叉熵分类损失的标签。索引应在[0, ..., config.vocab_size - 1]范围内。
Returns
transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (GPT2Config) 和输入。
-
loss (
tf.Tensor，形状为(batch_size, )，可选，当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
tf.Tensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（SoftMax 之前）。 -
past_key_values (
List[tf.Tensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，其中每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)）。包含预先计算的隐藏状态（注意力模块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的 Tuple（embeddings 的输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层对应一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFGPT2ForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFGPT2ForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/DialogRPT-updown")
>>> model = TFGPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])>>> # 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 = TFGPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFSequenceClassifierOutputWithPast
class transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast
< source >( loss: tf.Tensor | None = None logits: tf.Tensor = None past_key_values: List[tf.Tensor] | None = None hidden_states: Tuple[tf.Tensor] | None = None attentions: Tuple[tf.Tensor] | None = None )
参数
- loss (
tf.Tensor，形状为(batch_size, )，可选，当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 - logits (
tf.Tensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（SoftMax 之前）。 - past_key_values (
List[tf.Tensor]，可选，当传递use_cache=True或当config.use_cache=True时返回) —tf.Tensor列表，长度为config.n_layers，每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含预先计算的隐藏状态（注意力块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。 - hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（每个层的输出一个，加上初始嵌入输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上初始嵌入输出。
- attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力 head 中的加权平均值。
句子分类模型输出的基类。
TFGPT2Tokenizer
class transformers.TFGPT2Tokenizer
< source >( vocab: typing.Dict[str, int] merges: typing.List[str] max_length: int = None pad_token_id: int = None )
这是一个用于 GPT2 的图内分词器。它应该与其他分词器类似地初始化，使用 from_pretrained() 方法。它也可以使用 from_tokenizer() 方法初始化，该方法从现有的标准分词器对象导入设置。
与 Hugging Face 的其他分词器不同，图内分词器实际上是 Keras 层，旨在在调用模型时运行，而不是在预处理期间运行。因此，与标准分词器类相比，它们的选项有些受限。当您想要创建一个端到端模型，直接从 tf.string 输入到输出时，它们最有用。
从配置创建 TFGPT2Tokenizer
from_pretrained
< source >( pretrained_model_name_or_path: typing.Union[str, os.PathLike] *init_inputs **kwargs )
从预训练的 GPT2Tokenizer 创建 TFGPT2Tokenizer
from_tokenizer
< source >( tokenizer: GPT2Tokenizer *args **kwargs )
从 GPT2Tokenizer 创建 TFGPT2Tokenizer
FlaxGPT2Model
class transformers.FlaxGPT2Model
< source >( config: GPT2Config input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (GPT2Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 之一。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
裸 GPT2 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的头部。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法 (例如下载或保存、调整输入嵌入大小、剪枝头等)。
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档以获取与通用用法和行为相关的所有事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< source >( input_ids attention_mask = None position_ids = None encoder_hidden_states: typing.Optional[jax.Array] = None encoder_attention_mask: typing.Optional[jax.Array] = None params: dict = None past_key_values: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, input_ids_length)的numpy.ndarray) —input_ids_length=sequence_length。词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 掩码，以避免在 padding token 索引上执行 attention。掩码值在[0, 1]中选择：- 1 代表 未被掩码 的 tokens，
- 0 代表 被掩码 的 tokens。
- position_ids (形状为
(batch_size, sequence_length)的numpy.ndarray, 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - past_key_values (
Dict[str, np.ndarray], 可选, 由init_cache返回或在传递之前的past_key_values时返回) — 预计算的隐藏状态（attention 块中的键和值）字典，可用于快速自回归解码。预计算的键和值隐藏状态的形状为 [batch_size, max_length]。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attentions 张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
Returns
transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），其中包含取决于配置 (GPT2Config) 和输入的各种元素。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最后一层的输出处的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
tuple(tuple(jnp.ndarray)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(jnp.ndarray))元组，每个元组具有 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(jnp.ndarray), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组 (嵌入输出一个，每层输出一个)，形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组 (每层一个)，形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True且config.add_cross_attention=True或当config.output_attentions=True时返回) —jnp.ndarray元组 (每层一个)，形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器互注意力层的注意力权重，在注意力 softmax 之后，用于计算互注意力头中的加权平均值。
FlaxGPT2PreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxGPT2Model
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = FlaxGPT2Model.from_pretrained("openai-community/gpt2")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxGPT2LMHeadModel
class transformers.FlaxGPT2LMHeadModel
< source >( config: GPT2Config input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (GPT2Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32,jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 之一。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
带有语言建模头的 GPT2 模型 Transformer（线性层，其权重与输入嵌入层绑定）。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法 (例如下载或保存、调整输入嵌入大小、剪枝头等)。
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档以获取与通用用法和行为相关的所有事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< source >( input_ids attention_mask = None position_ids = None encoder_hidden_states: typing.Optional[jax.Array] = None encoder_attention_mask: typing.Optional[jax.Array] = None params: dict = None past_key_values: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarrayof shape(batch_size, input_ids_length)) —input_ids_length=sequence_length. Indices of input sequence tokens in the vocabulary.Indices can be obtained using AutoTokenizer. See PreTrainedTokenizer.encode() and PreTrainedTokenizer.call() for details.
- attention_mask (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in[0, 1]:- 1 for tokens that are not masked,
- 0 for tokens that are masked.
- position_ids (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range[0, config.max_position_embeddings - 1]. - past_key_values (
Dict[str, np.ndarray], optional, returned byinit_cacheor when passing previouspast_key_values) — Dictionary of pre-computed hidden-states (key and values in the attention blocks) that can be used for fast auto-regressive decoding. Pre-computed key and value hidden-states are of shape [batch_size, max_length]. - output_attentions (
bool, optional) — Whether or not to return the attentions tensors of all attention layers. Seeattentionsunder returned tensors for more detail. - output_hidden_states (
bool, optional) — Whether or not to return the hidden states of all layers. Seehidden_statesunder returned tensors for more detail. - return_dict (
bool, optional) — Whether or not to return a ModelOutput instead of a plain tuple.
Returns
transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
A transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (GPT2Config) and inputs.
-
logits (
jnp.ndarrayof shape(batch_size, sequence_length, config.vocab_size)) — Prediction scores of the language modeling head (scores for each vocabulary token before SoftMax). -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组 (嵌入输出一个，每层输出一个)，形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出以及初始 embedding 输出处的隐藏状态。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组 (每层一个)，形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple ofjnp.ndarray(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).互注意力 softmax 之后的互注意力权重，用于计算互注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(jnp.ndarray)), optional, returned whenuse_cache=Trueis passed or whenconfig.use_cache=True) — Tuple ofjnp.ndarraytuples of lengthconfig.n_layers, with each tuple containing the cached key, value states of the self-attention and the cross-attention layers if model is used in encoder-decoder setting. Only relevant ifconfig.is_decoder = True.包含预先计算的隐藏状态（注意力模块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。
FlaxGPT2PreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxGPT2LMHeadModel
>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = FlaxGPT2LMHeadModel.from_pretrained("openai-community/gpt2")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]