Transformers 文档

OpenAI GPT

Transformers

加入 Hugging Face 社区

并获得增强型文档体验

协作模型、数据集和 Spaces

使用加速推理加快示例速度

在文档主题之间切换

开始使用

OpenAI GPT

概述

OpenAI GPT 模型由 Alec Radford、Karthik Narasimhan、Tim Salimans 和 Ilya Sutskever 在通过生成式预训练改进语言理解中提出。它是一种因果（单向）Transformer，使用语言建模在具有长距离依赖关系的大型语料库（多伦多书籍语料库）上进行预训练。

论文中的摘要如下

自然语言理解包含各种各样的任务，例如文本蕴涵、问答、语义相似性评估和文档分类。虽然大量的未标记文本语料库很丰富，但用于学习这些特定任务的标记数据却很稀缺，这使得判别式训练模型难以达到令人满意的性能。我们证明，通过在大量的未标记文本语料库上对语言模型进行生成式预训练，然后针对每个特定任务进行判别式微调，可以在这些任务上实现大幅提升。与之前的研究方法不同，我们在微调过程中使用了任务感知的输入转换，以实现有效的迁移，同时对模型架构的修改要求最少。我们在自然语言理解的各种基准测试中证明了我们的方法的有效性。我们的通用任务无关模型优于专门针对每个任务而设计的架构的判别式训练模型，在所研究的 12 个任务中的 9 个任务上显著提高了现有技术水平。

Write With Transformer 是由 Hugging Face 创建和托管的网页应用程序，展示了几个模型的生成能力。GPT 是其中之一。

该模型由 thomwolf 提供。原始代码可以在这里找到。

使用技巧

GPT 是一个具有绝对位置嵌入的模型，因此通常建议在右侧填充输入而不是左侧。
GPT 使用因果语言建模 (CLM) 目标进行训练，因此在预测序列中的下一个标记方面非常强大。利用此功能，GPT-2 可以生成语法连贯的文本，如 _run_generation.py_ 示例脚本中所见。

注意

如果要重现 _OpenAI GPT_ 论文中的原始标记化过程，需要安装 _ftfy_ 和 _SpaCy_。

pip install spacy ftfy==4.4.3
python -m spacy download en

如果不安装 _ftfy_ 和 _SpaCy_，OpenAIGPTTokenizer 将默认使用 BERT 的 _BasicTokenizer_，然后进行字节对编码（这对于大多数用途来说应该没问题，不用担心）。

资源

一系列官方 Hugging Face 和社区（用 🌎 表示）资源，可帮助您开始使用 OpenAI GPT。如果您有兴趣提交资源以包含在此处，请随时打开拉取请求，我们将对其进行审查！理想情况下，该资源应该展示一些新内容，而不是重复现有的资源。

文本分类

一篇关于使用 SetFit 优于 OpenAI GPT-3 进行文本分类的博文。
另见：文本分类任务指南

文本生成

一篇关于如何使用 Hugging Face 微调非英语 GPT-2 模型的博文。
一篇关于如何生成文本：使用不同的解码方法进行 Transformers 语言生成的博文，使用 GPT-2。
一篇关于从头开始训练 CodeParrot 🦜 的博文，这是一个大型 GPT-2 模型。
一篇关于使用 TensorFlow 和 XLA 加快文本生成速度的博文，使用 GPT-2。
一篇关于如何使用 Megatron-LM 训练语言模型的博文，使用 GPT-2 模型。
一篇关于如何微调 GPT2 以生成您最喜欢的艺术家的风格的歌词的笔记本。 🌎
一篇关于如何微调 GPT2 以生成您最喜欢的 Twitter 用户风格的推文的笔记本。 🌎
因果语言建模的 🤗 Hugging Face 课程章节。
OpenAIGPTLMHeadModel 受此因果语言建模示例脚本、文本生成示例脚本和笔记本支持。
TFOpenAIGPTLMHeadModel 受此因果语言建模示例脚本和笔记本支持。
另见：因果语言建模任务指南

标记分类

