Transformers 文档
Blenderbot Small
并获得增强的文档体验
开始使用
Blenderbot Small
请注意，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 日在论文 《构建开放域聊天机器人的秘诀》 中提出。
论文摘要如下：
构建开放域聊天机器人是机器学习研究领域中一个具有挑战性的方向。虽然先前的工作表明，扩大神经网络模型的参数数量和训练数据规模可以改善结果，但我们发现其他因素对于高性能聊天机器人同样重要。良好的对话需要专家级对话者无缝融合多项技能：提供引人入胜的谈话要点并倾听伙伴的意见，适当地展示知识、同理心和个性，同时保持一致的形象。我们证明，当给予适当的训练数据和选择合适的生成策略时，大规模模型可以学习这些技能。我们基于这些秘诀构建了参数量分别为 90M、2.7B 和 9.4B 的模型变体，并公开了我们的模型和代码。人类评估表明，在多轮对话中，我们的最佳模型在吸引力和人性化方面优于现有方法。然后，我们通过分析模型的失败案例来讨论这项工作的局限性。
该模型由 patrickvonplaten 贡献。作者的代码可以在 这里 找到。
使用技巧
Blenderbot Small 是一个使用绝对位置嵌入的模型，因此通常建议在输入的右侧而不是左侧进行填充。
资源
BlenderbotSmallConfig
class 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) — 嵌入、编码器和池化器中所有全连接层的丢弃概率。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的丢弃率。 - activation_dropout (
float, 可选, 默认为 0.0) — 全连接层内部激活函数的丢弃率。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以备不时之需（例如，512、1024 或 2048）。 - init_std (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - encoder_layerdrop (
float, 可选, 默认为 0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。 - decoder_layerdrop (
float, 可选, 默认为 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/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.configBlenderbotSmallTokenizer
class transformers.BlenderbotSmallTokenizer
< 源 >( 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__") — 未知词元（token）。词汇表中不存在的词元无法转换为 ID，将被设置为此词元。 - pad_token (
str, 可选, 默认为"__null__") — 用于填充的词元，例如在批处理不同长度的序列时使用。 - kwargs (可选) — 传递给 PreTrainedTokenizer 的其他关键字参数。
构建一个基于 BPE (Byte-Pair-Encoding) 的 Blenderbot-90M 分词器。
该分词器继承自 PreTrainedTokenizer，其中包含了大部分主要方法。用户应参考父类以获取有关方法的更多信息。
build_inputs_with_special_tokens
< 源码 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
通过拼接和添加特殊词元，从一个序列或一对序列为序列分类任务构建模型输入。
此实现不添加特殊词元，该方法应在子类中被重写。
get_special_tokens_mask
< 源码 >( token_ids_0: list token_ids_1: typing.Optional[list] = None already_has_special_tokens: bool = False ) → 一个范围在 [0, 1] 之间的整数列表
从未添加特殊令牌的令牌列表中检索序列 ID。使用分词器 prepare_for_model 或 encode_plus 方法添加特殊令牌时会调用此方法。
create_token_type_ids_from_sequences
< 源码 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
创建与传入序列对应的标记类型 ID。什么是标记类型 ID？
如果模型有特殊的构建方式，应在子类中重写此方法。
BlenderbotSmallTokenizerFast
class 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: typing.Optional[list[int]] = None ) → list[int]
根据传入的两个序列创建一个掩码，用于序列对分类任务。BlenderbotSmall 不使用词元类型 ID，因此返回一个全零列表。
BlenderbotSmallModel
class transformers.BlenderbotSmallModel
< 源码 >( config: BlenderbotSmallConfig )
参数
- config (BlenderbotSmallConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
裸的 Blenderbot Small 模型，输出原始的隐藏状态，没有任何特定的头部。
该模型继承自 PreTrainedModel。请查看父类的文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Union[tuple, transformers.modeling_outputs.BaseModelOutput, NoneType] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.Tensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.Tensor] = 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，形状为(num_heads,)或(num_layers, num_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 (
Union[tuple, ~modeling_outputs.BaseModelOutput, NoneType]) — 元组，包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
list[torch.FloatTensor], 可选) — 预先计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 一个长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传递
past_key_values，将返回传统缓存格式。如果使用
past_key_values，用户可以选择只输入最后的input_ids（那些没有提供其过去键值状态给此模型的词元），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.Tensor，形状为(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 而不是一个普通的元组。 - cache_position (
torch.Tensor，形状为(sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False），根据配置 (BlenderbotSmallConfig) 和输入包含各种元素。
-
last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
EncoderDecoderCache, 可选, 当传递use_cache=True或config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
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 (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。 -
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
class transformers.BlenderbotSmallForConditionalGeneration
< 源码 >( config: BlenderbotSmallConfig )
参数
- config (BlenderbotSmallConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有语言建模头的 BlenderbotSmall 模型。可用于摘要生成。
该模型继承自 PreTrainedModel。请查看父类的文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Union[tuple, transformers.modeling_outputs.BaseModelOutput, NoneType] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.Tensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.Tensor] = 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，形状为(num_heads,)或(num_layers, num_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 (
Union[tuple, ~modeling_outputs.BaseModelOutput, NoneType]) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
list[torch.FloatTensor]，可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的前一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 一个长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其过去键值状态提供给此模型的 ID），而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.Tensor，形状为(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。 - 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）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - cache_position (
torch.Tensor，形状为(sequence_length)，可选) — 描述输入序列标记在序列中位置的索引。与position_ids相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
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 (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
EncoderDecoderCache, 可选, 当传递use_cache=True或config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
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 (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。 -
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: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = 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]：- 1 表示标记未被屏蔽，
- 0 表示标记已被屏蔽。
- head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于置零交叉注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- past_key_values (
list[torch.FloatTensor]，可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的前一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 一个长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入形状为(batch_size, 1)的最后一个input_ids（那些没有将其过去键值状态提供给此模型的 ID），而不是形状为(batch_size, sequence_length)的所有input_ids。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将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）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 描述输入序列标记在序列中位置的索引。与position_ids相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置 (BlenderbotSmallConfig) 和输入包含不同的元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（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 (
Cache，可选，在传递use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
BlenderbotSmallForCausalLM 的 forward 方法会覆盖 __call__ 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应该调用 Module 实例而不是这个函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> 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
TrueTFBlenderbotSmallModel
class transformers.TFBlenderbotSmallModel
< 源码 >( 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)，可选) — 默认情况下会创建并忽略填充标记（pad token）。对于大多数用例，不建议设置此项。 - 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。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - 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 (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor) — 模型解码器最后一层输出的隐藏状态序列。如果使用了
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 (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — 模型编码器最后一层输出的隐藏状态序列。 -
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 的前向方法，重写了 __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_stateTFBlenderbotSmallForConditionalGeneration
class 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 函数一样传递输入！
调用
< source >( 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 or 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)，可选) — 默认情况下会创建并忽略填充标记（pad token）。对于大多数用例，不建议设置此项。 - 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。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 Eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 在训练和评估之间有不同的行为）。 - labels (
tf.tensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[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 (
tf.Tensorof shape(batch_size, sequence_length, config.vocab_size)) — 语言模型头部的预测分数（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 (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — 模型编码器最后一层输出的隐藏状态序列。 -
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 的前向方法，重写了 __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 Transformer 模型，输出原始的隐藏状态，顶部没有任何特定的头。该模型继承自 FlaxPreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 Flax Linen flax.nn.Module 的子类。可以像常规 Flax 模块一样使用它，并参考 Flax 文档了解所有与通用用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids: Array attention_mask: typing.Optional[jax.Array] = None decoder_input_ids: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None ) → transformers.modeling_flax_outputs.FlaxSeq2SeqModelOutput or 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))`，每个元组包含两个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量，以及两个额外的形状为 `(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编码
< source >( input_ids: Array attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput or 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 (形状为
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最后一层输出的隐藏状态序列。 -
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: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None past_key_values: typing.Optional[dict] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = 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 (
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.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 (形状为
(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(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` 时返回) — `jnp.ndarray` 元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。解码器交叉注意力层的注意力权重，在注意力 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_stateFlaxBlenderbotForConditionalGeneration
class 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: typing.Optional[jax.Array] = None decoder_input_ids: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = 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 (形状为
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
past_key_values (
tuple(tuple(jnp.ndarray))，可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的 `tuple(tuple(jnp.ndarray))`，每个元组包含两个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量，以及两个额外的形状为 `(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` 的前向方法，重写了 `__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()编码
< 源码 >( input_ids: Array attention_mask: typing.Optional[jax.Array] = None position_ids: typing.Optional[jax.Array] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None train: bool = False params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput or 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 (形状为
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最后一层输出的隐藏状态序列。 -
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
< 源码 >( decoder_input_ids encoder_outputs encoder_attention_mask: typing.Optional[jax.Array] = None decoder_attention_mask: typing.Optional[jax.Array] = None decoder_position_ids: typing.Optional[jax.Array] = None past_key_values: typing.Optional[dict] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None deterministic: bool = True params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = 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 (形状为
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
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