小型 Blenderbot
请注意,BlenderbotSmallModel 和 BlenderbotSmallForConditionalGeneration 只能与检查点 facebook/blenderbot-90M 结合使用。较大的 Blenderbot 检查点应与 BlenderbotModel 和 BlenderbotForConditionalGeneration 结合使用
概述
Blender 聊天机器人模型是在 Stephen Roller、Emily Dinan、Naman Goyal、Da Ju、Mary Williamson、Yinhan Liu、Jing Xu、Myle Ott、Kurt Shuster、Eric M. Smith、Y-Lan Boureau 和 Jason Weston 于 2020 年 4 月 30 日发表的论文《构建开放域聊天机器人的方法》中提出的。
该论文的摘要是:
构建开放域聊天机器人是机器学习研究的一个具有挑战性的领域。虽然先前的研究表明,在参数数量和训练数据规模方面扩展神经模型可以提高结果,但我们发现,其他因素对于构建高性能聊天机器人也很重要。良好的对话需要许多技能,而专业的对话者能够以无缝的方式将这些技能融合在一起:提供引人入胜的话题,倾听对话伙伴,并适当地表现出知识、同理心和个性,同时保持一致的人设。我们发现,在提供适当的训练数据和生成策略选择的情况下,大规模模型可以学习这些技能。我们使用 9000 万、27 亿和 94 亿参数模型构建了这些方法的变体,并公开了我们的模型和代码。人工评估表明,在多轮对话中,我们最好的模型在参与度和人性化指标方面优于现有方法。然后,我们通过分析模型的失败案例来讨论这项工作的局限性。
此模型由 patrickvonplaten 贡献。作者的代码可以在这里找到:这里。
使用技巧
Blenderbot Small 是一个具有绝对位置嵌入的模型,因此通常建议在输入的右侧而不是左侧进行填充。
资源
BlenderbotSmallConfig
类 transformers.BlenderbotSmallConfig
< 源代码 >( vocab_size = 50265 max_position_embeddings = 512 encoder_layers = 8 encoder_ffn_dim = 2048 encoder_attention_heads = 16 decoder_layers = 8 decoder_ffn_dim = 2048 decoder_attention_heads = 16 encoder_layerdrop = 0.0 decoder_layerdrop = 0.0 use_cache = True is_encoder_decoder = True activation_function = 'gelu' d_model = 512 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 decoder_start_token_id = 1 scale_embedding = False pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 forced_eos_token_id = 2 **kwargs )
参数
- vocab_size (
int
, 可选, 默认为 50265) — BlenderbotSmall 模型的词汇量大小。定义在调用 BlenderbotSmallModel 或 TFBlenderbotSmallModel 时传递的inputs_ids
可以表示的不同标记的数量。 - d_model (
int
, 可选, 默认为 512) — 层和池化层维数。 - encoder_layers (
int
, 可选, 默认为 8) — 编码器层数。 - decoder_layers (
int
, 可选, 默认为 8) — 解码器层数。 - encoder_attention_heads (
int
, *可选*, 默认值为 16) — Transformer 编码器中每个注意力层的注意力头数。 - decoder_attention_heads (
int
, *可选*, 默认值为 16) — Transformer 解码器中每个注意力层的注意力头数。 - decoder_ffn_dim (
int
, *可选*, 默认值为 2048) — 解码器中“中间”(通常称为前馈)层的维度。 - encoder_ffn_dim (
int
, *可选*, 默认值为 2048) — 解码器中“中间”(通常称为前馈)层的维度。 - activation_function (
str
或function
, *可选*, 默认值为"gelu"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。 如果是字符串,则支持"gelu"
、"relu"
、"silu"
和"gelu_new"
。 - dropout (
float
, *可选*, 默认值为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float
, *可选*, 默认值为 0.0) — 注意力概率的 dropout 比率。 - activation_dropout (
float
, *可选*, 默认值为 0.0) — 全连接层内部激活的 dropout 比率。 - **max_position_embeddings** (``int``, *可选*, 默认值为 512) — 此模型可能使用的最大序列长度。 通常将其设置为较大的值以防万一(例如,512 或 1024 或 2048)。
- **init_std** (``float``, *可选*, 默认值为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准偏差。
- **encoder_layerdrop** (``float``, *可选*, 默认值为 0.0) — 编码器的 LayerDrop 概率。 有关更多详细信息,请参阅 [LayerDrop 论文](请参阅 https://arxiv.org/abs/1909.11556)。
- **decoder_layerdrop** (``float``, *可选*, 默认值为 0.0) — 解码器的 LayerDrop 概率。 有关更多详细信息,请参阅 [LayerDrop 论文](请参阅 https://arxiv.org/abs/1909.11556)。
- **scale_embedding** (``bool``, *可选*, 默认值为 ``False``) — 通过除以 sqrt(d_model) 来缩放嵌入。
- **use_cache** (``bool``, *可选*, 默认值为 ``True``) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)
- **forced_eos_token_id** (``int``, *可选*, 默认值为 2) — 当达到 ``max_length`` 时,强制作为最后一个生成的标记的标记的 ID。 通常设置为 ``eos_token_id``。
这是用于存储 BlenderbotSmallModel 配置的配置类。 它用于根据指定的参数实例化 BlenderbotSmall 模型,定义模型架构。 使用默认值实例化配置将产生与 BlenderbotSmall facebook/blenderbot_small-90M 架构相似的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。 阅读 PretrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import BlenderbotSmallConfig, BlenderbotSmallModel
>>> # Initializing a BlenderbotSmall facebook/blenderbot_small-90M style configuration
>>> configuration = BlenderbotSmallConfig()
>>> # Initializing a model (with random weights) from the facebook/blenderbot_small-90M style configuration
>>> model = BlenderbotSmallModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
BlenderbotSmallTokenizer
类 transformers.BlenderbotSmallTokenizer
< source >( vocab_file merges_file bos_token = '__start__' eos_token = '__end__' unk_token = '__unk__' pad_token = '__null__' **kwargs )
参数
- vocab_file (
str
) — 包含词汇的文件。 - merges_file (
str
) — 合并文件的路径。 - bos_token (
str
, 可选, 默认为"__start__"
) — 句首标记。 - eos_token (
str
, 可选, 默认为"__end__"
) — 句尾标记。 - unk_token (
str
, 可选, 默认为"__unk__"
) — 未知标记。不在词汇表中的标记无法转换为 ID,而是设置为该标记。 - pad_token (
str
, 可选, 默认为"__null__"
) — 用于填充的标记,例如在批处理不同长度的序列时。 - kwargs (可选) — 传递给 PreTrainedTokenizer 的其他关键字参数
构造一个基于 BPE(字节对编码)的 Blenderbot-90M 分词器。
此分词器继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考超类以获取有关方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记,从一个序列或一对序列构建模型输入,用于序列分类任务。
此实现不添加特殊标记,应在子类中覆盖此方法。
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → 一个在[0, 1]范围内的整数列表。
从没有添加特殊标记的标记列表中检索序列 ID。 当使用分词器 prepare_for_model
或 encode_plus
方法添加特殊标记时调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
创建与传递的序列相对应的标记类型 ID。 什么是标记类型 ID?
如果模型有特殊的构建方式,则应在子类中重写。
BlenderbotSmallTokenizerFast
类 transformers.BlenderbotSmallTokenizerFast
< 源代码 >( vocab_file = None merges_file = None unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' add_prefix_space = False trim_offsets = True **kwargs )
构造一个“快速” BlenderbotSmall 分词器(由 HuggingFace 的 *tokenizers* 库提供支持)。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
根据传递的两个序列创建一个掩码,用于序列对分类任务。 BlenderbotSmall 不使用词类型 ID,因此返回一个零列表。
BlenderbotSmallModel
类 transformers.BlenderbotSmallModel
< 源代码 >( config: BlenderbotSmallConfig )
参数
- config (BlenderbotSmallConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
BlenderbotSmall 模型的裸模型,输出原始隐藏状态,顶部没有任何特定的头部。此模型继承自 PreTrainedModel。有关库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等),请查看超类文档。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以获取与一般使用和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional[torch.LongTensor] = None attention_mask: Optional[torch.FloatTensor] = None decoder_input_ids: Optional[torch.LongTensor] = None decoder_attention_mask: Optional[torch.BoolTensor] = None head_mask: Optional[torch.FloatTensor] = None decoder_head_mask: Optional[torch.FloatTensor] = None cross_attn_head_mask: Optional[torch.Tensor] = None encoder_outputs: Optional[Tuple[torch.FloatTensor]] = None past_key_values: Optional[Tuple[Tuple[torch.FloatTensor]]] = None inputs_embeds: Optional[torch.FloatTensor] = None decoder_inputs_embeds: Optional[torch.FloatTensor] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None ) → transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
, 形状为(batch_size, sequence_length)
) — 词汇表中输入序列词符的索引。如果您提供了填充,默认情况下将会忽略它。索引可以使用 AutoTokenizer 获取。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解更多详情。
- attention_mask (
torch.Tensor
, 形状为(batch_size, sequence_length)
, 可选) — 避免在填充词符索引上执行注意力机制的掩码。掩码值在[0, 1]
中选择:- 1 表示词符未被掩码,
- 0 表示词符已被掩码。
- decoder_input_ids (
torch.LongTensor
, 形状为(batch_size, target_sequence_length)
, 可选) — 词汇表中解码器输入序列词符的索引。索引可以使用 AutoTokenizer 获取。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解更多详情。
BlenderbotSmall 使用
bos_token_id
作为decoder_input_ids
生成的开始词符。 如果使用了past_key_values
,则可以选择只输入最后一个decoder_input_ids
(请参阅past_key_values
)。 - decoder_attention_mask (
torch.LongTensor
, 形状为(batch_size, target_sequence_length)
, 可选) — 默认行为:生成一个忽略decoder_input_ids
中的填充词符的张量。 默认情况下也会使用因果掩码。 - head_mask (
torch.Tensor
, 形状为(encoder_layers, encoder_attention_heads)
, 可选) — 用于将编码器中注意力模块的选定头部置空的掩码。掩码值在[0, 1]
中选择:- 1 表示头部未被掩码,
- 0 表示头部已被掩码。
- decoder_head_mask (
torch.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 用于将解码器中注意力模块的选定头部置空的掩码。掩码值在[0, 1]
中选择:- 1 表示头部未被掩码,
- 0 表示头部已被掩码。
- cross_attn_head_mask (
torch.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 用于将解码器中交叉注意力模块的选定头部置零的掩码。掩码值在[0, 1]
中选择:- 1 表示头部**未被遮蔽**,
- 0 表示头部**已被遮蔽**。
- encoder_outputs (
tuple(tuple(torch.FloatTensor)
, 可选) — 由 (last_hidden_state
, _可选_:hidden_states
, _可选_:attentions
) 组成的元组。 形状为(batch_size, sequence_length, hidden_size)
的last_hidden_state
(可选)是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - 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)
的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的额外张量。包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以使用这些状态(参见
past_key_values
输入)来加速序列解码。如果使用
past_key_values
,则用户可以选择只输入形状为(batch_size, 1)
的最后decoder_input_ids
(那些没有将其过去的键值状态提供给该模型的),而不是形状为(batch_size, sequence_length)
的所有decoder_input_ids
。 - inputs_embeds (
torch.FloatTensor
, 形状为(batch_size, sequence_length, hidden_size)
, 可选) — 您可以选择直接传递嵌入表示,而不是传递input_ids
。 如果您想比模型的内部嵌入查找矩阵更能控制如何将input_ids
索引转换为关联向量,这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensor
, 形状为(batch_size, target_sequence_length, hidden_size)
, 可选) — 您可以选择直接传递嵌入表示,而不是传递decoder_input_ids
。 如果使用past_key_values
,则可以选择只输入最后的decoder_inputs_embeds
(参见past_key_values
)。 如果您想比模型的内部嵌入查找矩阵更能控制如何将decoder_input_ids
索引转换为关联向量,这将非常有用。如果
decoder_input_ids
和decoder_inputs_embeds
都未设置,则decoder_inputs_embeds
采用inputs_embeds
的值。 - 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.Seq2SeqModelOutput 或 ``tuple(torch.FloatTensor)``
一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 ``torch.FloatTensor`` 元组(如果传递了 ``return_dict=False`` 或 ``config.return_dict=False``),包含根据配置 (BlenderbotSmallConfig) 和输入的各种元素。
-
**last_hidden_state** (形状为 ``(batch_size, sequence_length, hidden_size)`` 的 ``torch.FloatTensor``) — 模型解码器最后一层输出的隐藏状态序列。
如果使用 ``past_key_values``,则仅输出形状为 ``(batch_size, 1, hidden_size)`` 的序列的最后一个隐藏状态。
-
**past_key_values** (``tuple(tuple(torch.FloatTensor))``, *可选*,在传递 ``use_cache=True`` 或 ``config.use_cache=True`` 时返回) — 长度为 ``config.n_layers`` 的 ``tuple(torch.FloatTensor)`` 元组,每个元组具有 2 个形状为 ``(batch_size, num_heads, sequence_length, embed_size_per_head)``) 的张量和 2 个形状为 ``(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)`` 的附加张量。
包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以使用这些状态(请参阅 ``past_key_values`` 输入)来加速序列解码。
-
**decoder_hidden_states** (``tuple(torch.FloatTensor)``, *可选*,在传递 ``output_hidden_states=True`` 或 ``config.output_hidden_states=True`` 时返回) — ``torch.FloatTensor`` 元组(如果模型具有嵌入层,则为嵌入的输出 + 每个层的输出),形状为 ``(batch_size, sequence_length, hidden_size)``。
解码器在每一层输出处的隐藏状态以及可选的初始嵌入输出。
-
**decoder_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 之后,用于计算交叉注意力头中的加权平均值。
-
**encoder_last_hidden_state** (形状为 ``(batch_size, sequence_length, hidden_size)`` 的 ``torch.FloatTensor``, *可选*) — 模型编码器最后一层输出的隐藏状态序列。
-
**encoder_hidden_states** (``tuple(torch.FloatTensor)``, *可选*,在传递 ``output_hidden_states=True`` 或 ``config.output_hidden_states=True`` 时返回) — ``torch.FloatTensor`` 元组(如果模型具有嵌入层,则为嵌入的输出 + 每个层的输出),形状为 ``(batch_size, sequence_length, hidden_size)``。
编码器在每一层输出处的隐藏状态以及可选的初始嵌入输出。
-
**encoder_attentions** (``tuple(torch.FloatTensor)``, *可选*,在传递 ``output_attentions=True`` 或 ``config.output_attentions=True`` 时返回) — ``torch.FloatTensor`` 元组(每一层一个),形状为 ``(batch_size, num_heads, sequence_length, sequence_length)``。
编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
BlenderbotSmallModel 前向方法,覆盖 ``__call__`` 特殊方法。
尽管需要在此函数中定义前向传递的方法,但之后应该调用 ``Module`` 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BlenderbotSmallModel
>>> model = BlenderbotSmallModel.from_pretrained("facebook/blenderbot_small-90M")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> inputs = tokenizer("Studies have been shown that owning a dog is good for you", return_tensors="pt")
>>> decoder_inputs = tokenizer("Studies show that", return_tensors="pt") # Batch size 1
>>> outputs = model(input_ids=inputs.input_ids, decoder_input_ids=decoder_inputs.input_ids)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 3, 512]
BlenderbotSmallForConditionalGeneration
类 transformers.BlenderbotSmallForConditionalGeneration
< source >( config: BlenderbotSmallConfig )
参数
- config (BlenderbotSmallConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
具有语言建模头的 BlenderbotSmall 模型。 可用于摘要。 此模型继承自 PreTrainedModel。 查看超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以获取与一般使用和行为相关的所有内容。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Union = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_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.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。 如果您提供填充,默认情况下将忽略它。索引可以使用 AutoTokenizer 获取。 有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
, 形状为(batch_size, sequence_length)
,可选) — 掩码,用于避免对填充标记索引执行注意力。掩码值在[0, 1]
中选择:- 1 表示标记**未被掩盖**,
- 0 表示标记**已被掩盖**。
- decoder_input_ids (
torch.LongTensor
, 形状为(batch_size, target_sequence_length)
,可选) — 词汇表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
BlenderbotSmall 使用
bos_token_id
作为decoder_input_ids
生成的起始标记。如果使用past_key_values
,则可以选择仅输入最后的decoder_input_ids
(请参阅past_key_values
)。 - decoder_attention_mask (
torch.LongTensor
, 形状为(batch_size, target_sequence_length)
,可选) — 默认行为:生成一个忽略decoder_input_ids
中填充标记的张量。默认情况下也将使用因果掩码。 - head_mask (
torch.Tensor
, 形状为(encoder_layers, encoder_attention_heads)
,可选) — 掩码,用于将编码器中注意力模块的选定头部置零。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩盖**,
- 0 表示头部**已被掩盖**。
- decoder_head_mask (
torch.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
,可选) — 掩码,用于将解码器中注意力模块的选定头部置零。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩盖**,
- 0 表示头部**已被掩盖**。
- cross_attn_head_mask (
torch.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
,可选) — 掩码,用于将解码器中交叉注意力模块的选定头部置零。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩盖**,
- 0 表示头部**已被掩盖**。
- **encoder_outputs** (
tuple(tuple(torch.FloatTensor))
, *可选*) — 由 (last_hidden_state
, *可选*:hidden_states
, *可选*:attentions
) 组成的元组。last_hidden_state
的形状为(batch_size, sequence_length, 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)
的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的附加张量。包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以使用这些状态(参见
past_key_values
输入)来加速序列解码。如果使用了
past_key_values
,则用户可以选择仅输入形状为(batch_size, 1)
的最后decoder_input_ids
(那些没有将其过去的键值状态提供给此模型的),而不是形状为(batch_size, sequence_length)
的所有decoder_input_ids
。 - **inputs_embeds** (形状为
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, *可选*) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您希望更好地控制如何将input_ids
索引转换为关联向量,而不是使用模型的内部嵌入查找矩阵,则此选项非常有用。 - **decoder_inputs_embeds** (形状为
(batch_size, target_sequence_length, hidden_size)
的torch.FloatTensor
, *可选*) — 可选地,您可以选择直接传递嵌入表示,而不是传递decoder_input_ids
。如果使用了past_key_values
,则可以选择仅输入最后的decoder_inputs_embeds
(参见past_key_values
)。如果您希望更好地控制如何将decoder_input_ids
索引转换为关联向量,而不是使用模型的内部嵌入查找矩阵,则此选项非常有用。如果
decoder_input_ids
和decoder_inputs_embeds
均未设置,则decoder_inputs_embeds
将采用inputs_embeds
的值。 - **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)
, 可选) — 用于计算掩码语言建模损失的标签。索引应该在[0, ..., config.vocab_size]
或 -100 中(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]
中的标记计算。
返回值
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqLMOutput 或 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
)包含根据配置 (BlenderbotSmallConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor
形状为(1,)
, 可选,当提供labels
时返回) — 语言建模损失。 -
logits (
torch.FloatTensor
形状为(batch_size, sequence_length, config.vocab_size)
) — 语言建模头的预测分数(SoftMax 之前的每个词汇标记的分数)。 -
**past_key_values** (``tuple(tuple(torch.FloatTensor))``, *可选*,在传递 ``use_cache=True`` 或 ``config.use_cache=True`` 时返回) — 长度为 ``config.n_layers`` 的 ``tuple(torch.FloatTensor)`` 元组,每个元组具有 2 个形状为 ``(batch_size, num_heads, sequence_length, embed_size_per_head)``) 的张量和 2 个形状为 ``(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)`` 的附加张量。
包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以使用这些状态(请参阅 ``past_key_values`` 输入)来加速序列解码。
-
**decoder_hidden_states** (``tuple(torch.FloatTensor)``, *可选*,在传递 ``output_hidden_states=True`` 或 ``config.output_hidden_states=True`` 时返回) — ``torch.FloatTensor`` 元组(如果模型具有嵌入层,则为嵌入的输出 + 每个层的输出),形状为 ``(batch_size, sequence_length, hidden_size)``。
解码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
**decoder_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 之后,用于计算交叉注意力头中的加权平均值。
-
**encoder_last_hidden_state** (形状为 ``(batch_size, sequence_length, hidden_size)`` 的 ``torch.FloatTensor``, *可选*) — 模型编码器最后一层输出的隐藏状态序列。
-
**encoder_hidden_states** (``tuple(torch.FloatTensor)``, *可选*,在传递 ``output_hidden_states=True`` 或 ``config.output_hidden_states=True`` 时返回) — ``torch.FloatTensor`` 元组(如果模型具有嵌入层,则为嵌入的输出 + 每个层的输出),形状为 ``(batch_size, sequence_length, hidden_size)``。
编码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
**encoder_attentions** (``tuple(torch.FloatTensor)``, *可选*,在传递 ``output_attentions=True`` 或 ``config.output_attentions=True`` 时返回) — ``torch.FloatTensor`` 元组(每一层一个),形状为 ``(batch_size, num_heads, sequence_length, sequence_length)``。
编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
BlenderbotSmallForConditionalGeneration forward 方法,覆盖 __call__
特殊方法。
尽管需要在此函数中定义前向传递的方法,但之后应该调用 ``Module`` 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
对话示例
>>> from transformers import AutoTokenizer, BlenderbotSmallForConditionalGeneration
>>> mname = "facebook/blenderbot_small-90M"
>>> model = BlenderbotSmallForConditionalGeneration.from_pretrained(mname)
>>> tokenizer = AutoTokenizer.from_pretrained(mname)
>>> UTTERANCE = "My friends are cool but they eat too many carbs."
>>> print("Human: ", UTTERANCE)
Human: My friends are cool but they eat too many carbs.
>>> inputs = tokenizer([UTTERANCE], return_tensors="pt")
>>> reply_ids = model.generate(**inputs)
>>> print("Bot: ", tokenizer.batch_decode(reply_ids, skip_special_tokens=True)[0])
Bot: what kind of carbs do they eat? i don't know much about carbs.
>>> REPLY = "I'm not sure"
>>> print("Human: ", REPLY)
Human: I'm not sure
>>> NEXT_UTTERANCE = (
... "My friends are cool but they eat too many carbs.__end__ __start__what kind of carbs do they eat? "
... "i don't know much about carbs__end__ "
... "__start__ I'm not sure."
... )
>>> inputs = tokenizer([NEXT_UTTERANCE], return_tensors="pt")
>>> next_reply_ids = model.generate(**inputs)
>>> print("Bot: ", tokenizer.batch_decode(next_reply_ids, skip_special_tokens=True)[0])
Bot: they eat a lot of carbs. carbs are high in fat, protein, and fats.
BlenderbotSmallForCausalLM
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: 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.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 掩码以避免对填充标记索引执行注意力。在[0, 1]
中选择的掩码值:- 1 表示未屏蔽的标记,
- 0 表示已屏蔽的标记。
- encoder_hidden_states (
torch.FloatTensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 编码器最后一层输出处的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor
,形状为(batch_size, sequence_length)
,可选) — 掩码以避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器,则在交叉注意力中使用此掩码。在[0, 1]
中选择的掩码值: - head_mask (
torch.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 用于将注意力模块的选定头部置零的掩码。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩码**,
- 0 表示头部**已被掩码**。
- cross_attn_head_mask (
torch.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 用于将交叉注意力模块的选定头部置零的掩码。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩码**,
- 0 表示头部**已被掩码**。
- past_key_values (
tuple(tuple(torch.FloatTensor))
, 可选, 当传入use_cache=True
或config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(tuple(torch.FloatTensor))
元组,每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的附加张量。 仅当模型在序列到序列模型中用作解码器时才需要这两个附加张量。包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以使用这些状态(参见
past_key_values
输入)来加速序列解码。如果使用了
past_key_values
,用户可以选择只输入形状为(batch_size, 1)
的最后decoder_input_ids
(那些没有将其过去的键值状态提供给此模型的),而不是形状为(batch_size, sequence_length)
的所有decoder_input_ids
。 - labels (
torch.LongTensor
, 形状为(batch_size, sequence_length)
, 可选) — 用于计算掩码语言建模损失的标签。索引应该在[0, ..., config.vocab_size]
或 -100 中(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]
中的标记计算。 - use_cache (
bool
, 可选) — 如果设置为True
,则返回past_key_values
键值状态,并且可以使用这些状态来加速解码(参见past_key_values
)。- 1 表示标记**未被掩码**,
- 0 表示标记**已被掩码**。
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - **output_hidden_states** (``bool``, *可选*) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 `hidden_states`。
- **return_dict** (``bool``, *可选*) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 ``torch.FloatTensor`` 的元组(如果传入 `return_dict=False` 或 `config.return_dict=False`)包含根据配置 (BlenderbotSmallConfig) 和输入的不同元素。
-
**loss** (形状为 ``(1,)`` 的 ``torch.FloatTensor``, *可选*, 当提供 `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` 输入)来加速序列解码。
示例
>>> from transformers import AutoTokenizer, BlenderbotSmallForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> model = BlenderbotSmallForCausalLM.from_pretrained("facebook/blenderbot_small-90M", add_cross_attention=False)
>>> assert model.config.is_decoder, f"{model.__class__} has to be configured as a decoder."
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> expected_shape = [1, inputs.input_ids.shape[-1], model.config.vocab_size]
>>> list(logits.shape) == expected_shape
True
TFBlenderbotSmallModel
类 transformers.TFBlenderbotSmallModel
< source >( config: BlenderbotSmallConfig *inputs **kwargs )
参数
- config (BlenderbotSmallConfig) - 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重,只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
裸 BLENDERBOT_SMALL 模型输出原始隐藏状态,顶部没有任何特定头部。 该模型继承自 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 函数一样传递输入!
调用
< 源代码 >( input_ids: tf.Tensor | None = None attention_mask: tf.Tensor | None = None decoder_input_ids: tf.Tensor | None = None decoder_attention_mask: tf.Tensor | None = None decoder_position_ids: tf.Tensor | None = None head_mask: tf.Tensor | None = None decoder_head_mask: tf.Tensor | None = None cross_attn_head_mask: tf.Tensor | None = None encoder_outputs: Optional[Union[Tuple, TFBaseModelOutput]] = None past_key_values: List[tf.Tensor] | None = None inputs_embeds: tf.Tensor | None = None decoder_inputs_embeds: 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 **kwargs ) → transformers.modeling_tf_outputs.TFSeq2SeqModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
tf.Tensor
类型为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor
类型为(batch_size, sequence_length)
, 可选) — 避免对填充标记索引执行注意力机制的掩码。在[0, 1]
中选择的掩码值:- 1 表示标记**未被掩码**,
- 0 表示标记**已被掩码**。
- decoder_input_ids (
tf.Tensor
类型为(batch_size, target_sequence_length)
, 可选) — 词汇表中解码器输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
BlenderbotSmall 使用
bos_token_id
作为decoder_input_ids
生成的起始标记。 如果使用past_key_values
,则可以选择只输入最后的decoder_input_ids
(请参阅past_key_values
)。 - decoder_attention_mask (
tf.Tensor
类型为(batch_size, target_sequence_length)
, 可选) — 将默认生成并忽略填充标记。对于大多数用例,不建议设置此项。 - decoder_position_ids (
tf.Tensor
类型为(batch_size, sequence_length)
, 可选) — 位置嵌入中每个解码器输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - head_mask (
tf.Tensor
类型为(encoder_layers, encoder_attention_heads)
, 可选) — 用于使编码器中选定注意力模块头部无效的掩码。在[0, 1]
中选择的掩码值:- 1 表示头部**未被掩码**,
- 0 表示头部**已被掩码**。
- decoder_head_mask (
tf.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 用于将解码器中选定的注意力模块的头部置零的掩码。掩码值的范围为[0, 1]
:- 1 表示该头部**未被掩盖**,
- 0 表示该头部**已被掩盖**。
- cross_attn_head_mask (
tf.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 用于将交叉注意力模块中选定的头部置零的掩码。掩码值的范围为[0, 1]
:- 1 表示该头部**未被掩盖**,
- 0 表示该头部**已被掩盖**。
- encoder_outputs (
tf.FloatTensor
, 可选) — 编码器最后一层的隐藏状态输出。用于解码器的交叉注意力机制。形状为(batch_size, sequence_length, hidden_size)
,表示 - past_key_values (长度为
config.n_layers
的Tuple[Tuple[tf.Tensor]]
) — 包含注意力块预先计算的键和值隐藏状态。可用于加速解码。如果使用past_key_values
,则用户可以选择仅输入最后的decoder_input_ids
(那些没有将其过去的键值状态提供给该模型的 ID),其形状为(batch_size, 1)
,而不是输入形状为(batch_size, sequence_length)
的所有decoder_input_ids
。 - use_cache (
bool
, 可选, 默认值为True
) — 如果设置为True
,则会返回past_key_values
键值状态,并可用于加速解码(请参阅past_key_values
)。在训练期间设置为False
,在生成期间设置为True
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的attentions
。此参数只能在渴望模式下使用,在图形模式下,将使用配置中的值。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states
。此参数只能在渴望模式下使用,在图形模式下,将使用配置中的值。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用,在图模式下,该值将始终设置为 True。 - training (
bool
, 可选, 默认值:False
) — 是否在训练模式下使用模型(某些模块(如 dropout 模块)在训练和评估之间的行为不同)。
返回值
transformers.modeling_tf_outputs.TFSeq2SeqModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSeq2SeqModelOutput 或一个 tf.Tensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含根据配置 (BlenderbotSmallConfig) 和输入的不同元素。
-
last_hidden_state (
tf.Tensor
,形状为(batch_size, sequence_length, hidden_size)
) — 模型解码器最后一层输出的隐藏状态序列。如果使用 ``past_key_values``,则仅输出形状为 ``(batch_size, 1, hidden_size)`` 的序列的最后一个隐藏状态。
-
past_key_values (
List[tf.Tensor]
, 可选, 当传递use_cache=True
或config.use_cache=True
时返回) — 长度为config.n_layers
的tf.Tensor
列表,每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)
)。包含解码器的预先计算的隐藏状态(注意力块中的键和值),可以使用这些状态(参见
past_key_values
输入)来加速序列解码。 -
decoder_hidden_states (
tuple(tf.Tensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —tf.Tensor
元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。解码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(tf.Tensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
tf.Tensor
,形状为(batch_size, sequence_length, hidden_size)
, 可选) — 模型编码器最后一层输出的隐藏状态序列。 -
encoder_hidden_states (
tuple(tf.Tensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —tf.Tensor
元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。编码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(tf.Tensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
TFBlenderbotSmallModel forward 方法,覆盖了 __call__
特殊方法。
尽管需要在此函数中定义前向传递的方法,但之后应该调用 ``Module`` 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFBlenderbotSmallModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> model = TFBlenderbotSmallModel.from_pretrained("facebook/blenderbot_small-90M")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_state
TFBlenderbotSmallForConditionalGeneration
类 transformers.TFBlenderbotSmallForConditionalGeneration
< source >( config *inputs **kwargs )
参数
- config (BlenderbotSmallConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
具有语言建模头的 BLENDERBOT_SMALL 模型。可用于摘要。此模型继承自 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 函数一样传递输入!
调用
< 源代码 >( input_ids: tf.Tensor | None = None attention_mask: tf.Tensor | None = None decoder_input_ids: tf.Tensor | None = None decoder_attention_mask: tf.Tensor | None = None decoder_position_ids: tf.Tensor | None = None head_mask: tf.Tensor | None = None decoder_head_mask: tf.Tensor | None = None cross_attn_head_mask: tf.Tensor | None = None encoder_outputs: Optional[TFBaseModelOutput] = None past_key_values: List[tf.Tensor] | None = None inputs_embeds: tf.Tensor | None = None decoder_inputs_embeds: 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: tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
tf.Tensor
形状为({0})
) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor
, 形状为({0})
, 可选) — 掩码以避免对填充标记索引执行注意力机制。掩码值在[0, 1]
中选择:- 1 表示标记**未被掩码**,
- 0 表示标记**已被掩码**。
- decoder_input_ids (
tf.Tensor
, 形状为(batch_size, target_sequence_length)
, 可选) — 词汇表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获取。 更多细节请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.**call**()。
BlenderbotSmall 使用
bos_token_id
作为decoder_input_ids
生成的起始标记。如果使用past_key_values
,则可以选择仅输入最后的decoder_input_ids
(参见past_key_values
)。 - decoder_attention_mask (
tf.Tensor
, 形状为(batch_size, target_sequence_length)
, 可选) — 将默认生成并忽略填充标记。对于大多数用例,不建议设置此项。 - decoder_position_ids (
tf.Tensor
, 形状为(batch_size, sequence_length)
, 可选) — 位置嵌入中每个解码器输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - head_mask (
tf.Tensor
, 形状为(encoder_layers, encoder_attention_heads)
, 可选) — 掩码以使编码器中注意力模块的所选头部无效。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩码**,
- 0 表示头部**已被掩码**。
- decoder_head_mask (
tf.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 掩码以使解码器中注意力模块的所选头部无效。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩码**,
- 0 表示头部**已被掩码**。
- cross_attn_head_mask (
tf.Tensor
, 形状为(decoder_layers, decoder_attention_heads)
, 可选) — 用于使交叉注意力模块的选定头部无效的掩码。掩码值在[0, 1]
中选择:- 1 表示头部**未被掩盖**,
- 0 表示头部**已被掩盖**。
- encoder_outputs (
tf.FloatTensor
, 可选) — 编码器最后一层的隐藏状态输出。用于解码器的交叉注意力机制。形状为(batch_size, sequence_length, hidden_size)
,表示 - past_key_values (长度为
config.n_layers
的Tuple[Tuple[tf.Tensor]]
) — 包含注意力块的预先计算的键和值隐藏状态。可用于加速解码。如果使用了past_key_values
,则用户可以选择仅输入最后的decoder_input_ids
(那些没有将过去的键值状态提供给此模型的),其形状为(batch_size, 1)
,而不是所有形状为(batch_size, sequence_length)
的decoder_input_ids
。 - use_cache (
bool
, 可选, 默认值为True
) — 如果设置为True
,则返回past_key_values
键值状态,并可用于加速解码(请参阅past_key_values
)。在训练期间设置为False
,在生成期间设置为True
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。此参数只能在渴望模式下使用,在图形模式下,将使用配置中的值。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。此参数只能在渴望模式下使用,在图形模式下,将使用配置中的值。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在渴望模式下使用,在图形模式下,该值将始终设置为 True。 - training (
bool
,可选,默认为False
) — 是否在训练模式下使用模型(某些模块(如 dropout 模块)在训练和评估之间的行为不同)。 - labels (形状为
(batch_size, sequence_length)
的tf.tensor
,可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]
或 -100 中(请参阅input_ids
文档字符串)。索引设置为-100
的标记将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]
中的标记计算。
返回值
transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或 tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFSeq2SeqLMOutput 或 tf.Tensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
)包含根据配置 (BlenderbotSmallConfig) 和输入的各种元素。
-
loss (形状为
(n,)
的tf.Tensor
,可选,其中 n 是未掩码标签的数量,在提供labels
时返回) — 语言建模损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)
的tf.Tensor
) — 语言建模头的预测分数(SoftMax 之前的每个词汇标记的分数)。 -
past_key_values (
List[tf.Tensor]
, 可选, 当传递use_cache=True
或config.use_cache=True
时返回) — 长度为config.n_layers
的tf.Tensor
列表,每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)
)。包含解码器的预先计算的隐藏状态(注意力块中的键和值),可以使用这些状态(参见
past_key_values
输入)来加速序列解码。 -
decoder_hidden_states (
tuple(tf.Tensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —tf.Tensor
元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。解码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(tf.Tensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (
tf.Tensor
,形状为(batch_size, sequence_length, hidden_size)
, 可选) — 模型编码器最后一层输出的隐藏状态序列。 -
encoder_hidden_states (
tuple(tf.Tensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —tf.Tensor
元组(一个用于嵌入的输出 + 一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。编码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(tf.Tensor)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —tf.Tensor
元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
TFBlenderbotSmallForConditionalGeneration forward 方法,覆盖 __call__
特殊方法。
尽管需要在此函数中定义前向传递的方法,但之后应该调用 ``Module`` 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
对话示例:
>>> from transformers import AutoTokenizer, TFBlenderbotSmallForConditionalGeneration
>>> mname = "facebook/blenderbot_small-90M"
>>> model = BlenderbotSmallForConditionalGeneration.from_pretrained(mname)
>>> tokenizer = AutoTokenizer.from_pretrained(mname)
>>> UTTERANCE = "My friends are cool but they eat too many carbs."
>>> print("Human: ", UTTERANCE)
>>> inputs = tokenizer([UTTERANCE], return_tensors="tf")
>>> reply_ids = model.generate(**inputs)
>>> print("Bot: ", tokenizer.batch_decode(reply_ids, skip_special_tokens=True)[0])
what kind of carbs do they eat? i don't know much about carbs.
>>> REPLY = "I'm not sure"
>>> print("Human: ", REPLY)
>>> NEXT_UTTERANCE = (
... "My friends are cool but they eat too many carbs.</s> "
... "<s>what kind of carbs do they eat? i don't know much about carbs.</s> "
... "<s>I'm not sure."
... )
>>> inputs = tokenizer([NEXT_UTTERANCE], return_tensors="tf")
>>> inputs.pop("token_type_ids")
>>> next_reply_ids = model.generate(**inputs)
>>> print("Bot: ", tokenizer.batch_decode(next_reply_ids, skip_special_tokens=True)[0])
FlaxBlenderbotSmallModel
class transformers.FlaxBlenderbotSmallModel
< source >( config: BlenderbotSmallConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (BlenderbotSmallConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,而只会加载配置。请查看 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。
裸 BlenderbotSmall 模型转换器输出原始隐藏状态,顶部没有任何特定的头。此模型继承自 FlaxPreTrainedModel。有关库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头等),请查看超类文档。
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块,并参考 Flax 文档以了解有关一般用法和行为的所有事项。
最后,此模型支持固有的 JAX 功能,例如
__call__
< source >( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
返回值
transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput 或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含根据配置 (BlenderbotSmallConfig) 和输入的不同元素。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的jnp.ndarray
) — 模型解码器最后一层输出处的隐藏状态序列。如果使用 ``past_key_values``,则仅输出形状为 ``(batch_size, 1, hidden_size)`` 的序列的最后一个隐藏状态。
-
past_key_values (
tuple(tuple(jnp.ndarray))
, 可选, 当传递use_cache=True
或config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(tuple(jnp.ndarray))
元组,每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
) 的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的附加张量。包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以使用这些状态(请参阅 ``past_key_values`` 输入)来加速序列解码。
-
decoder_hidden_states (
tuple(jnp.ndarray)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。解码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(jnp.ndarray)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的jnp.ndarray
, 可选) — 模型编码器最后一层输出处的隐藏状态序列。 -
encoder_hidden_states (
tuple(jnp.ndarray)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。编码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(jnp.ndarray)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, FlaxBlenderbotSmallModel
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> model = FlaxBlenderbotSmallModel.from_pretrained("facebook/blenderbot_small-90M")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
编码
< 源代码 >( input_ids: 数组 attention_mask: 可选 = None position_ids: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
jnp.ndarray
, 形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略它。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
jnp.ndarray
, 形状为(batch_size, sequence_length)
, 可选) — 掩码以避免对填充标记索引执行注意力。在[0, 1]
中选择的掩码值:- 未被掩码 的标记为 1,
- 被掩码 的标记为 0。
- position_ids (
numpy.ndarray
, 形状为(batch_size, sequence_length)
, 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 torch.FloatTensor
的元组(如果传递 return_dict=False
或 config.return_dict=False
),根据配置(<class 'transformers.models.blenderbot_small.configuration_blenderbot_small.BlenderbotSmallConfig'>
)和输入包含各种元素。
-
last_hidden_state (
jnp.ndarray
,形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(jnp.ndarray)
, 可选,当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)
, 可选,当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
的元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, FlaxBlenderbotSmallForConditionalGeneration
>>> model = FlaxBlenderbotSmallForConditionalGeneration.from_pretrained("facebook/blenderbot_small-90M")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="np")
>>> encoder_outputs = model.encode(**inputs)
decode
< source >( decoder_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- decoder_input_ids (
jnp.ndarray
,形状为(batch_size, target_sequence_length)
) — 词汇表中解码器输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
对于翻译和摘要训练,应提供
decoder_input_ids
。如果没有提供decoder_input_ids
,模型将根据论文,通过将input_ids
向右移动来创建此张量,以进行去噪预训练。 - encoder_outputs (
tuple(tuple(jnp.ndarray)
) — 由以下各项组成的元组:(last_hidden_state
, 可选:hidden_states
, 可选:attentions
) 形状为(batch_size, sequence_length, hidden_size)
的last_hidden_state
(可选)是编码器最后一层输出处的隐藏状态序列。用于解码器的交叉注意力机制。 - encoder_attention_mask (形状为
(batch_size, sequence_length)
的jnp.ndarray
,可选) — 避免对填充标记索引执行注意力机制的掩码。在[0, 1]
中选择的掩码值:- 1 表示 未被掩码 的标记,
- 0 表示 已被掩码 的标记。
- decoder_attention_mask (形状为
(batch_size, target_sequence_length)
的jnp.ndarray
,可选) — 默认行为:生成一个忽略decoder_input_ids
中填充标记的张量。默认情况下也将使用因果掩码。如果要更改填充行为,则应根据需要进行修改。有关默认策略的详细信息,请参见 论文 中的图 1。
- decoder_position_ids (形状为
(batch_size, sequence_length)
的numpy.ndarray
,可选) — 位置嵌入中每个解码器输入序列标记的位置索引。在[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.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含根据配置 (<class 'transformers.models.blenderbot_small.configuration_blenderbot_small.BlenderbotSmallConfig'>
) 和输入而定的各种元素。
-
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=True
或config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(tuple(jnp.ndarray))
元组,每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
) 的张量,并且如果config.is_encoder_decoder=True
,则可选 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
) 的附加张量。包含预先计算的隐藏状态(自注意力块中的键和值,以及如果
config.is_encoder_decoder=True
则可选交叉注意力块中的键和值),可以使用这些状态(参见past_key_values
输入)来加速顺序解码。 -
hidden_states (
tuple(jnp.ndarray)
, 可选,当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)
, 可选,当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
的元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray)
, *可选*,当传递output_attentions=True
和config.add_cross_attention=True
或config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的jnp.ndarray
元组(每层一个)。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
示例
>>> import jax.numpy as jnp
>>> from transformers import AutoTokenizer, FlaxBlenderbotSmallForConditionalGeneration
>>> model = FlaxBlenderbotSmallForConditionalGeneration.from_pretrained("facebook/blenderbot_small-90M")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="np")
>>> encoder_outputs = model.encode(**inputs)
>>> decoder_start_token_id = model.config.decoder_start_token_id
>>> decoder_input_ids = jnp.ones((inputs.input_ids.shape[0], 1), dtype="i4") * decoder_start_token_id
>>> outputs = model.decode(decoder_input_ids, encoder_outputs)
>>> last_decoder_hidden_states = outputs.last_hidden_state
FlaxBlenderbotForConditionalGeneration
类 transformers.FlaxBlenderbotSmallForConditionalGeneration
< 源代码 >( config: BlenderbotSmallConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (BlenderbotSmallConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
- dtype (
jax.numpy.dtype
, *可选*, 默认为jax.numpy.float32
) — 计算的数据类型。可以是jax.numpy.float32
、jax.numpy.float16
(在 GPU 上)和jax.numpy.bfloat16
(在 TPU 上)之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的
dtype
执行。请注意,这仅指定计算的数据类型,不会影响模型参数的数据类型。
具有语言建模头的 BLENDERBOT_SMALL 模型。可用于摘要。此模型继承自 FlaxPreTrainedModel。有关库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等),请查看超类文档。
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块,并参考 Flax 文档以了解有关一般用法和行为的所有事项。
最后,此模型支持固有的 JAX 功能,例如
__call__
< 源代码 >( input_ids: Array attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None position_ids: Optional = None decoder_position_ids: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
jnp.ndarray
,形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。如果您提供填充,默认情况下将忽略它。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
jnp.ndarray
,形状为(batch_size, sequence_length)
, *可选*) — 掩码以避免对填充标记索引执行注意力。在[0, 1]
中选择的掩码值:- 未屏蔽标记为 1,
- 屏蔽标记为 0。
- decoder_input_ids (
jnp.ndarray
,形状为(batch_size, target_sequence_length)
,可选) — 解码器输入序列词语在词汇表中的索引。 可以通过 AutoTokenizer 获取索引。更多详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。对于翻译和摘要训练,应提供
decoder_input_ids
。如果没有提供decoder_input_ids
,模型将按照论文中描述的去噪预训练方法,通过将input_ids
右移来创建此张量。 - decoder_attention_mask (
jnp.ndarray
,形状为(batch_size, target_sequence_length)
,可选) — 默认行为:生成一个张量,忽略decoder_input_ids
中的填充词语。默认情况下也会使用因果掩码。如果要更改填充行为,应根据需要进行修改。有关默认策略的详细信息,请参见 论文 中的图 1。
- position_ids (
numpy.ndarray
,形状为(batch_size, sequence_length)
,可选) — 每个输入序列词语在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - decoder_position_ids (
numpy.ndarray
,形状为(batch_size, sequence_length)
,可选) — 每个解码器输入序列词语在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutput 或 tuple(torch.FloatTensor)
transformers.modeling_flax_outputs.FlaxSeq2SeqLMOutput 或 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
)包含根据配置(BlenderbotSmallConfig)和输入的不同元素。
-
logits (
jnp.ndarray
,形状为(batch_size, sequence_length, config.vocab_size)
) — 语言建模头的预测分数(SoftMax 之前的每个词汇标记的分数)。 -
past_key_values (
tuple(tuple(jnp.ndarray))
, 可选, 当传递use_cache=True
或config.use_cache=True
时返回) — 长度为config.n_layers
的tuple(tuple(jnp.ndarray))
元组,每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
) 的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的附加张量。包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可以使用这些状态(请参阅 ``past_key_values`` 输入)来加速序列解码。
-
decoder_hidden_states (
tuple(jnp.ndarray)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。解码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(jnp.ndarray)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。
-
encoder_last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)
的jnp.ndarray
, 可选) — 模型编码器最后一层输出处的隐藏状态序列。 -
encoder_hidden_states (
tuple(jnp.ndarray)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。编码器在每一层输出处的隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(jnp.ndarray)
, 可选, 当传入output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
的元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。
FlaxBlenderbotSmallPreTrainedModel
forward 方法,覆盖 __call__
特殊方法。
尽管需要在此函数中定义前向传递的方法,但之后应该调用 ``Module`` 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
摘要示例
>>> from transformers import AutoTokenizer, FlaxBlenderbotSmallForConditionalGeneration
>>> model = FlaxBlenderbotSmallForConditionalGeneration.from_pretrained("facebook/blenderbot_small-90M")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> ARTICLE_TO_SUMMARIZE = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=1024, return_tensors="np")
>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"]).sequences
>>> print(tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False))
掩码填充示例
>>> from transformers import AutoTokenizer, FlaxBlenderbotSmallForConditionalGeneration
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> TXT = "My friends are <mask> but they eat too many carbs."
>>> model = FlaxBlenderbotSmallForConditionalGeneration.from_pretrained("facebook/blenderbot_small-90M")
>>> input_ids = tokenizer([TXT], return_tensors="np")["input_ids"]
>>> logits = model(input_ids).logits
>>> masked_index = (input_ids[0] == tokenizer.mask_token_id).nonzero().item()
>>> probs = jax.nn.softmax(logits[0, masked_index], axis=0)
>>> values, predictions = jax.lax.top_k(probs)
>>> tokenizer.decode(predictions).split()
编码
< source >( input_ids: 数组 attention_mask: 可选 = None position_ids: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None train: bool = False params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
jnp.ndarray
,形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。如果提供,默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
jnp.ndarray
,形状为(batch_size, sequence_length)
, 可选) — 掩码以避免对填充标记索引执行注意力。在[0, 1]
中选择的掩码值:- 未屏蔽 标记为 1,
- 屏蔽 标记为 0。
- position_ids (
numpy.ndarray
,形状为(batch_size, sequence_length)
, 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, *可选*) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 `hidden_states`。 - return_dict (
bool
, *可选*) — 是否返回 ModelOutput 而不是普通的元组。
返回值
transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 torch.FloatTensor
的元组(如果传递 return_dict=False
或 config.return_dict=False
),根据配置(<class 'transformers.models.blenderbot_small.configuration_blenderbot_small.BlenderbotSmallConfig'>
)和输入包含各种元素。
-
last_hidden_state (
jnp.ndarray
,形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(jnp.ndarray)
, 可选,当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)
, 可选,当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
的元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, FlaxBlenderbotSmallForConditionalGeneration
>>> model = FlaxBlenderbotSmallForConditionalGeneration.from_pretrained("facebook/blenderbot_small-90M")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="np")
>>> encoder_outputs = model.encode(**inputs)
decode
< source >( decoder_input_ids encoder_outputs encoder_attention_mask: Optional = None decoder_attention_mask: Optional = None decoder_position_ids: Optional = None past_key_values: dict = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None deterministic: bool = True params: dict = None dropout_rng: PRNGKey = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- decoder_input_ids (
jnp.ndarray
形状为(batch_size, target_sequence_length)
) — 词汇表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
对于翻译和摘要训练,应提供 `decoder_input_ids`。如果没有提供 `decoder_input_ids`,模型将按照论文中的去噪预训练方法,通过将 `input_ids` 向右移动来创建此张量。
- **encoder_outputs** (
tuple(tuple(jnp.ndarray))
) — 由以下部分组成的元组:(last_hidden_state
, *可选*:hidden_states
, *可选*:attentions
) 形状为(batch_size, sequence_length, hidden_size)
的last_hidden_state
(*可选*) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - **encoder_attention_mask** (
jnp.ndarray
, 形状为(batch_size, sequence_length)
, *可选*) — 掩码,用于避免对填充标记索引执行注意力机制。掩码值在[0, 1]
中选择:- 1 表示**未被掩码**的标记,
- 0 表示**已被掩码**的标记。
- **decoder_attention_mask** (
jnp.ndarray
, 形状为(batch_size, target_sequence_length)
, *可选*) — 默认行为:生成一个忽略decoder_input_ids
中填充标记的张量。默认情况下也将使用因果掩码。如果要更改填充行为,应根据需要进行修改。有关默认策略的更多信息,请参见 论文 中的图 1。
- **decoder_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.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含根据配置 (<class 'transformers.models.blenderbot_small.configuration_blenderbot_small.BlenderbotSmallConfig'>
) 和输入的不同元素。
-
logits (
jnp.ndarray
,形状为(batch_size, sequence_length, config.vocab_size)
) — 语言建模头的预测分数(SoftMax 之前的每个词汇标记的分数)。 -
hidden_states (
tuple(jnp.ndarray)
, 可选,当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) —jnp.ndarray
的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)
, 可选,当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
的元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray)
, 可选, 当传递output_attentions=True
或config.output_attentions=True
时返回) —jnp.ndarray
元组(每一层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。交叉注意力 softmax 后的交叉注意力权重,用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(jnp.ndarray))
, 可选, 当传递use_cache=True
或config.use_cache=True
时返回) — 长度为config.n_layers
的jnp.ndarray
元组的元组,每个元组包含自注意力和交叉注意层的缓存键、值状态(如果模型在编码器-解码器设置中使用)。仅在config.is_decoder = True
时相关。包含预先计算的隐藏状态(注意力块中的键和值),可以使用这些状态(参见 `past_key_values` 输入)来加速序列解码。
示例
>>> import jax.numpy as jnp
>>> from transformers import AutoTokenizer, FlaxBlenderbotSmallForConditionalGeneration
>>> model = FlaxBlenderbotSmallForConditionalGeneration.from_pretrained("facebook/blenderbot_small-90M")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> text = "My friends are cool but they eat too many carbs."
>>> inputs = tokenizer(text, max_length=1024, return_tensors="np")
>>> encoder_outputs = model.encode(**inputs)
>>> decoder_start_token_id = model.config.decoder_start_token_id
>>> decoder_input_ids = jnp.ones((inputs.input_ids.shape[0], 1), dtype="i4") * decoder_start_token_id
>>> outputs = model.decode(decoder_input_ids, encoder_outputs)
>>> logits = outputs.logits