Transformers 文档

OpenAI GPT2

Hugging Face's logo
加入 Hugging Face 社区

并获取增强的文档体验

开始使用

OpenAI GPT2

Models Spaces

概述

OpenAI GPT-2 模型是在 语言模型是无监督多任务学习器 中提出的,该模型由 Alec Radford、Jeffrey Wu、Rewon Child、David Luan、Dario Amodei 和 Ilya Sutskever 来自 OpenAI 共同撰写。它是一个因果(单向)Transformer,使用语言建模在约 40 GB 的文本数据语料库上进行预训练。

论文的摘要如下

GPT-2 是一种大型基于 Transformer 的语言模型,具有 15 亿个参数,在 800 万个网页数据集[1] 上进行训练。GPT-2 使用一个简单的目标进行训练:预测下一个词,前提是在某些文本中给出所有前面的词。数据集的多样性导致这个简单目标自然地包含了跨越不同领域的许多任务的演示。GPT-2 是 GPT 的直接扩展,参数数量是 GPT 的 10 倍以上,并且在 10 倍以上的数据量上进行训练。

使用 Transformer 编写 是一个由 Hugging Face 创建和托管的网络应用程序,展示了多个模型的生成能力。GPT-2 是其中之一,有五种不同的尺寸:小型、中型、大型、超大型以及小型检查点的蒸馏版本:distilgpt-2

此模型由 thomwolf 贡献。原始代码可以在 此处 找到。

使用技巧

  • GPT-2 是一种具有绝对位置嵌入的模型,因此通常建议在右侧而不是左侧填充输入。
  • GPT-2 使用因果语言建模 (CLM) 目标进行训练,因此在预测序列中的下一个标记方面非常强大。利用此功能,GPT-2 可以生成语法连贯的文本,这在 run_generation.py 示例脚本中可以观察到。
  • 模型可以将 past_key_values(对于 PyTorch)或 past(对于 TF)作为输入,它们是先前计算的关键/值注意力对。使用此(past_key_valuespast)值可以防止模型在文本生成的上下文中重新计算预先计算的值。对于 PyTorch,请参阅 GPT2Model.forward() 方法的 past_key_values 参数,或对于 TF 请参阅 TFGPT2Model.call() 方法的 past 参数,以获取有关其用法的更多信息。
  • 启用 scale_attn_by_inverse_layer_idxreorder_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]

预期加速

下面是预期加速图,比较了 transformers 中使用 `gpt2` 检查点的原生实现与使用 512 序列长度的 Flash Attention 2 版本模型之间的纯推理时间。

使用缩放点积注意力(SDPA)

PyTorch 将原生缩放点积注意力 (SDPA) 运算符作为 `torch.nn.functional` 的一部分。此函数包含多种实现,可以根据输入和使用的硬件进行应用。有关更多信息,请参阅 官方文档GPU 推理 页面。