一篇关于字节对编码标记化的课程资料。

OpenAIGPTConfig

class transformers.OpenAIGPTConfig

< 源代码 >

( vocab_size = 40478 n_positions = 512 n_embd = 768 n_layer = 12 n_head = 12 afn = 'gelu' 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 **kwargs )

参数

vocab_size (int, 可选, 默认值为 40478) — GPT-2 模型的词汇量大小。定义了调用 OpenAIGPTModel 或 TFOpenAIGPTModel 时，通过 inputs_ids 可以表示的不同 token 的数量。
n_positions (int, 可选, 默认值为 512) — 该模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。
n_embd (int, 可选, 默认值为 768) — 嵌入和隐藏状态的维度。
n_layer (int, 可选, 默认值为 12) — Transformer 编码器中的隐藏层数量。
n_head (int, 可选, 默认值为 12) — Transformer 编码器中每个注意力层的注意力头数。
afn (str 或 Callable, 可选, 默认值为 "gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，则支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
resid_pdrop (float, 可选, 默认值为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
embd_pdrop (int, 可选, 默认值为 0.1) — 嵌入的 dropout 比例。
attn_pdrop (float, 可选, 默认值为 0.1) — 注意力的 dropout 比例。
layer_norm_epsilon (float, 可选, 默认值为 1e-05) — 层归一化层中使用的 epsilon 值。
summary_type (str, 可选, 默认为 "cls_index") — 用于执行序列摘要时的参数，在模型 OpenAIGPTDoubleHeadsModel 和 OpenAIGPTDoubleHeadsModel 中使用。

必须是以下选项之一：
- "last": 获取最后一个 token 的隐藏状态（如 XLNet）。
- "first": 获取第一个 token 的隐藏状态（如 BERT）。
- "mean": 获取所有 token 隐藏状态的平均值。
- "cls_index": 提供一个分类 token 位置的张量（如 GPT/GPT-2）。
- "attn": 目前未实现，使用多头注意力机制。
summary_use_proj (bool, 可选, 默认为 True) — 用于执行序列摘要时的参数，在模型 OpenAIGPTDoubleHeadsModel 和 OpenAIGPTDoubleHeadsModel 中使用。

是否在向量提取后添加投影。
summary_activation (str, 可选) — 用于执行序列摘要时的参数，在模型 OpenAIGPTDoubleHeadsModel 和 OpenAIGPTDoubleHeadsModel 中使用。

传递 "tanh" 用于对输出进行 tanh 激活，任何其他值将导致不进行激活。
summary_proj_to_labels (bool, 可选, 默认为 True) — 用于执行序列摘要时的参数，在模型 OpenAIGPTDoubleHeadsModel 和 OpenAIGPTDoubleHeadsModel 中使用。

投影输出是否应该有 config.num_labels 或 config.hidden_size 类。
summary_first_dropout (float, 可选, 默认为 0.1) — 用于执行序列摘要时的参数，在模型 OpenAIGPTDoubleHeadsModel 和 OpenAIGPTDoubleHeadsModel 中使用。

投影和激活后使用的 dropout 比率。

这是一个配置类，用于存储 OpenAIGPTModel 或 TFOpenAIGPTModel 的配置。它用于根据指定的参数实例化一个 GPT 模型，定义模型架构。用默认值实例化一个配置将产生与 OpenAI 的 GPT openai-community/openai-gpt 架构类似的配置。

配置对象继承自 PretrainedConfig，可以用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import OpenAIGPTConfig, OpenAIGPTModel

>>> # Initializing a GPT configuration
>>> configuration = OpenAIGPTConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = OpenAIGPTModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

OpenAIGPTTokenizer

class transformers.OpenAIGPTTokenizer

< 源代码 >

( vocab_file merges_file unk_token = '<unk>' **kwargs )

参数

vocab_file (str) — 词汇文件路径。
merges_file (str) — 合并文件路径。
unk_token (str, 可选, 默认值 "<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，而是设置为此标记。

构建 GPT 标记器。基于字节对编码，具有以下特殊之处

将所有输入转换为小写，
如果安装了 SpaCy 标记器和 ftfy，则使用它们进行预 BPE 标记化，否则回退到 BERT 的 BasicTokenizer。

此标记器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

< 源代码 >

( save_directory: str filename_prefix: Optional = None )

OpenAIGPTTokenizerFast

类 transformers.OpenAIGPTTokenizerFast

< 源代码 >

( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<unk>' **kwargs )

参数

vocab_file (str) — 词汇文件路径。
merges_file (str) — 合并文件路径。
unk_token (str, 可选, 默认值 "<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，而是设置为此标记。

构建“快速” GPT 标记器（由 HuggingFace 的 tokenizers 库支持）。基于字节对编码，具有以下特殊之处

将所有输入转换为小写
使用 BERT 的 BasicTokenizer 进行预 BPE 标记化

此标记器继承自 PreTrainedTokenizerFast，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

OpenAI 特定输出

类 transformers.models.openai.modeling_openai.OpenAIGPTDoubleHeadsModelOutput

< 源代码 >

( loss: Optional = None mc_loss: Optional = None logits: FloatTensor = None mc_logits: FloatTensor = None hidden_states: Optional = None

参数

loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失。
mc_loss (torch.FloatTensor 形状为 (1,)，可选，当提供 mc_labels 时返回) — 多项选择分类损失。
logits (torch.FloatTensor 形状为 (batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。
mc_logits (torch.FloatTensor 形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数（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 之后的注意力权重，用于计算自注意力头的加权平均值。

用于预测两个句子是否连续的模型输出的基类。

class transformers.models.openai.modeling_tf_openai.TFOpenAIGPTDoubleHeadsModelOutput

< 源代码 >

( logits: tf.Tensor = None mc_logits: tf.Tensor = 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 之前的每个选项的分数）。
attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — tf.Tensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length).

注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。

用于预测两个句子是否连续的模型输出的基类。

Pytorch

隐藏 Pytorch 内容

OpenAIGPTModel

class transformers.OpenAIGPTModel

< 源代码 >

( config )

参数

config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

不带任何特定头的 OpenAI GPT 变压器模型，输出原始隐藏状态。

此模型继承自 PreTrainedModel。检查超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。

此模型也是 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 output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择掩码值：
- 1 用于未屏蔽的标记，
- 0 用于屏蔽的标记。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。在 [0, 1] 中选择索引：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 ID？
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 索引转换为关联向量比模型内部嵌入查找矩阵有更多控制权，这将非常有用。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，它包含取决于配置 (OpenAIGPTConfig) 和输入的不同元素。

last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

该 OpenAIGPTModel 正向方法覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在此函数中定义，但应随后调用 Module 实例而不是此实例，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, OpenAIGPTModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = OpenAIGPTModel.from_pretrained("openai-community/openai-gpt")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

OpenAIGPTLMHeadModel

class transformers.OpenAIGPTLMHeadModel

< 源代码 >

( config )

参数

config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

OpenAI GPT 模型转换器，顶部有一个语言建模头 (权重与输入嵌入绑定的线性层)。

此模型继承自 PreTrainedModel。检查超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。

此模型也是 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 labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

索引可以通过 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择掩码值：
- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 中选择：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
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 索引转换为关联的向量，这将非常有用。
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] 中的标签计算

transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或者 config.return_dict=False），包含各种元素，具体取决于配置 (OpenAIGPTConfig) 和输入。

loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 语言建模损失（用于下一个词预测）。
logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 OpenAIGPTLMHeadModel 的 forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoTokenizer, OpenAIGPTLMHeadModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = OpenAIGPTLMHeadModel.from_pretrained("openai-community/openai-gpt")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

OpenAIGPTDoubleHeadsModel

class transformers.OpenAIGPTDoubleHeadsModel

< 源代码 >

( config )

参数

config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

OpenAI GPT 模型转换器，在顶部有一个语言建模和多项选择分类头，例如用于 RocStories/SWAG 任务。这两个头是两个线性层。语言建模头的权重与输入嵌入绑定，分类头将输入序列中指定分类标记索引处的输入作为输入。)

此模型继承自 PreTrainedModel。检查超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。

此模型也是 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 mc_token_ids: Optional = None labels: Optional = None mc_labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.openai.modeling_openai.OpenAIGPTDoubleHeadsModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列词语在词汇表中的索引。

索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 避免对填充令牌索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示未屏蔽的令牌，
- 0 表示屏蔽的令牌。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 分段令牌索引，指示输入的第一部分和第二部分。索引选择在 [0, 1] 中：
- 0 对应于句子 A 令牌，
- 1 对应于句子 B 令牌。
什么是令牌类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列令牌的位置索引。选择在 [0, config.max_position_embeddings - 1] 范围内。

什么是位置 ID？
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 索引转换为关联向量有更多控制权，这将很有用，而不是模型的内部嵌入查找矩阵。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
mc_token_ids (torch.LongTensor 形状为 (batch_size, num_choices)，可选，默认为输入最后一个令牌的索引) — 每个输入序列中分类令牌的索引。选择在 [0, input_ids.size(-1) - 1] 范围内。
labels (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 用于语言建模的标签。请注意，标签在模型内部被移位，即您可以设置 labels = input_ids 索引选择在 [-1, 0, ..., config.vocab_size] 中设置为 -100 的所有标签都将被忽略（屏蔽），损失仅针对 [0, ..., config.vocab_size] 中的标签计算。
mc_labels (torch.LongTensor 形状为 (batch_size)，可选) — 用于计算多选分类损失的标签。索引应在 [0, ..., num_choices] 中，其中 num_choices 是输入张量的第二维的大小。 (参见上面的 input_ids)

transformers.models.openai.modeling_openai.OpenAIGPTDoubleHeadsModelOutput 或者 tuple(torch.FloatTensor)

一个 transformers.models.openai.modeling_openai.OpenAIGPTDoubleHeadsModelOutput 或者 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含取决于配置 (OpenAIGPTConfig) 和输入的各种元素。

loss (torch.FloatTensor 形状为 (1,)，可选，在提供 labels 时返回) — 语言建模损失。
mc_loss (torch.FloatTensor 形状为 (1,)，可选，在提供 mc_labels 时返回) — 多选分类损失。
logits (torch.FloatTensor 形状为 (batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测得分 (SoftMax 之前的每个词汇表标记的得分)。
mc_logits (torch.FloatTensor 形状为 (batch_size, num_choices)) — 多选分类头的预测得分 (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 之后的注意力权重，用于计算自注意力头中的加权平均值。

OpenAIGPTDoubleHeadsModel 正向方法，覆盖 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, OpenAIGPTDoubleHeadsModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = OpenAIGPTDoubleHeadsModel.from_pretrained("openai-community/openai-gpt")
>>> tokenizer.add_special_tokens(
...     {"cls_token": "[CLS]"}
... )  # Add a [CLS] to the vocabulary (we should train it also!)
>>> model.resize_token_embeddings(len(tokenizer))

>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> input_ids = torch.tensor([tokenizer.encode(s) for s in choices]).unsqueeze(0)  # Batch size 1, 2 choices
>>> mc_token_ids = torch.tensor([input_ids.size(-1) - 1, input_ids.size(-1) - 1]).unsqueeze(0)  # Batch size 1

>>> outputs = model(input_ids, mc_token_ids=mc_token_ids)
>>> lm_logits = outputs.logits
>>> mc_logits = outputs.mc_logits

OpenAIGPTForSequenceClassification

class transformers.OpenAIGPTForSequenceClassification

< source >

( config )

参数

config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

原始 OpenAI GPT 模型转换器，顶部有一个序列分类头 (线性层)。OpenAIGPTForSequenceClassification 使用最后一个标记来进行分类，就像其他因果模型 (例如 GPT-2) 一样。由于它对最后一个标记进行分类，因此需要知道最后一个标记的位置。如果配置中定义了 pad_token_id，它会找到每行中不是填充标记的最后一个标记。如果没有定义 pad_token_id，它只是取批次中每行中的最后一个值。由于它无法在传递 inputs_embeds 而不是 input_ids 时猜测填充标记，因此它执行相同的操作 (取批次中每行中的最后一个值)。

此模型继承自 PreTrainedModel。检查超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解有关一般用法和行为的所有事项。

forward

< source >

( 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 labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或者 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示未被掩盖的标记
- 0 表示被掩盖的标记
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在 [0, 1] 中：
- 0 对应于句子 A 标记
- 1 对应于句子 B 标记
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择在范围 [0, config.max_position_embeddings - 1] 中。

什么是位置 ID？
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 索引转换为关联向量（而不是模型的内部嵌入查找矩阵）有更多控制权，这将非常有用。
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，则计算分类损失（交叉熵）。

transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (OpenAIGPTConfig) 和输入的不同元素。

loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 分类（或如果 config.num_labels==1 则为回归）损失。
logits (torch.FloatTensor 形状为 (batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1 则为回归）分数（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

OpenAIGPTForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, OpenAIGPTForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = OpenAIGPTForSequenceClassification.from_pretrained("openai-community/openai-gpt")

>>> 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 = OpenAIGPTForSequenceClassification.from_pretrained("openai-community/openai-gpt", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, OpenAIGPTForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = OpenAIGPTForSequenceClassification.from_pretrained("openai-community/openai-gpt", 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 = OpenAIGPTForSequenceClassification.from_pretrained(
...     "openai-community/openai-gpt", 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

TensorFlow

隐藏 TensorFlow 内容

TFOpenAIGPTModel

class transformers.TFOpenAIGPTModel

< source >

( config *inputs **kwargs )

参数

config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

不带任何特定头的 OpenAI GPT 变压器模型，输出原始隐藏状态。

此模型继承自 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})

请注意，在使用子类化创建模型和层时，您无需担心任何这些，因为您可以像传递给任何其他 Python 函数一样传递输入！

call

< source >

( input_ids: TFModelInputType | None = 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 output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)

参数

input_ids (Numpy 数组 或 tf.Tensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什么是输入 ID？
attention_mask (tf.Tensor 或 Numpy 数组 形状为 (batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值：
- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy 数组 形状为 (batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 ID？
position_ids (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围在 [0, config.max_position_embeddings - 1] 内。

什么是位置 ID？
head_mask (tf.Tensor 或 Numpy array 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 内：
- 1 表示头部未被掩码，
- 0 表示头部被掩码。
inputs_embeds (tf.Tensor 或 Numpy array 形状为 (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 模块，在训练和评估之间有不同的行为）。

transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (OpenAIGPTConfig) 和输入的不同元素。

last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。
hidden_states (tuple(tf.FloatTensor)，可选，在传递了 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

The TFOpenAIGPTModel 正向方法，重写 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFOpenAIGPTModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = TFOpenAIGPTModel.from_pretrained("openai-community/openai-gpt")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)

>>> last_hidden_states = outputs.last_hidden_state

TFOpenAIGPTLMHeadModel

class transformers.TFOpenAIGPTLMHeadModel

< source >

( config *inputs **kwargs )

参数

此模型继承自 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})
请注意，在使用子类化创建模型和层时，您无需担心任何这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< 源代码 >
( input_ids: TFModelInputType | None = 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 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.TFCausalLMOutput 或 tuple(tf.Tensor)
参数

input_ids (Numpy 数组 或 tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词表的索引。

索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什么是输入 ID？
attention_mask (tf.Tensor 或 Numpy 数组 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值在 [0, 1] 中选择：

1 表示未屏蔽的词元，

0 表示屏蔽的词元。

什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy 数组 形状为 (batch_size, sequence_length), 可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：

0 对应于句子 A 词元，

1 对应于句子 B 词元。

什么是词元类型 ID？
position_ids (tf.Tensor 或 Numpy 数组 形状为 (batch_size, sequence_length), 可选) — 输入序列词元在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
head_mask (tf.Tensor 或 Numpy 数组 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值在 [0, 1] 中选择：

1 表示头部未屏蔽，

0 表示头部屏蔽。

inputs_embeds (tf.Tensor 或 Numpy 数组 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递 input_ids。如果您想对如何将 input_ids 索引转换为关联向量比模型的内部嵌入查找矩阵有更多控制权，这将非常有用。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回的张量中的 attentions。此参数只能在急切模式下使用，在图模式下，配置中的值将被使用。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。此参数仅可在急切模式下使用，在图形模式下将使用配置中的值。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是简单元组。此参数可在急切模式下使用，在图形模式下，该值将始终设置为 True。
training (bool, 可选，默认为 False) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。
labels (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 中。

返回

transformers.modeling_tf_outputs.TFCausalLMOutput 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFCausalLMOutput 或 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置的各种元素（OpenAIGPTConfig）和输入。

loss (tf.Tensor 形状为 (n,), 可选，其中 n 是非掩码标签的数量，当提供 labels 时返回) — 语言建模损失（用于下一个标记预测）。

logits (tf.Tensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（在 SoftMax 之前每个词汇表标记的分数）。

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 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFOpenAIGPTLMHeadModel 正向方法，覆盖 __call__ 特殊方法。

虽然正向传递的配方需要在此函数中定义，但应随后调用 Module 实例而不是此实例，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFOpenAIGPTLMHeadModel >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt") >>> model = TFOpenAIGPTLMHeadModel.from_pretrained("openai-community/openai-gpt") >>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf") >>> outputs = model(inputs) >>> logits = outputs.logits

TFOpenAIGPTDoubleHeadsModel

class transformers.TFOpenAIGPTDoubleHeadsModel

< 源代码 >

( config *inputs **kwargs )

参数

config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

此模型继承自 TFPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。

此模型也是 keras.Model 的子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以获取有关一般使用和行为的所有事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

将所有输入作为关键字参数（如 PyTorch 模型），或
将所有输入作为第一个位置参数中的列表、元组或字典。

单个张量，其中只有 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})

请注意，在使用子类化创建模型和层时，您无需担心任何这些，因为您可以像传递给任何其他 Python 函数一样传递输入！

call

< 源代码 >

参数

input_ids (Numpy array 或 tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什么是输入 ID？
attention_mask (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充词元索引执行注意力。掩码值选择在 [0, 1] 中：
- 1 表示未掩码的词元，
- 0 表示掩码的词元。
什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length), 可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引选择在 [0, 1] 中：
- 0 对应于句子 A 词元，
- 1 对应于句子 B 词元。
什么是词元类型 ID？
position_ids (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列词元的位置索引。选择范围为 [0, config.max_position_embeddings - 1]。

什么是位置 ID？
head_mask (tf.Tensor 或 Numpy array 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码以使自注意力模块的选定头无效。掩码值选择在 [0, 1] 中：
- 1 表示头未掩码，
- 0 表示头掩码。
inputs_embeds (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以在不传递 input_ids 的情况下，选择直接传递嵌入表示。如果您希望对如何将 input_ids 索引转换为关联的向量比模型的内部嵌入查找矩阵有更多控制权，这将很有用。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在急切模式下使用，在图形模式下，该值将始终设置为 True。
mc_token_ids (tf.Tensor 或 Numpy array 形状为 (batch_size, num_choices)，可选，默认为输入最后一个 token 的索引) — 每个输入序列中分类 token 的索引。选择范围为 [0, input_ids.size(-1) - 1]。

transformers.models.openai.modeling_tf_openai.TFOpenAIGPTDoubleHeadsModelOutput 或 tuple(tf.Tensor)

一个 transformers.models.openai.modeling_tf_openai.TFOpenAIGPTDoubleHeadsModelOutput 或一个 tf.Tensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含根据配置 (OpenAIGPTConfig) 和输入而变化的各种元素。

logits (tf.Tensor 形状为 (batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测分数 (SoftMax 之前的每个词表 token 的分数)。
mc_logits (tf.Tensor 形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数 (SoftMax 之前的每个选项的分数)。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

The TFOpenAIGPTDoubleHeadsModel 正向方法，覆盖了 __call__ 特殊方法。

示例

>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFOpenAIGPTDoubleHeadsModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = TFOpenAIGPTDoubleHeadsModel.from_pretrained("openai-community/openai-gpt")

>>> # Add a [CLS] to the vocabulary (we should train it also!)
>>> tokenizer.add_special_tokens({"cls_token": "[CLS]"})
>>> model.resize_token_embeddings(len(tokenizer))  # Update the model embeddings with the new vocabulary size
>>> print(tokenizer.cls_token_id, len(tokenizer))  # The newly token the last token of the vocabulary

>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> encoding = tokenizer(choices, return_tensors="tf")
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> inputs["mc_token_ids"] = tf.constant(
...     [inputs["input_ids"].shape[-1] - 1, inputs["input_ids"].shape[-1] - 1]
... )[
...     None, :
... ]  # Batch size 1
>>> outputs = model(inputs)
>>> lm_prediction_scores, mc_prediction_scores = outputs[:2]

TFOpenAIGPTForSequenceClassification

class transformers.TFOpenAIGPTForSequenceClassification

< source >

( config *inputs **kwargs )

参数

config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。

带有序列分类头的 OpenAI GPT 模型 Transformer (线性层)。

TFOpenAIGPTForSequenceClassification 使用最后一个 token 进行分类，就像其他因果模型 (例如 GPT-2) 一样。

由于它对最后一个 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 模型），或
将所有输入作为第一个位置参数中的列表、元组或字典。

单个张量，其中只有 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})

请注意，在使用子类化创建模型和层时，您无需担心任何这些，因为您可以像传递给任何其他 Python 函数一样传递输入！

call

< source >

参数

input_ids (Numpy array 或 tf.Tensor 形状为 (batch_size, sequence_length)) — 词表中输入序列 token 的索引。

可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 获取详细信息。

什么是输入 ID？
attention_mask (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示未掩码的 token，
- 0 表示掩码的 token。
什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在 [0, 1] 内：
- 0 对应于句子 A 标记
- 1 对应于句子 B 标记
什么是标记类型 ID？
position_ids (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围在 [0, config.max_position_embeddings - 1] 内。

什么是位置 ID？
head_mask (tf.Tensor 或 Numpy array 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在 [0, 1] 内：
- 1 表示头部未被掩码
- 0 表示头部被掩码
inputs_embeds (tf.Tensor 或 Numpy array 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将非常有用。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量中的 attentions。此参数仅可在急切模式下使用，在图形模式下将使用配置中的值。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量中的 hidden_states。此参数仅可在急切模式下使用，在图形模式下将使用配置中的值。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用，在图形模式下，该值将始终设置为 True。
training (bool，可选，默认值为 False) — 是否以训练模式使用模型（一些模块，例如 dropout 模块，在训练和评估之间具有不同的行为）。
labels (tf.Tensor 形状为 (batch_size, sequence_length)，可选) — 用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 内。

transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置 (OpenAIGPTConfig) 和输入的各种元素。

loss (tf.Tensor 形状为 (batch_size, )，可选，在提供 labels 时返回) — 分类（如果 config.num_labels==1 则为回归）损失。
logits (tf.Tensor 形状为 (batch_size, config.num_labels)) — 分类（如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

The TFOpenAIGPTForSequenceClassification 正向方法覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFOpenAIGPTForSequenceClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/openai-gpt")
>>> model = TFOpenAIGPTForSequenceClassification.from_pretrained("openai-community/openai-gpt")

>>> 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 = TFOpenAIGPTForSequenceClassification.from_pretrained("openai-community/openai-gpt", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss

< > 在 GitHub 上更新

←Gemma2 GPT Neo→