Transformers 文档
Blenderbot
并获得增强的文档体验
开始使用
该模型于 2020-04-28 发布在 HF 论文中，并于 2020-11-16 贡献给 Hugging Face Transformers。
Blenderbot
概述
Blender 聊天机器人模型是在 构建开放域聊天机器人的配方 (Recipes for building an open-domain chatbot) 一文中提出的，由 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 的变体，并公开了我们的模型和代码。人工评估显示，我们的最佳模型在多轮对话的参与度和人性化指标方面优于现有方法。最后，我们通过分析模型的失败案例，讨论了这项工作的局限性。
该模型由 sshleifer 贡献。作者的代码可以在 这里 找到。
使用提示和示例
Blenderbot 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
一个示例
from transformers import BlenderbotForConditionalGeneration, BlenderbotTokenizer
mname = "facebook/blenderbot-400M-distill"
model = BlenderbotForConditionalGeneration.from_pretrained(mname, device_map="auto")
tokenizer = BlenderbotTokenizer.from_pretrained(mname)
UTTERANCE = "My friends are cool but they eat too many carbs."
inputs = tokenizer([UTTERANCE], return_tensors="pt").to(model.device)
reply_ids = model.generate(**inputs)
print(tokenizer.batch_decode(reply_ids))
["<s> That's unfortunate. Are they trying to lose weight or are they just trying to be healthier?</s>"]实现说明
- Blenderbot 使用了标准的 seq2seq 模型 transformer 架构。
- 可用的检查点可以在 模型中心 (model hub) 中找到。
- 这是默认的 Blenderbot 模型类。然而，一些较小的检查点，例如
facebook/blenderbot_small_90M，具有不同的架构，因此应配合 BlenderbotSmall 使用。
资源
BlenderbotConfig
class transformers.BlenderbotConfig
< 源代码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None is_encoder_decoder: bool = True vocab_size: int = 8008 max_position_embeddings: int = 128 encoder_layers: int = 2 encoder_ffn_dim: int = 10240 encoder_attention_heads: int = 32 decoder_layers: int = 24 decoder_ffn_dim: int = 10240 decoder_attention_heads: int = 32 encoder_layerdrop: float | int = 0.0 decoder_layerdrop: float | int = 0.0 use_cache: bool = True activation_function: str = 'gelu' d_model: int = 2560 dropout: float | int = 0.1 attention_dropout: float | int = 0.0 activation_dropout: float | int = 0.0 init_std: float = 0.02 decoder_start_token_id: int = 1 scale_embedding: bool = False pad_token_id: int | None = 0 bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 encoder_no_repeat_ngram_size: int = 3 forced_eos_token_id: int | list[int] | None = 2 is_decoder: bool = False tie_word_embeddings: bool = True )
参数
- is_encoder_decoder (
bool, 可选, 默认为True) — 模型是否用作编码器/解码器。 - vocab_size (
int, 可选, 默认为8008) — 模型的词汇表大小。定义了input_ids可以表示的不同标记的数量。 - max_position_embeddings (
int, 可选, 默认为128) — 该模型可能使用的最大序列长度。 - encoder_layers (
int, 可选, 默认为2) — Transformer 编码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - encoder_ffn_dim (
int, 可选, 默认为10240) — 编码器中“中间”（通常称为前馈）层的维度。 - encoder_attention_heads (
int, 可选, 默认为32) — Transformer 编码器中每个注意力层的注意力头数量。 - decoder_layers (
int, 可选, 默认为24) — Transformer 解码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - decoder_ffn_dim (
int, 可选, 默认为10240) — 解码器中“中间”（通常称为前馈）层的维度。 - decoder_attention_heads (
int, 可选, 默认为32) — Transformer 解码器中每个注意力层的注意力头数量。 - encoder_layerdrop (
Union[float, int], 可选, 默认为0.0) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](https://huggingface.co/papers/1909.11556)。 - decoder_layerdrop (
Union[float, int], 可选, 默认为0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](https://huggingface.co/papers/1909.11556)。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True或模型是仅解码器的生成模型时才相关。 - activation_function (
str, 可选, 默认为gelu) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu"等。 - d_model (
int, 可选, 默认为2560) — 编码器层和池化层的尺寸。 - dropout (
Union[float, int], 可选, 默认为0.1) — 所有 dropout 层的比率。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力概率的丢弃比率。 - activation_dropout (
Union[float, int], 可选, 默认为0.0) — 全连接层内部激活值的丢弃比率。 - init_std (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - decoder_start_token_id (
int, 可选, 默认为1) — 如果编码器-解码器模型开始解码时使用的 token 与bos不同，则为该 token 的 ID。 - scale_embedding (
bool, 可选, 默认为False) — 是否通过除以 sqrt(d_model) 来缩放嵌入层。 - pad_token_id (
int, 可选, 默认为0) — 词表中用于填充的 token ID。 - bos_token_id (
int, 可选, 默认为1) — 词表中用于序列开头的 token ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词表中用于序列结束的 token ID。 - encoder_no_repeat_ngram_size (
int, 可选, 默认为 3) — 在编码器中不应重复的 n-gram 的数量。 - forced_eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 当达到max_length时，强制作为最后一个生成的 token 的 ID。通常设置为eos_token_id。 - is_decoder (
bool, 可选, 默认为False) — 模型是否用作解码器。如果为False，则模型用作编码器。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。
这是用于存储 BlenderbotModel 配置的配置类。它用于根据指定的参数实例化 Blenderbot 模型，从而定义模型架构。使用默认值实例化配置将产生与 facebook/blenderbot-3B 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import BlenderbotConfig, BlenderbotModel
>>> # Initializing a Blenderbot facebook/blenderbot-3B style configuration
>>> configuration = BlenderbotConfig()
>>> # Initializing a model (with random weights) from the facebook/blenderbot-3B style configuration
>>> model = BlenderbotModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configBlenderbotTokenizer
class transformers.BlenderbotTokenizer
< 源文件 >( bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = True vocab = None merges = None **kwargs )
参数
- bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列开始 token。可以用作序列分类 token。当使用特殊 token 构建序列时，这不是用于序列开始的 token。所使用的 token 是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束 token。当使用特殊 token 构建序列时，这不是用于序列结束的 token。所使用的 token 是
sep_token。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。 - cls_token (
str, 可选, 默认为"<s>") — 分类 token，用于执行序列分类时（对整个序列进行分类，而不是对每个 token 进行分类）。它是使用特殊 token 构建序列时的第一个 token。 - unk_token (
str, 可选, 默认为"<unk>") — 未知 token。不在词表中的 token 无法转换为 ID，将被设置为此 token。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的 token，例如在批处理不同长度的序列时。 - mask_token (
str, 可选, 默认为"<mask>") — 用于遮蔽值的 token。这是使用掩码语言建模训练此模型时使用的 token。这是模型将尝试预测的 token。 - add_prefix_space (
bool, 可选, 默认为True) — 是否在输入前添加初始空格。这允许将首个词与其他词一样对待。（Blenderbot 分词器通过前面的空格检测词的开头）。 - vocab (
str或dict[str, int], 可选) — 自定义词表字典。如果未提供，则从vocab_file加载词表。 - merges (
str或list[str], 可选) — 自定义合并列表。如果未提供，则从merges_file加载合并信息。
构建一个“快速”Blenderbot 分词器（由 HuggingFace 的 tokenizers 库支持），派生自 GPT-2 分词器，使用字节级字节对编码（Byte-Pair-Encoding）。
这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会
无论是否在句子开头（无空格），编码方式都会不同
>>> from transformers import BlenderbotTokenizerFast
>>> tokenizer = BlenderbotTokenizerFast.from_pretrained("facebook/blenderbot-3B")
>>> tokenizer("Hello world")["input_ids"]
[6950, 1085, 2]
>>> tokenizer(" Hello world")["input_ids"]
[6950, 1085, 2]您可以通过在实例化此分词器时或在对某些文本调用它时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以这种方式进行预训练，这可能会导致性能下降。
当与
is_split_into_words=True一起使用时，此分词器需要以add_prefix_space=True进行实例化。
此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此基类以获取有关这些方法的更多信息。
BlenderbotTokenizerFast
class transformers.BlenderbotTokenizer
< 源文件 >( bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = True vocab = None merges = None **kwargs )
参数
- bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列开始 token。可以用作序列分类 token。当使用特殊 token 构建序列时，这不是用于序列开始的 token。所使用的 token 是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束 token。当使用特殊 token 构建序列时，这不是用于序列结束的 token。所使用的 token 是
sep_token。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。 - cls_token (
str, 可选, 默认为"<s>") — 分类 token，用于执行序列分类时（对整个序列进行分类，而不是对每个 token 进行分类）。它是使用特殊 token 构建序列时的第一个 token。 - unk_token (
str, 可选, 默认为"<unk>") — 未知 token。不在词表中的 token 无法转换为 ID，将被设置为此 token。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的 token，例如在批处理不同长度的序列时。 - mask_token (
str, 可选, 默认为"<mask>") — 用于遮蔽值的 token。这是使用掩码语言建模训练此模型时使用的 token。这是模型将尝试预测的 token。 - add_prefix_space (
bool, 可选, 默认为True) — 是否在输入前添加初始空格。这允许将首个词与其他词一样对待。（Blenderbot 分词器通过前面的空格检测词的开头）。 - vocab (
str或dict[str, int], 可选) — 自定义词表字典。如果未提供，则从vocab_file加载词表。 - merges (
str或list[str], 可选) — 自定义合并列表。如果未提供，则从merges_file加载合并信息。
构建一个“快速”Blenderbot 分词器（由 HuggingFace 的 tokenizers 库支持），派生自 GPT-2 分词器，使用字节级字节对编码（Byte-Pair-Encoding）。
这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会
无论是否在句子开头（无空格），编码方式都会不同
>>> from transformers import BlenderbotTokenizerFast
>>> tokenizer = BlenderbotTokenizerFast.from_pretrained("facebook/blenderbot-3B")
>>> tokenizer("Hello world")["input_ids"]
[6950, 1085, 2]
>>> tokenizer(" Hello world")["input_ids"]
[6950, 1085, 2]您可以通过在实例化此分词器时或在对某些文本调用它时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以这种方式进行预训练，这可能会导致性能下降。
当与
is_split_into_words=True一起使用时，此分词器需要以add_prefix_space=True进行实例化。
此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此基类以获取有关这些方法的更多信息。
BlenderbotModel
请参阅 BartModel 以了解 forward 和 generate 的参数。
class transformers.BlenderbotModel
< 源码 >( config: BlenderbotConfig )
参数
- config (BlenderbotConfig) — 模型配置类，包含模型的所有参数。使用配置对象初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
原始的 Blenderbot 模型，输出原始隐藏状态，顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( 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: transformers.modeling_outputs.BaseModelOutput | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词表中输入序列标记的索引。默认情况下，填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选) — 词表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Blenderbot 使用
bos_token_id作为decoder_input_ids生成的起始标记。如果使用了past_key_values，则可以选择仅输入最后的decoder_input_ids（参阅past_key_values）。 - decoder_attention_mask (形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选) — 默认行为：生成一个忽略decoder_input_ids中填充标记的张量。默认情况下还将使用因果掩码（causal mask）。 - encoder_outputs (
~modeling_outputs.BaseModelOutput，可选) — 元组包含 (last_hidden_state，可选：hidden_states，可选：attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state（可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。仅允许输入 Cache 实例，参阅我们的 kv 缓存指南。如果不传递
past_key_values，则默认会初始化 DynamicCache。模型将输出与作为输入馈送的格式相同的缓存格式。
如果使用了
past_key_values，用户预期仅输入形状为(batch_size, unprocessed_length)的未处理input_ids（那些其过去键值状态未提供给此模型的输入），而不是所有形状为(batch_size, sequence_length)的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）。
返回
Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqModelOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置（BlenderbotConfig）和输入，包含各种元素。
BlenderbotModel 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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), 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 之后，用于计算自注意力头中的加权平均。
示例
>>> from transformers import AutoTokenizer, BlenderbotModel
>>> model = BlenderbotModel.from_pretrained("facebook/blenderbot-400M-distill")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot-400M-distill")
>>> inputs = tokenizer("Studies have been shown that owning a dog is good for you", return_tensors="pt")
>>> decoder_input_ids = tokenizer("Studies show that", return_tensors="pt").input_ids # Batch size 1
>>> outputs = model(input_ids=inputs.input_ids, decoder_input_ids=decoder_input_ids)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 6, 1280]BlenderbotForConditionalGeneration
参阅 BartForConditionalGeneration 获取 forward 和 generate 的参数。
class transformers.BlenderbotForConditionalGeneration
< 源码 >( config: BlenderbotConfig )
参数
- config (BlenderbotConfig) — 模型配置类，包含模型的所有参数。使用配置对象初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模头的 Blenderbot 模型。可用于摘要生成。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( 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: transformers.modeling_outputs.BaseModelOutput | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None decoder_inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词表中输入序列标记的索引。默认情况下，填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选) — 词表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Blenderbot 使用
bos_token_id作为decoder_input_ids生成的起始标记。如果使用了past_key_values，则可以选择仅输入最后的decoder_input_ids（参阅past_key_values）。 - decoder_attention_mask (形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选) — 默认行为：生成一个忽略decoder_input_ids中填充标记的张量。默认情况下还将使用因果掩码（causal mask）。 - encoder_outputs (
~modeling_outputs.BaseModelOutput，可选) — 元组包含 (last_hidden_state，可选：hidden_states，可选：attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state（可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包含模型在解码前一阶段返回的past_key_values（当use_cache=True或config.use_cache=True时）。仅允许输入 Cache 实例，详见我们的 kv 缓存指南。如果不传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即那些过去键值状态未提供给此模型的输入），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部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的值。 - 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）。
返回
Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置（BlenderbotConfig）和输入，包含各种元素。
BlenderbotForConditionalGeneration 的前向（forward）传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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), 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 之后，用于计算自注意力头中的加权平均。
对话示例
>>> from transformers import AutoTokenizer, BlenderbotForConditionalGeneration
>>> mname = "facebook/blenderbot-400M-distill"
>>> model = BlenderbotForConditionalGeneration.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: That's unfortunate. Are they trying to lose weight or are they just trying to be healthier?
>>> 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.</s> <s>That's unfortunate. "
... "Are they trying to lose weight or are they just trying to be healthier?</s> "
... "<s> 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: I see. Well, it's good that they're trying to change their eating habits.BlenderbotForCausalLM
forward
< 源代码 >( 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 logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词表中输入序列标记的索引。默认情况下填充（padding）将被忽略。索引可以使用 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 表示被掩码的标记。
- past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包含模型在解码前一阶段返回的past_key_values（当use_cache=True或config.use_cache=True时）。仅允许输入 Cache 实例，详见我们的 kv 缓存指南。如果不传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即那些过去键值状态未提供给此模型的输入），其形状为(batch_size, unprocessed_length)，而不是形状为(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）。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果是int，则计算最后logits_to_keep个标记的对数几率（logits）。如果为0，则计算所有input_ids的对数几率（特殊情况）。生成时仅需要最后一个标记的对数几率，仅为该标记进行计算可以节省内存，这对于长序列或大词表大小来说非常显著。如果是torch.Tensor，必须是对应于在序列长度维度上要保留的索引的一维张量。在使用打包张量格式（批量和序列长度的单维度）时非常有用。
返回
CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
一个 CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置（BlenderbotConfig）和输入，包含各种元素。
BlenderbotForCausalLM 的前向（forward）传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
示例
>>> from transformers import AutoTokenizer, BlenderbotForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/blenderbot-400M-distill")
>>> model = BlenderbotForCausalLM.from_pretrained("facebook/blenderbot-400M-distill")
>>> 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