Transformers 文档
Blenderbot Small
并获得增强的文档体验
开始使用
此模型于 2020 年 4 月 28 日发布，并于 2021 年 1 月 5 日添加到 Hugging Face Transformers。
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 日在 Recipes for building an open-domain chatbot 中提出。
论文摘要如下：
构建开放域聊天机器人是机器学习研究的一个具有挑战性的领域。虽然先前的工作表明，在参数数量和训练数据大小方面扩展神经模型可以获得改进的结果，但我们表明，其他要素对于高性能聊天机器人也很重要。良好的对话需要专家对话者以无缝方式融合的多种技能：提供引人入胜的谈话要点，倾听合作伙伴，适当展示知识、同理心和个性，同时保持一致的人设。我们展示了当给定适当的训练数据和生成策略选择时，大规模模型可以学习这些技能。我们使用 90M、2.7B 和 9.4B 参数模型构建了这些配方的变体，并公开发布了我们的模型和代码。人类评估表明，我们的最佳模型在多轮对话中的参与度和人性化测量方面优于现有方法。然后，我们通过分析模型的失败案例来讨论这项工作的局限性。
此模型由 patrickvonplaten 贡献。作者的代码可在此处找到。
使用技巧
Blenderbot Small 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
资源
BlenderbotSmallConfig
class transformers.BlenderbotSmallConfig
< source >( 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 is_decoder = False tie_word_embeddings = True **kwargs )
参数
- vocab_size (
int, optional, defaults to 50265) — BlenderbotSmall 模型的词汇表大小。定义了调用 BlenderbotSmallModel 时传入的inputs_ids可以表示的不同标记的数量。 - d_model (
int, optional, defaults to 512) — 层和池化层的维度。 - encoder_layers (
int, optional, defaults to 8) — 编码器层数。 - decoder_layers (
int, optional, defaults to 8) — 解码器层数。 - encoder_attention_heads (
int, optional, defaults to 16) — Transformer 编码器中每个注意力层的注意力头数。 - decoder_attention_heads (
int, optional, defaults to 16) — Transformer 解码器中每个注意力层的注意力头数。 - decoder_ffn_dim (
int, optional, defaults to 2048) — 解码器中“中间”（通常称为前馈）层的维度。 - encoder_ffn_dim (
int, optional, defaults to 2048) — 编码器中“中间”（通常称为前馈）层的维度。 - activation_function (
strorfunction, optional, defaults to"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - dropout (
float, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力概率的 dropout 率。 - activation_dropout (
float, optional, defaults to 0.0) — 全连接层内部激活的 dropout 率。 - max_position_embeddings (
int, optional, defaults to 512) — 此模型可能使用的最大序列长度。通常为了以防万一会设置一个较大的值（例如 512 或 1024 或 2048）。 - init_std (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - encoder_layerdrop (
float, optional, defaults to 0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](see https://huggingface.co/papers/1909.11556)。 - decoder_layerdrop (
float, optional, defaults to 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](see https://huggingface.co/papers/1909.11556)。 - scale_embedding (
bool, optional, defaults toFalse) — 通过除以 sqrt(d_model) 来缩放嵌入。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应该返回最后一个 key/value attention（并非所有模型都使用） - forced_eos_token_id (
int, optional, defaults to 2) — 达到max_length时强制作为最后一个生成 token 的 token 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
< 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, optional, defaults to"__start__") — 句子开始 token。 - eos_token (
str, optional, defaults to"__end__") — 句子结束 token。 - unk_token (
str, optional, defaults to"__unk__") — 未知 token。词汇表中没有的 token 无法转换为 ID，将设置为此 token。 - pad_token (
str, optional, defaults to"__null__") — 用于填充的 token，例如在批处理长度不同的序列时。 - kwargs (optional) — 传递给 PreTrainedTokenizer 的其他关键字参数
基于 BPE（字节对编码）构建 Blenderbot-90M 分词器
此分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。有关方法的更多信息，用户应参考父类。
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: list | None = None already_has_special_tokens: bool = False ) → A list of integers in the range [0, 1]
从未添加特殊令牌的令牌列表中检索序列 ID。使用分词器 prepare_for_model 或 encode_plus 方法添加特殊令牌时会调用此方法。
此方法根据分词器的 special_tokens_pattern 动态构建特殊标记掩码
"none": 无特殊标记 (默认，返回所有 0)"cls_sep": [CLS] seq0 [SEP] 或 [CLS] seq0 [SEP] seq1 [SEP]"eos": seq0 [EOS] 或 seq0 [EOS] seq1 [EOS]"bos": [BOS] seq0 或 [BOS] seq0 [BOS] seq1"bos_eos": [BOS] seq0 [EOS] 或 [BOS] seq0 [EOS] seq1 [EOS]"cls_double_sep": [CLS] seq0 [SEP] 或 [CLS] seq0 [SEP][SEP] seq1 [SEP]"prefix_suffix":<prefix_tokens> seq0 [seq1] <suffix_tokens>
BlenderbotSmallTokenizerFast
class 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, optional, defaults to"__start__") — 句子开始 token。 - eos_token (
str, optional, defaults to"__end__") — 句子结束 token。 - unk_token (
str, optional, defaults to"__unk__") — 未知 token。词汇表中没有的 token 无法转换为 ID，将设置为此 token。 - pad_token (
str, optional, defaults to"__null__") — 用于填充的 token，例如在批处理长度不同的序列时。 - kwargs (optional) — 传递给 PreTrainedTokenizer 的其他关键字参数
基于 BPE（字节对编码）构建 Blenderbot-90M 分词器
此分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。有关方法的更多信息，用户应参考父类。
将 token 序列转换为单个字符串。
BlenderbotSmallModel
class transformers.BlenderbotSmallModel
< source >( config: BlenderbotSmallConfig )
参数
- config (BlenderbotSmallConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
Blenderbot Small 模型，输出原始隐藏状态，顶部没有特定头部。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None decoder_input_ids: torch.LongTensor | None = None decoder_attention_mask: torch.LongTensor | None = None encoder_outputs: tuple | transformers.modeling_outputs.BaseModelOutput | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.Tensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None cache_position: torch.Tensor | None = None **kwargs ) → transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值选择在[0, 1]中：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- decoder_input_ids (
torch.LongTensorof shape(batch_size, target_sequence_length), optional) — 解码器输入序列 token 在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
BlenderbotSmall 使用
bos_token_id作为decoder_input_ids生成的起始 token。如果使用past_key_values，可以选择只输入最后一个decoder_input_ids（请参阅past_key_values）。 - decoder_attention_mask (
torch.LongTensorof shape(batch_size, target_sequence_length), optional) — 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。默认情况下也会使用因果掩码。 - encoder_outputs (
Union[tuple, ~modeling_outputs.BaseModelOutput], optional) — 元组包含（last_hidden_state, 可选:hidden_states, 可选:attentions）last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉 attention 中。 - past_key_values (
~cache_utils.Cache, optional) — 预先计算的隐藏状态（self-attention block 和 cross-attention block 中的 key 和 value），可用于加快顺序解码。这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。只允许 Cache 实例作为输入，请参阅我们的 kv cache guide。如果未传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入时相同的 cache 格式。
如果使用
past_key_values，则期望用户只输入未经处理的input_ids（即未将其过去的 key value 状态提供给此模型的那些）形状为(batch_size, unprocessed_length)，而不是所有input_ids形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这很有用。 - decoder_inputs_embeds (
torch.FloatTensorof shape(batch_size, target_sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递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, optional) — 如果设置为True，则返回past_key_valueskey value 状态，可用于加快解码速度（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attention 张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。 - cache_position (
torch.Tensorof shape(sequence_length), optional) — 表示输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新 cache 并推断完整的序列长度。
返回
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, optional, 当传入use_cache=True或当config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。解码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
-
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(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), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
BlenderbotSmallModel forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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
< source >( config: BlenderbotSmallConfig )
参数
- config (BlenderbotSmallConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
带有语言建模头部的 BlenderbotSmall 模型。可用于摘要。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None decoder_input_ids: torch.LongTensor | None = None decoder_attention_mask: torch.LongTensor | None = None encoder_outputs: tuple | transformers.modeling_outputs.BaseModelOutput | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.Tensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None cache_position: torch.Tensor | None = None **kwargs ) → transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列 token 在词汇表中的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行 attention 的掩码。掩码值选择在[0, 1]中：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- decoder_input_ids (
torch.LongTensorof shape(batch_size, target_sequence_length), optional) — 解码器输入序列 token 在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
BlenderbotSmall 使用
bos_token_id作为decoder_input_ids生成的起始 token。如果使用past_key_values，可以选择只输入最后一个decoder_input_ids（请参阅past_key_values）。 - decoder_attention_mask (
torch.LongTensorof shape(batch_size, target_sequence_length), optional) — 默认行为：生成一个忽略decoder_input_ids中填充 token 的张量。默认情况下也会使用因果掩码。 - encoder_outputs (
Union[tuple, ~modeling_outputs.BaseModelOutput], optional) — 元组包含（last_hidden_state, 可选:hidden_states, 可选:attentions）last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉 attention 中。 - past_key_values (
~cache_utils.Cache, optional) — 预先计算的隐藏状态（self-attention block 和 cross-attention block 中的 key 和 value），可用于加快顺序解码。这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。只允许 Cache 实例作为输入，请参阅我们的 kv cache guide。如果未传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入时相同的 cache 格式。
如果使用
past_key_values，则期望用户只输入未经处理的input_ids（即未将其过去的 key value 状态提供给此模型的那些）形状为(batch_size, unprocessed_length)，而不是所有input_ids形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这很有用。 - decoder_inputs_embeds (
torch.FloatTensorof shape(batch_size, target_sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递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.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算 masked language modeling loss 的标签。索引应在[0, ..., config.vocab_size]或 -100 之间（请参阅input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），loss 仅针对标签在[0, ..., config.vocab_size]中的 token 计算。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_valueskey value 状态，可用于加快解码速度（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attention 张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 对象，而不是普通的元组。 - cache_position (
torch.Tensorof shape(sequence_length), optional) — 表示输入序列标记在序列中位置的索引。与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, optional, 当传入use_cache=True或当config.use_cache=True时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出时的隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
-
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(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), optional, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型有嵌入层，+ 一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出时的隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor), optional, 当传入output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。
BlenderbotSmallForConditionalGeneration 的 forward 方法，它重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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
< source >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None encoder_hidden_states: torch.FloatTensor | None = None encoder_attention_mask: torch.FloatTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 输入序列标记在词汇表中的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- encoder_hidden_states (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 用于避免对编码器输入中的填充标记索引执行注意力的掩码。如果模型被配置为解码器，则此掩码用于交叉注意力。掩码值选择在[0, 1]之间：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- past_key_values (
~cache_utils.Cache, optional) — 预先计算的隐藏状态（自注意块和交叉注意块中的键和值），可用于加快顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时使用。只允许输入 Cache 实例，请参阅我们的 kv cache 指南。如果没有传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用
past_key_values，则用户应只输入未处理的input_ids（即没有向模型提供其过去键值状态的标记）的形状(batch_size, unprocessed_length)，而不是所有input_ids的形状(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为相关向量有比模型内部嵌入查找矩阵更多的控制，这将非常有用。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 之间（请参阅input_idsdocstring）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的标记计算。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加快解码速度（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 对象，而不是普通的元组。 - cache_position (
torch.LongTensorof shape(sequence_length), optional) — 表示输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], optional, defaults to0) — 如果是int，则计算最后logits_to_keep个标记的 logits。如果是0，则计算所有input_ids的 logits（特殊情况）。生成时只需要最后一个标记的 logits，并且只计算该标记的 logits 可以节省内存，这对于长序列或大词汇表大小来说非常重要。如果是torch.Tensor，则必须是 1D 张量，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度为单维度）时非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or 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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
BlenderbotSmallForCausalLM 的 forward 方法，它重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, BlenderbotSmallForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot_small-90M")
>>> model = BlenderbotSmallForCausalLM.from_pretrained("facebook/blenderbot_small-90M")
>>> 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