BertGeneration
概述
BertGeneration 模型是一个 BERT 模型,可以使用 EncoderDecoderModel 用于序列到序列的任务,如 Sascha Rothe、Shashi Narayan 和 Aliaksei Severyn 在 Leveraging Pre-trained Checkpoints for Sequence Generation Tasks 中提出的。
论文摘要如下:
大型神经模型的无监督预训练最近彻底改变了自然语言处理。通过从公开发布的检查点进行热启动,NLP 从业者在多个基准测试中推动了最先进的技术,同时节省了大量的计算时间。到目前为止,重点主要集中在自然语言理解任务上。在本文中,我们展示了预训练检查点在序列生成方面的有效性。我们开发了一个基于 Transformer 的序列到序列模型,该模型兼容公开可用的预训练 BERT、GPT-2 和 RoBERTa 检查点,并在使用这些检查点初始化模型(包括编码器和解码器)的效用方面进行了广泛的实证研究。我们的模型在机器翻译、文本摘要、句子分割和句子融合方面取得了新的最先进的结果。
该模型由 patrickvonplaten 贡献。原始代码可以在 这里 找到。
使用示例和技巧
该模型可以与 EncoderDecoderModel 结合使用,以利用两个预训练的 BERT 检查点进行后续微调。
>>> # leverage checkpoints for Bert2Bert model...
>>> # use BERT's cls token as BOS token and sep token as EOS token
>>> encoder = BertGenerationEncoder.from_pretrained("google-bert/bert-large-uncased", bos_token_id=101, eos_token_id=102)
>>> # add cross attention layers and use BERT's cls token as BOS token and sep token as EOS token
>>> decoder = BertGenerationDecoder.from_pretrained(
... "google-bert/bert-large-uncased", add_cross_attention=True, is_decoder=True, bos_token_id=101, eos_token_id=102
... )
>>> bert2bert = EncoderDecoderModel(encoder=encoder, decoder=decoder)
>>> # create tokenizer...
>>> tokenizer = BertTokenizer.from_pretrained("google-bert/bert-large-uncased")
>>> input_ids = tokenizer(
... "This is a long article to summarize", add_special_tokens=False, return_tensors="pt"
... ).input_ids
>>> labels = tokenizer("This is a short summary", return_tensors="pt").input_ids
>>> # train...
>>> loss = bert2bert(input_ids=input_ids, decoder_input_ids=labels, labels=labels).loss
>>> loss.backward()
预训练的 EncoderDecoderModel 也直接在模型中心可用,例如:
>>> # instantiate sentence fusion model
>>> sentence_fuser = EncoderDecoderModel.from_pretrained("google/roberta2roberta_L-24_discofuse")
>>> tokenizer = AutoTokenizer.from_pretrained("google/roberta2roberta_L-24_discofuse")
>>> input_ids = tokenizer(
... "This is the first sentence. This is the second sentence.", add_special_tokens=False, return_tensors="pt"
... ).input_ids
>>> outputs = sentence_fuser.generate(input_ids)
>>> print(tokenizer.decode(outputs[0]))
技巧
- BertGenerationEncoder 和 BertGenerationDecoder 应与
EncoderDecoder
结合使用。 - 对于摘要、句子分割、句子融合和翻译,输入不需要特殊标记。因此,输入末尾不应该添加 EOS 标记。
BertGenerationConfig
class transformers.BertGenerationConfig
< source >( vocab_size = 50358 hidden_size = 1024 num_hidden_layers = 24 num_attention_heads = 16 intermediate_size = 4096 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 bos_token_id = 2 eos_token_id = 1 position_embedding_type = 'absolute' use_cache = True **kwargs )
参数
- vocab_size (
int
, 可选,默认值为 50358) — BERT 模型的词汇量大小。定义了在调用BertGeneration
时传递的inputs_ids
可以表示的不同标记的数量。 - hidden_size (
int
, 可选,默认值为 1024) — 编码器层和池化层的维度。 - num_hidden_layers (
int
, 可选,默认值为 24) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int
, 可选,默认值为 16) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int
, 可选, 默认为 4096) — Transformer 编码器中“中间”(通常称为前馈)层的维度。 - hidden_act (
str
或function
, 可选, 默认为"gelu"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。 如果是字符串,则支持"gelu"
、"relu"
、"silu"
和"gelu_new"
。 - hidden_dropout_prob (
float
, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float
, 可选, 默认为 0.1) — 注意概率的 dropout 比率。 - max_position_embeddings (
int
, 可选, 默认为 512) — 此模型可能使用的最大序列长度。 通常将此设置为一个较大的值以防万一(例如,512 或 1024 或 2048)。 - initializer_range (
float
, 可选, 默认为 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float
, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - pad_token_id (
int
, 可选, 默认为 0) — 填充 token id。 - bos_token_id (
int
, 可选, 默认为 2) — 流的开始 token id。 - eos_token_id (
int
, 可选, 默认为 1) — 流的结束 token id。
这是用于存储 BertGenerationPreTrainedModel
配置的配置类。它用于根据指定参数实例化 BertGeneration 模型,定义模型架构。使用默认值实例化配置将产生与 BertGeneration google/bert_for_seq_generation_L-24_bbc_encoder 架构类似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。
示例
>>> from transformers import BertGenerationConfig, BertGenerationEncoder
>>> # Initializing a BertGeneration config
>>> configuration = BertGenerationConfig()
>>> # Initializing a model (with random weights) from the config
>>> model = BertGenerationEncoder(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
BertGenerationTokenizer
class transformers.BertGenerationTokenizer
< 源代码 >( vocab_file bos_token = '<s>' eos_token = '</s>' unk_token = '<unk>' pad_token = '<pad>' sep_token = '<::::>' sp_model_kwargs: Optional = None **kwargs )
参数
- vocab_file (
str
) — SentencePiece 文件(通常具有 .spm 扩展名),包含实例化词法分析器所需的词汇表。 - bos_token (
str
, 可选, 默认为"<s>"
) — 序列开始标记。 - eos_token (
str
, 可选, 默认为"</s>"
) — 序列结束标记。 - unk_token (
str
, 可选, 默认为"<unk>"
) — 未知标记。不在词汇表中的标记无法转换为 ID,而是设置为此标记。 - pad_token (
str
, 可选, 默认为"<pad>"
) — 用于填充的标记,例如在对不同长度的序列进行批处理时。 - sep_token (
str
, 可选, 默认为"< --:::>"
): 分隔符标记,用于从多个序列构建序列,例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - sp_model_kwargs (
dict
, 可选) — 将传递给SentencePieceProcessor.__init__()
方法。 SentencePiece 的 Python 封装 可以用于,除其他外,设置:-
enable_sampling
: 启用子词正则化。 -
nbest_size
: 一元模型采样参数。对于 BPE-Dropout 无效。nbest_size = {0,1}
: 不执行采样。nbest_size > 1
: 从 nbest_size 个结果中采样。nbest_size < 0
: 假设 nbest_size 为无穷大,并使用前向过滤和后向采样算法从所有假设(格)中采样。
-
alpha
: 一元采样的平滑参数,以及 BPE-Dropout 合并操作的 dropout 概率。
-
构建 BertGeneration 分词器。基于 SentencePiece.
此分词器继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
BertGenerationEncoder
class transformers.BertGenerationEncoder
< source >( config )
参数
- config (BertGenerationConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。
输出原始隐藏状态的裸 BertGeneration 模型变压器,没有任何特定头部。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头部等)。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与一般使用和行为有关的所有事项。
该模型可以充当编码器(仅具有自注意力)以及解码器,在这种情况下,会在自注意力层之间添加一层交叉注意力,遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。
此模型应在利用 Bert 或 Roberta 检查点进行 EncoderDecoderModel 类时使用,如 Sascha Rothe、Shashi Narayan 和 Aliaksei Severyn 在 Leveraging Pre-trained Checkpoints for Sequence Generation Tasks 中所述。
要充当解码器,模型需要使用配置的 is_decoder
参数设置为 True
进行初始化。要在 Seq2Seq 模型中使用,模型需要使用 is_decoder
参数和 add_cross_attention
设置为 True
进行初始化;然后,将 encoder_hidden_states
作为输入传递给正向传递。
forward
< source > ( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。可以通过 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
torch.FloatTensor
形状为(batch_size, sequence_length)
,可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]
中选择:- 1 表示未屏蔽的标记。
- 0 表示屏蔽的标记。
- position_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
,可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]
中选择:- 1 表示头部未屏蔽。
- 0 表示头部屏蔽。
- inputs_embeds (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
,可选) — 可选地,您无需传递input_ids
,而是可以选择直接传递嵌入式表示。如果您希望比模型的内部嵌入查找矩阵更细致地控制如何将input_ids
索引转换为关联的向量,这将非常有用。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是简单的元组。 - encoder_hidden_states (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
,可选) — 编码器最后一层输出处的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor
形状为(batch_size, sequence_length)
,可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器,则此掩码在交叉注意力中使用。掩码值在[0, 1]
中选择:1
表示未屏蔽的标记,0
表示屏蔽的标记。 - past_key_values (
tuple(tuple(torch.FloatTensor))
, 长度为config.n_layers
,每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)
的张量) — 包含注意力块的预先计算的键和值隐藏状态。 可以用来加速解码。如果使用
past_key_values
,用户可以选择性地只输入最后一个decoder_input_ids
(那些没有将过去键值状态提供给该模型的)形状为(batch_size, 1)
,而不是所有decoder_input_ids
形状为(batch_size, sequence_length)
的。 - use_cache (
bool
, 可选) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(请参阅past_key_values
)。
返回值
transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor
的元组(如果传递 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (BertGenerationConfig) 和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层的输出处的隐藏状态序列。如果使用
past_key_values
,则仅输出序列的最后一个隐藏状态,形状为(batch_size, 1, hidden_size)
。 -
past_key_values (
tuple(tuple(torch.FloatTensor))
, 可选, 当传递use_cache=True
或当config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
) 的张量,并且如果config.is_encoder_decoder=True
,则可选地包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的附加张量。包含预先计算的隐藏状态(自注意力块中的键和值,以及如果
config.is_encoder_decoder=True
,则可选地包含交叉注意力块中的键和值),可用于(请参阅past_key_values
输入)加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
的元组(一个用于嵌入层的输出,如果模型具有嵌入层,以及一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型中每层输出处的隐藏状态,以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
和config.add_cross_attention=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
的元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
BertGenerationEncoder 的 forward 方法,覆盖了 __call__
特殊方法。
虽然前向传递的配方需要在此函数中定义,但应该在之后调用 Module
实例,而不是这个,因为前者负责运行预处理和后处理步骤,而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertGenerationEncoder
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/bert_for_seq_generation_L-24_bbc_encoder")
>>> model = BertGenerationEncoder.from_pretrained("google/bert_for_seq_generation_L-24_bbc_encoder")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
BertGenerationDecoder
class transformers.BertGenerationDecoder
< 源代码 >( config )
参数
- config (BertGenerationConfig) — 模型配置类,包含模型的所有参数。 使用配置文件初始化不会加载与模型相关的权重,只加载配置。 查看 from_pretrained() 方法来加载模型权重。
BertGeneration 模型,顶部有一个 语言建模
头,用于 CLM 微调。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头部等)。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与一般使用和行为有关的所有事项。
forward
< 源代码 > ( input_ids: Optional = None attention_mask: 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 past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 词汇表中输入序列令牌的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
torch.FloatTensor
形状为(batch_size, sequence_length)
, 可选) — 掩码以避免对填充令牌索引执行注意力。掩码值选自[0, 1]
:- 1 表示未掩码的令牌,
- 0 表示掩码的令牌。
- position_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
, 可选) — 每个输入序列令牌在位置嵌入中的位置索引。选自范围[0, config.max_position_embeddings - 1]
。 - head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 掩码以使自注意力模块的选定头部无效。掩码值选自[0, 1]
:- 1 表示未掩码的头部,
- 0 表示掩码的头部。
- inputs_embeds (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
, 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您希望比模型的内部嵌入查找矩阵更严格地控制如何将input_ids
索引转换为关联向量,这将非常有用。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - encoder_hidden_states (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
, 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器,则用于交叉注意力。 - encoder_attention_mask (
torch.FloatTensor
形状为(batch_size, sequence_length)
, 可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器,则此掩码用于交叉注意力。掩码值选择在[0, 1]
中:- 1 表示未被掩码的标记,
- 0 表示被掩码的标记。
- labels (
torch.LongTensor
形状为(batch_size, sequence_length)
, 可选) — 用于计算从左到右的语言建模损失(下一个词预测)的标签。索引应该在[-100, 0, ..., config.vocab_size]
中(参见input_ids
文档字符串)索引设置为-100
的标记将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]
中的标记进行计算。 - past_key_values (
tuple(tuple(torch.FloatTensor))
长度为config.n_layers
,每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)
的张量) — 包含预先计算的注意力块的关键和值隐藏状态。可用于加速解码。如果使用
past_key_values
,用户可以选择仅输入形状为(batch_size, 1)
的最后一个decoder_input_ids
(那些没有向此模型提供过去关键值状态的),而不是所有形状为(batch_size, sequence_length)
的decoder_input_ids
。 - use_cache (
bool
, 可选) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(参见past_key_values
)。
返回值
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (BertGenerationConfig) 和输入的不同元素。
-
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=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 SoftMax 之后的交叉注意力权重,用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor))
, 可选, 当传递use_cache=True
或当config.use_cache=True
时返回) — 长度为config.n_layers
的torch.FloatTensor
元组,每个元组包含自注意力和交叉注意力层的缓存关键、值状态,如果模型用于编码器-解码器设置。仅当config.is_decoder = True
时才相关。包含预先计算的隐藏状态(注意力块中的键和值),可用于(参见
past_key_values
输入)加速顺序解码。
BertGenerationDecoder 正向方法,覆盖了 __call__
特殊方法。
虽然前向传递的配方需要在此函数中定义,但应该在之后调用 Module
实例,而不是这个,因为前者负责运行预处理和后处理步骤,而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BertGenerationDecoder, BertGenerationConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/bert_for_seq_generation_L-24_bbc_encoder")
>>> config = BertGenerationConfig.from_pretrained("google/bert_for_seq_generation_L-24_bbc_encoder")
>>> config.is_decoder = True
>>> model = BertGenerationDecoder.from_pretrained(
... "google/bert_for_seq_generation_L-24_bbc_encoder", config=config
... )
>>> inputs = tokenizer("Hello, my dog is cute", return_token_type_ids=False, return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logits