Transformers 文档
OpenAI GPT
并获取增强的文档体验
开始使用
OpenAI GPT
概述
OpenAI GPT 模型由 Alec Radford、Karthik Narasimhan、Tim Salimans 和 Ilya Sutskever 在 Improving Language Understanding by Generative Pre-Training 中提出。它是一个因果（单向）Transformer 模型，使用语言建模在具有长距离依赖关系的大型语料库 Toronto Book Corpus 上进行了预训练。
该论文的摘要如下：
自然语言理解包含各种不同的任务，例如文本蕴含、问题解答、语义相似度评估和文档分类。尽管存在大量未标记的文本语料库，但用于学习这些特定任务的标记数据却很少，这使得判别式训练模型难以充分执行。我们证明，通过在多样化的未标记文本语料库上对语言模型进行生成式预训练，然后在每个特定任务上进行判别式微调，可以实现这些任务的巨大提升。与以前的方法相比，我们在微调期间利用任务感知的输入转换来实现有效的迁移，同时模型架构的更改最小。我们证明了我们的方法在自然语言理解的广泛基准测试中的有效性。我们的通用任务无关模型优于使用专门为每个任务设计的架构的判别式训练模型，在所研究的 12 个任务中的 9 个任务中显着改进了最先进水平。
Write With Transformer 是由 Hugging Face 创建和托管的 Web 应用程序，展示了多种模型的生成能力。 GPT 是其中之一。
此模型由 thomwolf 贡献。 原始代码可以在此处找到。
使用提示
- GPT 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
- GPT 模型在训练时采用了因果语言建模 (CLM) 目标，因此非常擅长预测序列中的下一个 token。利用此功能，GPT-2 可以生成在句法上连贯的文本，正如在 run_generation.py 示例脚本中所观察到的那样。
注意
如果您想重现 OpenAI GPT 论文的原始 tokenization 过程，您需要安装 ftfy 和 SpaCy
pip install spacy ftfy==4.4.3 python -m spacy download en
如果您不安装 ftfy 和 SpaCy，OpenAIGPTTokenizer 将默认使用 BERT 的 BasicTokenizer 进行 tokenization，然后进行 Byte-Pair Encoding (这对大多数用途来说应该没问题，不用担心)。
资源
以下是 Hugging Face 官方和社区 (🌎 表示) 资源的列表，可帮助您开始使用 OpenAI GPT。如果您有兴趣提交资源并将其包含在此处，请随时打开 Pull Request，我们将对其进行审核！理想情况下，资源应展示一些新内容，而不是重复现有资源。
- 一篇关于 使用 SetFit 在文本分类任务上超越 OpenAI GPT-3 的博客文章。
- 另请参阅：文本分类任务指南
- 一篇关于如何使用 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 课程的章节。
- OpenAIGPTLMHeadModel 由此因果语言建模示例脚本、文本生成示例脚本 和 notebook 支持。
- TFOpenAIGPTLMHeadModel 由此因果语言建模示例脚本 和 notebook 支持。
- 另请参阅：因果语言建模任务指南
- 关于 Byte-Pair Encoding tokenization 的课程材料。
OpenAIGPTConfig
class transformers.OpenAIGPTConfig
< source >( 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 值 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - summary_type (
str, 可选, 默认为"cls_index") — 在进行序列摘要时使用的参数，用于模型 OpenAIGPTDoubleHeadsModel 和 OpenAIGPTDoubleHeadsModel。必须是以下选项之一：
"last"：取最后一个 token 的隐藏状态（类似于 XLNet）。"first"：取第一个 token 的隐藏状态（类似于 BERT）。"mean"：取所有 token 隐藏状态的平均值。"cls_index"：提供分类 token 位置的 Tensor（类似于 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.configOpenAIGPTTokenizer
class transformers.OpenAIGPTTokenizer
< source >( vocab_file merges_file unk_token = '<unk>' **kwargs )
构建 GPT Tokenizer。基于 Byte-Pair-Encoding，具有以下特点
- 将所有输入转换为小写，
- 如果安装了
SpaCytokenizer 和ftfy，则使用它们进行 BPE tokenization 之前的预处理；否则，回退到 BERT 的BasicTokenizer。
此分词器继承自 PreTrainedTokenizer，后者包含了大多数主要方法。用户应参考此超类以获取关于这些方法的更多信息。
OpenAIGPTTokenizerFast
class transformers.OpenAIGPTTokenizerFast
< source >( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<unk>' **kwargs )
构建一个“快速” GPT 分词器（由 HuggingFace 的 tokenizers 库支持）。基于字节对编码（Byte-Pair-Encoding），具有以下特性
- 将所有输入转换为小写
- 使用 BERT 的 BasicTokenizer 进行 BPE 分词前的预处理
此分词器继承自 PreTrainedTokenizerFast，后者包含了大多数主要方法。用户应参考此超类以获取关于这些方法的更多信息。
OpenAI 特定输出
class transformers.models.openai.modeling_openai.OpenAIGPTDoubleHeadsModelOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None mc_loss: typing.Optional[torch.FloatTensor] = None logits: FloatTensor = None mc_logits: FloatTensor = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = 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 之前的每个词汇 token 的得分）。 - 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的元组（每个 embedding 输出一个 + 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
- 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
< source >( 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 之前的每个词汇 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的元组（每个 embedding 输出一个 + 每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 hidden-states 加上初始 embedding 输出。
- attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
用于模型输出的基类，这些模型预测两个句子是否连贯。
OpenAIGPTModel
class transformers.OpenAIGPTModel
< source >( config )
参数
- config (OpenAIGPTConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸露的 OpenAI GPT transformer 模型，输出原始 hidden-states，顶部没有任何特定的 head。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参考 PyTorch 文档以了解与通用用法和行为相关的所有事项。
forward
< source >( 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 output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 已被 Mask。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置 embeddings 中每个输入序列 token 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块的选定 heads 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部 embedding 查找矩阵更精确地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参见返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的 tuple。
返回：
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False，或者当 config.return_dict=False 时），其中包括各种元素，具体取决于配置 (OpenAIGPTConfig) 和输入。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的 hidden-states 序列。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 Tuple（如果模型具有 embedding 层，则为 embeddings 的输出提供一个，+ 每个层的输出提供一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 Tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
OpenAIGPTModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
示例
>>> 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_stateOpenAIGPTLMHeadModel
class transformers.OpenAIGPTLMHeadModel
< source >( config )
参数
- config (OpenAIGPTConfig) — 模型配置类，其中包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
OpenAI GPT 模型 transformer，顶部带有语言建模 head（线性层，其权重与输入 embeddings 绑定）。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参考 PyTorch 文档以了解与通用用法和行为相关的所有事项。
forward
< source >( 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 labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 已被 Mask。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置 embeddings 中每个输入序列 token 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块的选定 heads 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部 embedding 查找矩阵更精确地控制如何将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时返回) — 语言建模损失 (用于预测下一个 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的 Tuple（如果模型具有 embedding 层，则为 embeddings 的输出提供一个，+ 每个层的输出提供一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 Tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
OpenAIGPTLMHeadModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
示例
>>> 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.logitsOpenAIGPTDoubleHeadsModel
class transformers.OpenAIGPTDoubleHeadsModel
< 源码 >( config )
参数
- config (OpenAIGPTConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法来加载模型权重。
OpenAI GPT 模型转换器，顶部带有一个语言建模头和一个多项选择分类头，例如用于 RocStories/SWAG 任务。 这两个头是两个线性层。 语言建模头的权重与其输入嵌入绑定，分类头将输入序列中指定的分类 token 索引的输入作为输入）。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参考 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 mc_token_ids: typing.Optional[torch.LongTensor] = None labels: typing.Optional[torch.LongTensor] = None mc_labels: 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.models.openai.modeling_openai.OpenAIGPTDoubleHeadsModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行注意力机制。 掩码值在[0, 1]中选择:- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_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)，可选) — 用于 nullify self-attention 模块的选定头的掩码。 掩码值在[0, 1]中选择:- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- 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)，可选，默认为输入的最后一个 token 的索引) — 每个输入序列中分类 token 的索引。 在范围[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 之前每个词汇 token 的分数）。 -
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的 Tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
OpenAIGPTDoubleHeadsModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
示例
>>> 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_logitsOpenAIGPTForSequenceClassification
class transformers.OpenAIGPTForSequenceClassification
< 源码 >( config )
参数
- config (OpenAIGPTConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
原始 OpenAI GPT 模型 Transformer，顶部带有一个序列分类头（线性层）。OpenAIGPTForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-2）一样。由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，它会在每一行中找到最后一个不是 padding token 的 token。如果未定义 pad_token_id，它只会取每一行批次的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测 padding token，因此它会执行相同的操作（取每一行批次的最后一个值）。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch Module，并参考 PyTorch 文档以了解与通用用法和行为相关的所有事项。
forward
< source >( 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 labels: 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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_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)，可选) — 掩码，用于使 self-attention 模块的选定 head 无效。掩码值在[0, 1]中选择：- 1 表示 head 未被掩码，
- 0 表示 head 被掩码。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden state。 有关更多详细信息，请参见返回张量下的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的 Tuple（如果模型具有 embedding 层，则为 embeddings 的输出提供一个，+ 每个层的输出提供一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 Hidden-states，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 Tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
OpenAIGPTForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
单标签分类示例
>>> 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).lossTFOpenAIGPTModel
class transformers.TFOpenAIGPTModel
< source >( config *inputs **kwargs )
参数
- config (OpenAIGPTConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
裸露的 OpenAI GPT transformer 模型，输出原始 hidden-states，顶部没有任何特定的 head。
此模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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 (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 以了解详细信息。
- attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array，可选) — 掩码，用于避免在 padding token 索引上执行 attention。掩码值在[0, 1]中选择：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。
- token_type_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length), 可选) — 片段 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 (
tf.Tensor或Numpy array，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置空自注意力模块中选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- 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 or 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元组（embeddings 的输出一个，每层的输出一个），形状为(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)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
TFOpenAIGPTModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
示例
>>> 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_stateTFOpenAIGPTLMHeadModel
class transformers.TFOpenAIGPTLMHeadModel
< source >( config *inputs **kwargs )
参数
- config (OpenAIGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
OpenAI GPT 模型 transformer，顶部带有语言建模 head（线性层，其权重与输入 embeddings 绑定）。
此模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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 labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFCausalLMOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length), 可选) — 掩码，以避免在 padding token 索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- token_type_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length), 可选) — 片段 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 (
tf.Tensor或Numpy array，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置空自注意力模块中选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- 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 模块等某些模块在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于计算交叉熵分类损失的标签。索引应在[0, ..., config.vocab_size - 1]中。
返回：
transformers.modeling_tf_outputs.TFCausalLMOutput or tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (OpenAIGPTConfig) 和输入。
-
loss (
tf.Tensor，形状为(n,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（embeddings 的输出一个，每层的输出一个），形状为(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)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
TFOpenAIGPTLMHeadModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
示例
>>> 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.logitsTFOpenAIGPTDoubleHeadsModel
class transformers.TFOpenAIGPTDoubleHeadsModel
< source >( config *inputs **kwargs )
参数
- config (OpenAIGPTConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
OpenAI GPT 模型转换器，顶部带有一个语言建模头和一个多项选择分类头，例如用于 RocStories/SWAG 任务。 这两个头是两个线性层。 语言建模头的权重与其输入嵌入绑定，分类头将输入序列中指定的分类 token 索引的输入作为输入）。
此模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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 mc_token_ids: 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.models.openai.modeling_tf_openai.TFOpenAIGPTDoubleHeadsModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 遮罩，以避免在填充 token 索引上执行注意力机制。遮罩值在[0, 1]中选择：- 1 表示 token 未被遮罩，
- 0 表示 token 已被遮罩。
- 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, 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的tf.Tensor或Numpy array, 可选) — 用于 nullify 自注意力模块的选定 head 的遮罩。遮罩值在[0, 1]中选择：- 1 表示 head 未被遮罩，
- 0 表示 head 已被遮罩。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor或Numpy array, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递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 模块等某些模块在训练和评估之间具有不同的行为）。 - mc_token_ids (形状为
(batch_size, num_choices)的tf.Tensor或Numpy array, 可选, 默认为输入的最后一个 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 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含取决于配置 (OpenAIGPTConfig) 和输入的各种元素。
-
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 之前每个选项的分数）。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（embeddings 的输出一个，每层的输出一个），形状为(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)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
TFOpenAIGPTDoubleHeadsModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
示例
>>> 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() 方法来加载模型权重。
带有序列分类 head (线性层) 的 OpenAI GPT 模型转换器。
TFOpenAIGPTForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，它会在每行中找到不是填充 token 的最后一个 token。如果未定义 pad_token_id，它将只取批次中每行的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测填充 token，因此它会执行相同的操作（取批次中每行的最后一个值）。
此模型继承自 TFPreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 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 labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的tf.Tensor或Numpy array, 可选) — 遮罩，以避免在填充 token 索引上执行注意力机制。遮罩值在[0, 1]中选择：- 1 表示 token 未被遮罩，
- 0 表示 token 已被遮罩。
- 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, 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
tf.Tensor或Numpy array，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 不被屏蔽，
- 0 表示 head 被屏蔽。
- 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 模块）在训练和评估之间具有不同的行为）。 - labels (形状为
(batch_size, sequence_length)的tf.Tensor, 可选) — 用于计算交叉熵分类损失的标签。 索引应在[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 (形状为
(batch_size, )的tf.Tensor, 可选, 当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (形状为
(batch_size, config.num_labels)的tf.Tensor) — 分类（或回归，如果 config.num_labels==1）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（embeddings 的输出一个，每层的输出一个），形状为(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)。attention softmax 之后的 Attentions 权重，用于计算 self-attention heads 中的加权平均值。
TFOpenAIGPTForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的 recipe 需要在此函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行 pre 和 post processing 步骤，而后者会默默地忽略它们。
示例
>>> 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