当可用时,SDPA 在 `torch>=2.1.1` 中默认使用,但您也可以在 `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、操作系统 Ubuntu 22.04)中,使用 `float16` 和 gpt2-large,我们在训练和推理期间看到了以下加速效果。

训练

批次大小 序列长度 每个批次的时长(急切 - 秒) 每个批次的时长(SDPA - 秒) 加速百分比 (%) 急切峰值内存(MB) SDPA 峰值内存(MB) 内存节省百分比 (%)
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 不出现 OOM
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 不出现 OOM

推理

批次大小 序列长度 每个标记的延迟(急切 - 毫秒) 每个标记的延迟(SDPA - 毫秒) 加速百分比 (%) 急切内存(MB) SDPA 内存(MB) 内存节省百分比 (%)
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。如果您有兴趣提交要包含在此处的资源,请随时打开拉取请求,我们将进行审查!理想情况下,该资源应展示一些新内容,而不是重复现有资源。

文本生成

GPT2Config

class transformers.GPT2Config

< >

( 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 模型的词汇量大小。定义了调用 GPT2ModelTFGPT2Model 时可以由 inputs_ids 表示的不同标记的数量。
  • 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) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
  • embd_pdrop (float, 可选, 默认值为 0.1) — 嵌入层的丢弃率。
  • attn_pdrop (float, 可选, 默认值为 0.1) — 注意力机制的丢弃率。
  • layer_norm_epsilon (float, 可选, 默认值为 1e-05) — 层归一化层中使用的ε值。
  • initializer_range (float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的截断正态分布的标准差。
  • summary_type (string, 可选, 默认值为 "cls_index") — 进行序列摘要时使用的参数,在模型 GPT2DoubleHeadsModelTFGPT2DoubleHeadsModel 中使用。

    必须是以下选项之一:

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

    是否在向量提取后添加投影。

  • summary_activation (str, 可选) — 进行序列摘要时使用的参数。在 GPT2DoubleHeadsModel 中的多选头中使用。

    传递 "tanh" 以对输出应用双曲正切激活函数,任何其他值都将不应用激活函数。

  • summary_proj_to_labels (bool, 可选, 默认值为 True) — 进行序列摘要时使用的参数,在模型 GPT2DoubleHeadsModelTFGPT2DoubleHeadsModel 中使用。

    投影输出是否应该具有 config.num_labelsconfig.hidden_size 个类别。

  • summary_first_dropout (float, 可选, 默认值为 0.1) — 进行序列摘要时使用的参数,在模型 GPT2DoubleHeadsModelTFGPT2DoubleHeadsModel 中使用。

    投影和激活后使用的丢弃率。

  • use_cache (bool, 可选, 默认值 True) — 是否模型应该返回最后 key/values 注意力(并非所有模型都使用)。
  • bos_token_id (int, 可选, 默认值 50256) — 词汇表中句子开头标记的 ID。
  • eos_token_id (int, 可选, 默认值 50256) — 词汇表中句子结尾标记的 ID。
  • scale_attn_by_inverse_layer_idx (bool, 可选, 默认值 False) — 是否还要按 1 / layer_idx + 1 缩放注意力权重。
  • reorder_and_upcast_attn (bool, 可选, 默认值 False) — 是否在计算注意力(点积)之前缩放键(K)并将混合精度训练时的注意力点积/softmax 上升到 float()。

这是用于存储 GPT2ModelTFGPT2Model 配置的配置类。它用于根据指定的参数实例化 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.config

GPT2Tokenizer

class transformers.GPT2Tokenizer

< >

( 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) — 合并文件的路径。
  • unk_token (str, 可选, 默认为 "<|endoftext|>") — 未知标记。词汇表中不存在的标记无法转换为 ID,而是设置为此标记。
  • bos_token (str, 可选, 默认为 "<|endoftext|>") — 序列开始标记。
  • eos_token (str, 可选, 默认为 "<|endoftext|>") — 序列结束标记。
  • pad_token (str, 可选) — 用于填充的标记,例如在对不同长度的序列进行批处理时。
  • add_prefix_space (bool, 可选, 默认为 False) — 是否在输入的开头添加空格。这允许将第一个词与其他任何词一样对待。(GPT2 标记器通过前导空格来检测词的开头)。
  • add_bos_token (bool, 可选, 默认为 False) — 是否在输入的开头添加句子开始标记。这允许将第一个词与其他任何词一样对待。

构造一个 GPT-2 标记器。基于字节级字节对编码。

此标记器经过训练,将空格视为标记的一部分(有点像 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,其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

GPT2TokenizerFast

class transformers.GPT2TokenizerFast

< >

( 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, 可选) — 词汇表文件路径。
  • merges_file (str, 可选) — 合并文件路径。
  • tokenizer_file (str, 可选) — tokenizers 文件路径(通常扩展名为 .json),其中包含加载词法分析器所需的所有内容。
  • unk_token (str, 可选, 默认为 "<|endoftext|>") — 未知词元。词汇表中不存在的词元无法转换为 ID,而会被设置为此词元。
  • bos_token (str, 可选, 默认为 "<|endoftext|>") — 序列开始词元。
  • eos_token (str, 可选, 默认为 "<|endoftext|>") — 序列结束词元。
  • add_prefix_space (bool, 可选, 默认为 False) — 是否在输入中添加前缀空格。这允许将第一个词与其他任何词一样对待。(GPT2 词法分析器通过前面的空格来检测单词的开头)。

构建一个“快速”GPT-2 词法分析器(由 HuggingFace 的 tokenizers 库支持)。基于字节级字节对编码。

此标记器经过训练,将空格视为标记的一部分(有点像 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

< >

( loss: Optional = None mc_loss: Optional = None logits: FloatTensor = None mc_logits: FloatTensor = None past_key_values: Optional = None hidden_states: Optional = None attentions: Optional = None )

参数

  • 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 之前的每个选择的分数)。
  • past_key_values (Tuple[Tuple[torch.Tensor]]可选,当传递 use_cache=Trueconfig.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=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组(一个用于嵌入输出,一个用于每一层的输出)。

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每一层一个)。

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

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

class transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput

< >

( 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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)).

    包含预先计算的隐藏状态(注意力块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

  • hidden_states (tuple(tf.Tensor), 可选, 在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组(一个用于嵌入的输出,另一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size).

    每一层模型的输出隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选, 在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length).

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

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

Pytorch
隐藏 Pytorch 内容

GPT2Model

class transformers.GPT2Model

< >

( config )

参数

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

基本的 GPT2 模型 transformer,输出原始隐藏状态,不带任何特定头部。

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

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

forward

< >

( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则为 past_key_values[0][0].shape[-2] (sequence_length 输入过去键值状态)。词汇表中输入序列标记的索引。

    如果使用了 past_key_values,则只有尚未计算过去值的 input_ids 应该作为 input_ids 传递。

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

    什么是输入 ID?

  • 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)可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值:

    • 1 表示 **未屏蔽** 的标记,
    • 0 表示 **已屏蔽** 的标记。

    如果使用了 past_key_valuesattention_mask 需要包含用于 past_key_values 的屏蔽策略。换句话说,attention_mask 的长度始终必须为:len(past_key_values) + len(input_ids)

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor 形状为 (batch_size, input_ids_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 索引转换为关联向量有更多控制权,这将非常有用。

    如果使用了 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 而不是一个简单的元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包括根据配置 (GPT2Config) 和输入的不同元素。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递了 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 的元组,每个元组都有两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 以及可选的,如果 config.is_encoder_decoder=True,则另外两个形状为 (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=Trueconfig.add_cross_attention=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

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

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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_state

GPT2LMHeadModel

class transformers.GPT2LMHeadModel

< >

( config )

参数

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

带有语言建模头的 GPT2 模型转换器(线性层,权重与输入嵌入绑定)。

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

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

forward

< >

( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone,否则为 past_key_values[0][0].shape[-2] (输入过去键值状态的 sequence_length)。词汇表中输入序列标记的索引。

    如果使用 past_key_values,则只有没有计算过去值的 input_ids 应该作为 input_ids 传递。

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

    什么是输入 ID?

  • 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)可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    如果使用 past_key_valuesattention_mask 需要包含用于 past_key_values 的屏蔽策略。换句话说,attention_mask 始终必须具有长度:len(past_key_values) + len(input_ids)

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor 形状为 (batch_size, input_ids_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 索引转换为关联的向量,这将很有用。

    如果使用 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] 中的标签进行计算

返回

transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstorch.FloatTensor 的元组(如果传递 return_dict=Falseconfig.return_dict=False 时),包括根据配置 (GPT2Config) 和输入的不同元素。

  • 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 后的注意力权重,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意 softmax 后的交叉注意权重,用于计算交叉注意头的加权平均值。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — torch.FloatTensor 元组的元组,长度为 config.n_layers,每个元组包含自注意和交叉注意层的缓存键值状态,如果模型用于编码器-解码器设置。仅在 config.is_decoder = True 时相关。

    包含预先计算的隐藏状态(注意块中的键和值),可以用来(参见 past_key_values 输入)加速顺序解码。

GPT2LMHeadModel 正向方法,覆盖 __call__ 特殊方法。

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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.logits

GPT2DoubleHeadsModel

class transformers.GPT2DoubleHeadsModel

< >

( config )

参数

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

带语言建模和多项选择分类头的 GPT2 模型转换器,例如用于 RocStories/SWAG 任务。这两个头是两个线性层。语言建模头的权重与输入嵌入绑定,分类头以输入序列中指定分类标记索引的输入作为输入)。

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

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

forward

< >

( input_ids: Optional = None past_key_values: 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 use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None **kwargs ) transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则 past_key_values[0][0].shape[-2] (输入过去键值状态的 sequence_length)。词汇表中输入序列标记的索引。

    如果使用 past_key_values,则应将没有计算其过去的 input_ids 传递为 input_ids

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

    什么是输入 ID?

  • 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)可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值:

    • 1 代表未被掩码的标记,
    • 0 代表被掩码的标记。

    如果使用 past_key_valuesattention_mask 需要包含用于 past_key_values 的掩码策略。换句话说,attention_mask 始终必须具有长度:len(past_key_values) + len(input_ids)

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor 形状为 (batch_size, input_ids_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 索引转换为关联的向量,这将非常有用。

    如果使用 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), 可选, 默认值为输入的最后一个标记的索引) — 每个输入序列中分类标记的索引。在 [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)。

返回

transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutputtuple(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)) — 语言建模头的预测分数(SoftMax 之前的每个词汇表标记的分数)。

  • mc_logits (torch.FloatTensor 形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数(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 元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (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后的GPT2注意力权重,用于计算自注意力头中的加权平均值。

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

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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_logits

GPT2ForQuestionAnswering

class transformers.GPT2ForQuestionAnswering

< >

( config )

参数

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

GPT-2 模型转换器,顶部有一个跨度分类头,用于解决提取式问答任务,例如 SQuAD(在隐藏状态输出的顶部有一个线性层,用于计算 span start logitsspan end logits)。

此模型继承自 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 start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.QuestionAnsweringModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则 past_key_values[0][0].shape[-2] (输入过去键值状态的 sequence_length)。输入序列token在词典中的索引。

    如果使用 past_key_values,只有没有计算过去值的 input_ids 应该作为 input_ids 传入。

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

    什么是输入 ID?

  • 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), 可选) — 掩码以避免对填充 token 索引执行注意力。掩码值选择在 [0, 1] 中:

    • 1 代表未掩码的 token,
    • 0 代表掩码的 token。

    如果使用 past_key_valuesattention_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。

    什么是 token 类型 ID?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 位置的索引。选择在 [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 索引转换为关联向量,而不是模型的内部嵌入查找矩阵,这将很有用。

    如果使用 past_key_values,可以选择仅输入最后一个 inputs_embeds(见 past_key_values)。

  • use_cache (bool, optional) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  • start_positions (torch.LongTensor of shape (batch_size,), optional) — 用于计算令牌分类损失的标记跨度开始位置(索引)的标签。位置被钳制到序列长度(sequence_length)。序列之外的位置不会被考虑用于计算损失。
  • end_positions (torch.LongTensor of shape (batch_size,), optional) — 用于计算令牌分类损失的标记跨度结束位置(索引)的标签。位置被钳制到序列长度(sequence_length)。序列之外的位置不会被考虑用于计算损失。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutput or tuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 总跨度提取损失是开始和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 跨度开始得分(在 SoftMax 之前)。

  • end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 跨度结束得分(在 SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型具有嵌入层,+ 一个用于每一层的输出) 形状为 (batch_size, sequence_length, hidden_size)

    每一层输出处的模型隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The GPT2ForQuestionAnswering forward method, overrides the __call__ special method.

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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.loss

GPT2ForSequenceClassification

class transformers.GPT2ForSequenceClassification

< >

( config )

参数

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

GPT2 模型转换器,顶部有一个序列分类头部(线性层)。

GPT2ForSequenceClassification 使用最后一个令牌进行分类,就像其他因果模型(例如 GPT-1)一样。

由于它对最后一个 token 进行分类,因此需要知道最后一个 token 的位置。如果配置中定义了 pad_token_id,它会在每行中找到最后一个非填充 token。如果没有定义 pad_token_id,它会简单地取批处理中每行的最后一个值。由于它无法在传递 inputs_embeds 而不是 input_ids 时猜测填充 token,因此它执行相同的操作(取批处理中每行的最后一个值)。

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

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

forward

< >

( input_ids: Optional = None past_key_values: 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 use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.SequenceClassifierOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则 past_key_values[0][0].shape[-2] (sequence_length 输入过去键值状态)。词汇表中输入序列 token 的索引。

    如果使用 past_key_values,则只有未计算过去值的 input_ids 应该作为 input_ids 传递。

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

    什么是输入 ID?

  • 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)可选) — 避免对填充 token 索引执行注意力的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示 未屏蔽 的 token,
    • 0 表示 屏蔽 的 token。

    如果使用 past_key_valuesattention_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。

    什么是 token 类型 ID?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列 token 的位置索引。在 [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 索引转换为关联向量,这将非常有用。
  • 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,则计算分类损失(交叉熵)。

返回

transformers.modeling_outputs.SequenceClassifierOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutputWithPasttorch.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_layerstuple(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 正向方法覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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).loss

GPT2ForTokenClassification

class transformers.GPT2ForTokenClassification

< >

( config )

参数

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

在顶部具有令牌分类头的 GPT2 模型(隐藏状态输出顶部的线性层),例如用于命名实体识别 (NER) 任务。

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

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

forward

< >

( input_ids: Optional = None past_key_values: 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 use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone,否则为 past_key_values[0][0].shape[-2] (输入过去键值状态的 sequence_length)。输入序列词元的词汇表中的索引。

    如果使用 past_key_values,则只有 input_ids 中没有计算其过去值的 input_ids 应作为 input_ids 传递。

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

    什么是输入 ID?

  • 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)可选) — 掩码,用于避免在填充词元索引上执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示未掩码的词元,
    • 0 表示已掩码的词元。

    如果使用 past_key_valuesattention_mask 需要包含用于 past_key_values 的掩码策略。换句话说,attention_mask 始终必须具有长度:len(past_key_values) + len(input_ids)

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor 形状为 (batch_size, input_ids_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 索引转换为关联的向量(而不是模型的内部嵌入查找矩阵)有更多控制,这将很有用。

    如果使用 past_key_values,则可选地只需要输入最后一个 inputs_embeds (请参阅 past_key_values)。

  • use_cache (bool, optional) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息,请参见返回张量中的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关详细信息,请参见返回张量中的 hidden_states
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回

transformers.modeling_outputs.TokenClassifierOutput or tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutputtorch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (GPT2Config) 和输入而异的各种元素。

  • loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 分类损失。

  • logits (torch.FloatTensor of shape (batch_size, sequence_length, config.num_labels)) — 分类分数(在 SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型具有嵌入层,+ 一个用于每一层的输出) 形状为 (batch_size, sequence_length, hidden_size)

    每一层输出处的模型隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组(每一层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The GPT2ForTokenClassification forward method, overrides the __call__ special method.

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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.25
TensorFlow
Hide TensorFlow content

TFGPT2Model

class transformers.TFGPT2Model

< >

( 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})

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

call

< >

( 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 or tuple(tf.Tensor)

参数

  • input_ids (Numpy arraytf.Tensor,形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则为 past_key_values[0].shape[-2] (输入过去的键值状态的 sequence_length)。词汇表中输入序列标记的索引。

    如果使用 past_key_values,则仅应将尚未计算其过去值的输入 ID 作为 input_ids 传递。

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

    什么是输入 ID?

  • past_key_values (List[tf.Tensor],长度为 config.n_layers) — 包含模型计算的预先计算的隐藏状态(注意力块中的键和值)(参见下面的 past_key_values 输出)。可用于加速顺序解码。传递给此模型的具有过去值的标记 ID 不应作为输入 ID 传递,因为它们已经计算过了。
  • attention_mask (tf.TensorNumpy array,形状为 (batch_size, sequence_length)可选) — 掩码,用于避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。

    如果使用 past_key_valuesattention_mask 需要包含用于 past_key_values 的掩码策略。换句话说,attention_mask 的长度始终必须为:len(past_key_values) + len(input_ids)

    什么是注意力掩码?

  • token_type_ids (tf.TensorNumpy array,形状为 (batch_size, sequence_length)可选) — 段标记索引,用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择:

    • 0 对应于句子 A 标记,
    • 1 对应于句子 B 标记。

    什么是标记类型 ID?

  • position_ids (tf.TensorNumpy array,形状为 (batch_size, sequence_length)可选) — 输入序列标记的位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID?

  • head_mask (Numpy arraytf.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。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用,在图模式下,该值始终设置为 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 (Tuple[Tuple[tf.Tensor]] 长度为 config.n_layers) — 包含预先计算的注意力块的关键和值隐藏状态。可用于加速解码。如果使用 past,用户可以选择仅输入最后一个 decoder_input_ids(没有将其过去的关键值状态提供给此模型的那些) 形状为 (batch_size, 1) 而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)
  • use_cache (bool可选,默认值为 True) — 如果设置为 True,则将返回 past_key_values 键值状态,可用于加速解码(请参阅 past)。在训练期间设置为 False,在生成期间设置为 True

返回

transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentionstuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentionstf.Tensor 的元组(如果传递了 return_dict=Falseconfig.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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

    包含预先计算的隐藏状态(注意块中的键和值),可以用来(参见 past_key_values 输入)加速顺序解码。

  • hidden_states (tuple(tf.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 元组 (一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

The TFGPT2Model forward method, overrides the __call__ special method.

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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_state

TFGPT2LMHeadModel

class transformers.TFGPT2LMHeadModel

< >

( config *inputs **kwargs )

参数

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

带有语言建模头的 GPT2 模型转换器(线性层,权重与输入嵌入绑定)。

此模型继承自 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 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 or tuple(tf.Tensor)

参数

  • input_ids (Numpy 数组tf.Tensor,形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone,否则为 past_key_values[0].shape[-2] (输入过去键值状态的 sequence_length)。输入序列标记在词汇表中的索引。

    如果使用 past_key_values,则只有没有计算其过去的输入 ID 应该作为 input_ids 传递。

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

    什么是输入 ID?

  • past_key_values (List[tf.Tensor] 长度为 config.n_layers) — 包含模型计算的预先计算的隐藏状态 (注意块中的键和值)(参见下面的 past_key_values 输出)。可用于加速顺序解码。已经计算过过去的标记 ID 不应作为输入 ID 传递,因为它们已经计算过了。
  • attention_mask (tf.TensorNumpy 数组,形状为 (batch_size, sequence_length), 可选) — 用于避免在填充标记索引上执行注意的掩码。掩码值选择在 [0, 1] 中:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。

    如果使用 past_key_valuesattention_mask 需要包含用于 past_key_values 的掩码策略。换句话说,attention_mask 始终必须具有长度:len(past_key_values) + len(input_ids)

    什么是注意力掩码?

  • token_type_ids (tf.TensorNumpy array 形状为 (batch_size, sequence_length)可选) — 段标记索引,用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择:

    • 0 对应于句子 A 标记,
    • 1 对应于句子 B 标记。

    什么是标记类型 ID?

  • position_ids (tf.TensorNumpy array 形状为 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 ID?

  • head_mask (Numpy arraytf.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。此参数只能在急切模式下使用,在图模式下将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states。此参数只能在急切模式下使用,在图模式下将使用配置中的值。
  • return_dict (bool可选) — 是否返回一个 ModelOutput,而不是一个简单的元组。此参数可以在急切模式下使用,在图模式下,该值将始终设置为 True。
  • training (bool可选,默认为 False) — 是否以训练模式使用模型(某些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。
  • encoder_hidden_states (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 编码器最后一层输出处的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。
  • encoder_attention_mask (tf.Tensor 形状为 (batch_size, sequence_
  • past_key_values (Tuple[Tuple[tf.Tensor]] 长度为 config.n_layers) — 包含预先计算的注意力块的键值隐藏状态。可用于加速解码。如果使用 past,则用户可以选择仅输入最后 decoder_input_ids(其过去键值状态未提供给此模型)形状为 (batch_size, 1) 而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)
  • use_cache (bool, 可选, 默认为 True) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(见 past)。在训练期间设置为 False,在生成期间设置为 True
  • labels (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 之间。

返回

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个 tf.Tensor 元组(如果传递了 return_dict=False 或者 config.return_dict=False),包含根据配置 (GPT2Config) 和输入而变化的各种元素。

  • loss (tf.Tensor 形状为 (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=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

  • past_key_values (List[tf.Tensor], 可选, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

    包含预先计算的隐藏状态(注意块中的键和值),可以用来(参见 past_key_values 输入)加速顺序解码。

The TFGPT2LMHeadModel 正向方法,覆盖 __call__ 特殊方法。

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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.logits

TFGPT2DoubleHeadsModel

class transformers.TFGPT2DoubleHeadsModel

< >

( config *inputs **kwargs )

参数

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

带语言建模和多项选择分类头的 GPT2 模型转换器,例如用于 RocStories/SWAG 任务。这两个头是两个线性层。语言建模头的权重与输入嵌入绑定,分类头以输入序列中指定分类标记索引的输入作为输入)。

此模型继承自 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 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 or tuple(tf.Tensor)

参数

  • input_ids (Numpy arraytf.Tensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则 past_key_values[0].shape[-2] (sequence_length 输入过去键值状态)。词汇表中输入序列标记的索引。

    如果使用 past_key_values,则只有未计算其过去的输入 ID 应作为 input_ids 传递。

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

    什么是输入 ID?

  • past_key_values (List[tf.Tensor] 长度为 config.n_layers) — 包含模型计算的预先计算的隐藏状态(注意块中的键和值)(请参见下面的 past_key_values 输出)。可用于加快顺序解码速度。传递给此模型的已计算过去令牌 ID 不应作为输入 ID 传递。
  • attention_mask (tf.TensorNumpy 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.TensorNumpy array 形状为 (batch_size, sequence_length)可选) — 段标记索引以指示输入的第一部分和第二部分。索引在 [0, 1] 中选择:

    • 0 对应于句子 A 令牌,
    • 1 对应于句子 B 令牌。

    什么是令牌类型 ID?

  • position_ids (tf.TensorNumpy array 形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列令牌位置的索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID?

  • head_mask (Numpy arraytf.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。此参数仅在急切模式下可用,在图形模式下,将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的 hidden_states。此参数仅在急切模式下可用,在图形模式下,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在 Eager 模式下使用,在图模式下,该值始终设置为 True。
  • training (bool, 可选,默认值为 False) — 是否在训练模式下使用模型(某些模块,例如 dropout 模块,在训练和评估之间具有不同的行为)。
  • mc_token_ids (tf.TensorNumpy 数组,形状为 (batch_size, num_choices)可选,默认为输入的最后一个标记的索引) — 每个输入序列中分类标记的索引。在范围 [0, input_ids.size(-1) - 1] 中选择。

返回

transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutputtuple(tf.Tensor)

一个 transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或一个 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (GPT2Config) 和输入的各种元素。

  • 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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.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 元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

TFGPT2DoubleHeadsModel 正向方法覆盖 __call__ 特殊方法。

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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

< >

( config *inputs **kwargs )

参数

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

GPT2 模型转换器,顶部有一个序列分类头部(线性层)。

为了进行分类,TFGPT2ForSequenceClassification 使用了最后一个标记,就像其他因果模型(例如 GPT-1)一样。

由于它对最后一个 token 进行分类,因此需要知道最后一个 token 的位置。如果配置中定义了 pad_token_id,它会在每行中找到最后一个非填充 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})

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

call

< >

( 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.TFSequenceClassifierOutputWithPasttuple(tf.Tensor)

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone,否则为 past_key_values[0].shape[-2] (输入过去的键值状态的 sequence_length)。输入序列标记在词汇表中的索引。

    如果使用 past_key_values,则应将没有计算过去值的输入 ID 作为 input_ids 传递。

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

    什么是输入 ID?

  • past_key_values (List[tf.Tensor] 长度为 config.n_layers) — 包含模型计算的预先计算的隐藏状态(注意力块中的键和值)(参见下面的 past_key_values 输出)。可用于加快顺序解码。已给出其过去的标记 ID 不应作为输入 ID 传递,因为它们已计算完毕。
  • attention_mask (tf.TensorNumpy 数组 形状为 (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.TensorNumpy 数组 形状为 (batch_size, sequence_length)可选) — 段标记索引,表示输入的第一部分和第二部分。索引在 [0, 1] 中选择:

    • 0 对应于句子 A 标记,
    • 1 对应于句子 B 标记。

    什么是标记类型 ID?

  • position_ids (tf.TensorNumpy 数组 形状为 (batch_size, sequence_length)可选) — 输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID?

  • head_mask (Numpy 数组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。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量中的 hidden_states。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可在急切模式下使用,在图模式下,该值始终设置为 True。
  • training (bool, optional, defaults to False) — 是否以训练模式使用模型(某些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (tf.Tensor of shape (batch_size, sequence_length), optional) — 用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 中。

返回

transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast or tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPasttf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (GPT2Config) 和输入的不同元素。

  • loss (tf.Tensor of shape (batch_size, ), optional, returned when labels is provided) — 分类(或回归,如果 config.num_labels==1)损失。

  • logits (tf.Tensor of shape (batch_size, config.num_labels)) — 分类(或回归,如果 config.num_labels==1)分数(在 SoftMax 之前)。

  • past_key_values (List[tf.Tensor], 可选, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstf.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 元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The TFGPT2ForSequenceClassification 前向方法,覆盖 __call__ 特殊方法。

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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).loss

TFSequenceClassifierOutputWithPast

class transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast

< >

( 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 of shape (batch_size, ), optional, returned when labels is provided) — 分类(或回归,如果 config.num_labels==1)损失。
  • logits (tf.Tensor of shape (batch_size, config.num_labels)) — 分类(或回归,如果 config.num_labels==1)分数(在 SoftMax 之前)。
  • past_key_values (List[tf.Tensor], optional, returned when use_cache=True is passed or when config.use_cache=True) — 长度为 config.n_layerstf.Tensor 列表,每个张量的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

    包含预先计算的隐藏状态(注意块中的键和值),可用于(参见 past_key_values 输入)加速顺序解码。

  • hidden_states (tuple(tf.Tensor), 可选, 在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size)tf.Tensor 元组(一个用于嵌入的输出 + 一个用于每个层的输出)。

    模型在每个层的输出以及初始嵌入输出处的隐藏状态。

  • attentions (tuple(tf.Tensor), 可选, 在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 元组(每个层一个)。

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

句子分类模型输出的基类。

TFGPT2Tokenizer

class transformers.TFGPT2Tokenizer

< >

( vocab: Dict merges: List max_length: int = None pad_token_id: int = None )

参数

  • vocab (Dict[str, int]) — 字节对分词器的词表字典
  • merges (List[str]) — 字节对分词器的合并列表

这是一个用于 GPT2 的图内分词器。它应该与其他分词器类似地初始化,使用 from_pretrained() 方法。它也可以使用 from_tokenizer() 方法初始化,该方法从现有的标准分词器对象导入设置。

图内分词器与其他 Hugging Face 分词器不同,它们实际上是 Keras 层,旨在在调用模型时运行,而不是在预处理期间运行。因此,它们的选择比标准分词器类要有限。当您想要创建一个从 tf.string 输入直接到输出的端到端模型时,它们最有用。

from_config

< >

( config )

参数

  • config (Dict) — 包含 get_config 中所述键的字典。

从配置创建 TFGPT2Tokenizer

from_pretrained

< >

( pretrained_model_name_or_path: Union *init_inputs **kwargs )

参数

  • pretrained_model_name_or_path (Union[str, os.PathLike]) — 预训练模型的路径

从预训练的 GPT2Tokenizer 创建 TFGPT2Tokenizer

示例

from transformers import TFGPT2Tokenizer

tf_tokenizer = TFGPT2Tokenizer.from_pretrained("openai-community/gpt2")

from_tokenizer

< >

( tokenizer: GPT2Tokenizer *args **kwargs )

参数

  • tokenizer (GPT2Tokenizer) —

从 GPT2Tokenizer 创建 TFGPT2Tokenizer

示例

from transformers import AutoTokenizer, TFGPT2Tokenizer

tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
tf_tokenizer = TFGPT2Tokenizer.from_tokenizer(tokenizer)
JAX
隐藏 JAX 内容

FlaxGPT2Model

class transformers.FlaxGPT2Model

< >

( config: GPT2Config input_shape: 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, optional, defaults to jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在 GPU 上)和 jax.numpy.bfloat16(在 TPU 上)。

    这可以用来启用混合精度训练或在 GPU 或 TPU 上进行半精度推理。如果指定,所有计算将使用给定的 dtype 执行。

    注意,这仅指定计算的 dtype,不影响模型参数的 dtype。

    如果你想改变模型参数的 dtype,请查看 to_fp16()to_bf16()

基本的 GPT2 模型 transformer,输出原始隐藏状态,不带任何特定头部。

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

此模型也是 Flax Linen flax.nn.Module 子类。将它用作普通的 Flax 模块,并参考 Flax 文档以了解所有与一般使用和行为相关的事项。

最后,此模型支持固有的 JAX 功能,例如

__call__

< >

( input_ids attention_mask = None position_ids = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None params: dict = None past_key_values: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length. 词汇表中输入序列标记的索引。

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

    什么是输入 ID?

  • attention_mask (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。[0, 1] 中选择的掩码值:

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    什么是注意力掩码?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。
  • past_key_values (Dict[str, np.ndarray], 可选, 由 init_cache 或传递以前的 past_key_values 时返回) — 预先计算的隐藏状态字典(注意力块中的键和值),可用于快速自回归解码。预先计算的键和值隐藏状态的形状为 [batch_size, max_length]
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),包括取决于配置(GPT2Config)和输入的各种元素。

  • last_hidden_state (jnp.ndarray 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。

    如果使用 past_key_values,则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选, 当传递 use_cache=Trueconfig.use_cache=True 时返回) — tuple(jnp.ndarray) 的元组,长度为 config.n_layers,每个元组包含 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=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray), 可选, 当传递 output_attentions=Trueconfig.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=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的交叉注意力层的注意力权重,注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

FlaxGPT2PreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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_state

FlaxGPT2LMHeadModel

class transformers.FlaxGPT2LMHeadModel

< >

( config: GPT2Config input_shape: 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。

    如果您希望更改模型参数的dtype,请查看to_fp16()to_bf16()

带有语言建模头的 GPT2 模型转换器(线性层,权重与输入嵌入绑定)。

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

此模型也是 Flax Linen flax.nn.Module 子类。将它用作普通的 Flax 模块,并参考 Flax 文档以了解所有与一般使用和行为相关的事项。

最后,此模型支持固有的 JAX 功能,例如

__call__

< >

( input_ids attention_mask = None position_ids = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None params: dict = None past_key_values: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length。输入序列标记在词典中的索引。

    索引可以通过 AutoTokenizer 获得。查看PreTrainedTokenizer.encode()PreTrainedTokenizer.call()以了解更多信息。

    什么是输入 ID?

  • attention_mask (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引进行注意力计算。掩码值在 [0, 1] 中选择:

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    什么是注意力掩码?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。从范围 [0, config.max_position_embeddings - 1] 中选择。
  • past_key_values (Dict[str, np.ndarray], 可选, 由 init_cache 返回或在传递先前的 past_key_values 时返回) — 预先计算的隐藏状态词典 (注意力块中的键和值),可用于快速的自回归解码。 预先计算的键和值隐藏状态的形状为 [batch_size, max_length]
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (GPT2Config) 和输入的各种元素。

  • logits (jnp.ndarray 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测得分 (SoftMax 之前的每个词汇表标记的得分)。

  • hidden_states (tuple(jnp.ndarray), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray), 可选, 当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(jnp.ndarray), 可选, 当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)jnp.ndarray 元组 (每个层一个)。

    注意 softmax 后的交叉注意权重,用于计算交叉注意头的加权平均值。

  • past_key_values (tuple(tuple(jnp.ndarray)), 可选, 当传递了 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layersjnp.ndarray 元组,每个元组包含自注意力和交叉注意力层的缓存键,值状态 (如果模型在编码器-解码器设置中使用)。 仅当 config.is_decoder = True 时才相关。

    包含预先计算的隐藏状态(注意块中的键和值),可以用来(参见 past_key_values 输入)加速顺序解码。

FlaxGPT2PreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

虽然正向传递的配方需要在这个函数中定义,但之后应该调用 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]
< > 在 GitHub 上更新