MVP
概述
MVP模型由Tianyi Tang、Junyi Li、Wayne Xin Zhao和Ji-Rong Wen在《MVP: Multi-task Supervised Pre-training for Natural Language Generation》中提出。
根据摘要，
- MVP遵循标准的Transformer编码器-解码器架构。
- MVP使用带标签的数据集进行监督预训练。
- MVP还具有特定于任务的软提示以激发模型在执行特定任务的能力。
- 多用途生成模型（MVP）专门设计用于自然语言生成，并且能够适应广泛的生成任务，包括但不限于摘要、数据到文本生成、开放式对话系统、故事生成、问答、问题生成、任务对话系统、常识生成、释义生成、文本风格转换和文本简化。我们的模型也可以适应自然语言理解任务，例如序列分类和（基于抽取的）问答。
本模型由 Tianyi Tang 贡献。详细信息和使用说明请参阅 此处。
使用技巧
- 我们在此发布了包括 MVP、带有任务特定提示的 MVP 和多任务预训练变体等一系列模型 此处。
- 如果您想使用不带提示的模型（标准 Transformer），您可以通过
MvpForConditionalGeneration.from_pretrained('RUCAIBox/mvp')载入。 - 如果您想使用具有特定任务提示的模型，例如摘要，您可以通过
MvpForConditionalGeneration.from_pretrained('RUCAIBox/mvp-summarization')载入。 - 我们的模型支持轻量级提示调整，并遵循 Prefix-tuning 方法，并通过
set_lightweight_tuning()进行调整。
使用示例
对于摘要，使用 MVP 和具有摘要特定提示的 MVP 的示例。
>>> from transformers import MvpTokenizer, MvpForConditionalGeneration
>>> tokenizer = MvpTokenizer.from_pretrained("RUCAIBox/mvp")
>>> model = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mvp")
>>> model_with_prompt = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mvp-summarization")
>>> inputs = tokenizer(
... "Summarize: You may want to stick it to your boss and leave your job, but don't do it if these are your reasons.",
... return_tensors="pt",
... )
>>> generated_ids = model.generate(**inputs)
>>> tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
["Why You Shouldn't Quit Your Job"]
>>> generated_ids = model_with_prompt.generate(**inputs)
>>> tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
["Don't do it if these are your reasons"]对于数据到文本生成，使用 MVP 和多任务预训练变体的示例。
>>> from transformers import MvpTokenizerFast, MvpForConditionalGeneration
>>> tokenizer = MvpTokenizerFast.from_pretrained("RUCAIBox/mvp")
>>> model = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mvp")
>>> model_with_mtl = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mtl-data-to-text")
>>> inputs = tokenizer(
... "Describe the following data: Iron Man | instance of | Superhero [SEP] Stan Lee | creator | Iron Man",
... return_tensors="pt",
... )
>>> generated_ids = model.generate(**inputs)
>>> tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
['Stan Lee created the character of Iron Man, a fictional superhero appearing in American comic']
>>> generated_ids = model_with_mtl.generate(**inputs)
>>> tokenizer.batch_decode(generated_ids, skip_special_tokens=True)
['Iron Man is a fictional superhero appearing in American comic books published by Marvel Comics.']对于轻量级调整，即固定模型只调整提示，您可以加载带有随机初始化提示或带有特定任务提示的 MVP。我们的代码还支持按照 原始论文 的方法进行 Prefix-tuning 的 BART。
>>> from transformers import MvpForConditionalGeneration
>>> model = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mvp", use_prompt=True)
>>> # the number of trainable parameters (full tuning)
>>> sum(p.numel() for p in model.parameters() if p.requires_grad)
468116832
>>> # lightweight tuning with randomly initialized prompts
>>> model.set_lightweight_tuning()
>>> # the number of trainable parameters (lightweight tuning)
>>> sum(p.numel() for p in model.parameters() if p.requires_grad)
61823328
>>> # lightweight tuning with task-specific prompts
>>> model = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mtl-data-to-text")
>>> model.set_lightweight_tuning()
>>> # original lightweight Prefix-tuning
>>> model = MvpForConditionalGeneration.from_pretrained("facebook/bart-large", use_prompt=True)
>>> model.set_lightweight_tuning()资源
MvpConfig
类 transformers.MvpConfig
< source >( vocab_size = 50267 max_position_embeddings = 1024 encoder_layers = 12 encoder_ffn_dim = 4096 encoder_attention_heads = 16 decoder_layers = 12 decoder_ffn_dim = 4096 decoder_attention_heads = 16 encoder_layerdrop = 0.0 decoder_layerdrop = 0.0 activation_function = 'gelu' d_model = 1024 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 classifier_dropout = 0.0 scale_embedding = False use_cache = True pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 is_encoder_decoder = True decoder_start_token_id = 2 forced_eos_token_id = 2 use_prompt = False prompt_length = 100 prompt_mid_dim = 800 **kwargs )
参数
- vocab_size (
int, 可选，默认为 50267) — MVP 模型的词汇表大小。定义了在调用 MvpModel 时通过inputs_ids传递的不同标记的数量。 - d_model (
int, 可选, 默认为 1024) — 层数和池化层的维度。 - encoder_layers (
int, 可选, 默认为 12) — 编码器层数。 - decoder_layers (
int, 可选, 默认为 12) — 解码器层数。 - encoder_attention_heads (
int, 可选, 默认为 16) — Transformer编码器中每个注意力层中的注意力头数。 - decoder_attention_heads (
int, 可选，默认为 16) — Transformer 解码器中每个注意力层的注意力头数量。 - decoder_ffn_dim (
int, 可选，默认为 4096) — 解码器中“中间”层（通常称为前馈层）的维度。 - encoder_ffn_dim (
int, 可选，默认为 4096) — 编码器中“中间”层（通常称为前馈层）的维度。 - activation_function (
str或function，可选，默认为"gelu") — 编码器和池器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"silu"和"gelu_new"。 - dropout （
float，可选，默认为0.1）— 适用于嵌入层、编码器层和池化层中所有全连接层的dropout概率。 - attention_dropout （
float，可选，默认为0.0）— 注意力概率的dropout比率。 - activation_dropout （
float，可选，默认为0.0）— 适用于全连接层内部的激活的dropout比率。 - classifier_dropout （
float，可选，默认为0.0）— 对于分类器的dropout比率。 - max_position_embeddings (
int, 可选，默认为 1024) — 该模型可能使用的最大序列长度。通常设置得大一些以防万一（例如，512、1024 或 2048）。 - init_std (
float, 可选，默认为 0.02) — 所有权重矩阵初始化时 truncated_normal_initializer 的标准差。 - encoder_layerdrop (
float, 可选，默认为 0.0) — 编码器的 LayerDrop 概率。详见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - decoder_layerdrop (
float, 可选，默认为 0.0) — 解码器的 LayerDrop 概率。详见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - scale_embedding (
bool, 可选，默认为False) — 通过除以 sqrt(d_model) 来缩放嵌入的大小。 - use_cache (
bool, 可选，默认为True) — 模型是否应该返回最后一次键/值注意力（不由所有模型使用）。 - forced_eos_token_id (
int, 可选，默认为 2) — 当max_length达到时，强制作为最后一个生成的令牌的令牌 id。通常设置为eos_token_id。 - use_prompt (
bool, 可选，默认为False) — 是否使用提示文本。 - prompt_length (
int, 可选, 默认为100) — 提示的长度。 - prompt_mid_dim (
int, 可选, 默认为800) — 提示中“中间”层的维度。
这是用于存储MvpModel配置的配置类。它根据指定的参数来实例化一个MVP模型，定义模型架构。使用默认值创建配置将生成类似于RUCAIBox/mvp架构的配置。
配置对象继承自PretrainedConfig，并且可以用来控制模型输出。更多请参阅PretrainedConfig的文档。
示例
>>> from transformers import MvpConfig, MvpModel
>>> # Initializing a MVP RUCAIBox/mvp style configuration
>>> configuration = MvpConfig()
>>> # Initializing a model (with random weights) from the RUCAIBox/mvp style configuration
>>> model = MvpModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMvpTokenizer
类 transformers.MvpTokenizer
< 来源 >( vocab_file merges_file errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False **kwargs )
参数
- vocab_file (
str) — 词汇表文件路径。 - merges_file (
str) — 合并文件的路径。 - errors (
str, 可选, 默认为"replace") — 将字节解码为UTF-8时遵循的模式。有关更多信息，请参阅 bytes.decode。 - bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列开始标记。可以用作序列分类标记。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符标记，当使用多个序列构建序列时使用，例如用于序列分类的两个序列或用于问答的一个文本和一个问题。它也用作使用特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认为"<s>") — 分类器标记，用于序列分类（整个序列的分类而不是按标记分类）。当使用特殊标记构建序列时，它是序列的第一个标记。 - add_prefix_space (
bool, 可选，默认为False) — 是否在输入添加一个空格。这允许将首词视为任何其他词。 (MVP分词器通过前面的空格检测单词的开始)。
使用字节级别的Byte-Pair-Encoding构建与RoBERTa分词器相似的MVP分词器。
该分词器已经训练将空格视为标记的一部分（有点像sentencepiece），所以一个词
在句子开头（没有空格）或不这样做时将会有不同的编码
>>> from transformers import MvpTokenizer
>>> tokenizer = MvpTokenizer.from_pretrained("RUCAIBox/mvp")
>>> tokenizer("Hello world")["input_ids"]
[0, 31414, 232, 2]
>>> tokenizer(" Hello world")["input_ids"]
[0, 20920, 232, 2]您可以通过在实例化此分词器或在某些文本上调用它时传递add_prefix_space=True来解决这个问题，但由于模型没有被以此方式进行预训练，可能会导致性能下降。
当与is_split_into_words=True一起使用时，此分词器将在每个词前添加一个空格（即使是第一个词）。
此分词器继承自PreTrainedTokenizer，其中包含大多数主要方法。用户应参考这个基类以获取更多关于这些方法的信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过拼接和添加特殊标记来构建用于序列分类任务的模型输入，单个MVP序列的格式如下：
- 单序列：
<s> X </s> - 序列对：
<s> A </s></s> B </s>
将一系列标记（字符串）转换成一个单独的字符串。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传入的两个序列创建一个掩码，用于序列对分类任务。MVP 不使用标记类型 ID，因此返回一个零列表。
获取特殊标记掩码。
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
从未添加特殊标记的标记列表中检索序列ID。当使用标记化器的prepare_for_model方法添加特殊标记时，会调用此方法。
MvpTokenizerFast
类 transformers.MvpTokenizerFast
< 源代码 >( vocab_file = None merges_file = None tokenizer_file = None errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False trim_offsets = True **kwargs )
参数
- vocab_file (
str) — 词汇文件路径。 - merges_file (
str) — 合并文件路径。 - errors (
str, 可选, 默认为"replace") — 解码字节到 UTF-8 时遵循的范式。更多信息参见 bytes.decode。 - bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列开始的标记。可以用作序列分类器标记。当使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束的标记。当使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是
sep_token。 - sep_token (
str, 可选，默认为"</s>") — 序列分割符，在从多个序列构建一个序列时使用，例如用于序列分类或用于问答中的一个文本和一个问题。它也用作特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选，默认为"<s>") — 用于序列分类的类标记（对整个序列而不是对每个标记进行分类）。当与特殊标记一起构建序列时，它是序列的第一个标记。 - unk_token (
str, 可选，默认为"<unk>") — 未知标记。不包含在词汇表中的标记无法转换为ID，并设置为这个标记。 -
str, 可选, 默认为") — 用来填充的标记，例如在处理不同长度序列时。" -
str, 可选, 默认为") — 用来遮蔽值的标记。这是用于训练该模型时使用遮蔽语言模型的标记，模型将尝试预测这个标记。" - add_prefix_space (
bool, 可选, 默认为False) — 是否向输入添加一个初始空格。这允许将首词视为其他词。 (MVP分词器通过前导空格检测词的首尾)。 - trim_offsets (
bool, 可选, 默认为True) — 是否在后处理步骤中修剪偏移量以避免包含空格。
构建一个“快速”的MVP分词器（由HuggingFace的tokenizers库支持），基于GPT-2分词器，使用字节级别的字节对编码。
该分词器已经训练将空格视为标记的一部分（有点像sentencepiece），所以一个词
在句子开头（没有空格）或不这样做时将会有不同的编码
>>> from transformers import MvpTokenizerFast
>>> tokenizer = MvpTokenizerFast.from_pretrained("RUCAIBox/mvp")
>>> tokenizer("Hello world")["input_ids"]
[0, 31414, 232, 2]
>>> tokenizer(" Hello world")["input_ids"]
[0, 20920, 232, 2]您可以通过在实例化此分词器或在某些文本上调用它时传递add_prefix_space=True来解决这个问题，但由于模型没有被以此方式进行预训练，可能会导致性能下降。
当与is_split_into_words=True一起使用时，此分词器需要将add_prefix_space=True实例化。
该分词器继承自PreTrainedTokenizerFast，其中包含大部分主要方法。用户应参考这个超类以获取有关这些方法更多的信息。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传入的两个序列创建一个掩码，用于序列对分类任务。MVP 不使用标记类型 ID，因此返回一个零列表。
MvpModel
类 transformers.MvpModel
< 源码 >( config: MvpConfig )
参数
- config (MvpConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看from_pretrained() 方法以加载模型权重。
裸'MvpModel'模型输出原始隐藏状态，不包含顶部任何特定头。该模型继承自PreTrainedModel。有关库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）的文档，请参阅超类文档。
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有内容。
前向
< source >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状(batch_size, sequence_length)) — 在词汇表中的输入序列标记的索引。默认情况下，如果提供填充，则将忽略填充。 - attention_mask (
torch.Tensor形状(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]中选择： - decoder_input_ids （形状为
torch.LongTensor的(batch_size, target_sequence_length)，可选）- 解码器输入序列词元的索引。这些索引可以通过使用 AutoTokenizer 来获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()Mvp 使用
eos_token_id作为decoder_input_ids生成时的起始标记。如果使用past_key_values，则只需输入最后一个decoder_input_ids（见past_key_values）。 对于翻译和摘要训练，应提供decoder_input_ids。如果没有提供decoder_input_ids，模型将按照论文中的去噪预训练方法，通过将input_ids向右移位来创建此张量。 - decoder_attention_mask （形状为
torch.LongTensor的(batch_size, target_sequence_length)，可选）- 默认行为：生成一个张量，忽略decoder_input_ids中的填充标记。默认情况下还会使用因果掩码。如果您想更改填充行为，则应参阅
modeling_mvp._prepare_decoder_attention_mask并根据需要修改。有关默认策略的更多信息，请参阅 论文 中的图1。 - head_mask (
torch.Tensor形状为(encoder_layers, encoder_attention_heads)，可选) — 用于使编码器中注意力模块选择的头无效的掩码。掩码值选择在[0, 1]：- 1 表示头部无掩码，
- 0 表示头部有掩码。
- decoder_head_mask (
torch.Tensor形状为(decoder_layers, decoder_attention_heads)，可选) — 用于使解码器中注意力模块选择的头无效的掩码。掩码值选择在[0, 1]：- 1 表示头部无掩码，
- 0 表示头部有掩码。
- cross_attn_head_mask (
torch.Tensor形状为(decoder_layers, decoder_attention_heads)，可选) — 用于使解码器中交叉注意力模块选择的头无效的掩码。掩码值选择在[0, 1]：- 1 表示头部无掩码，
- 0 表示头部有掩码。
- inputs_embeds (
torch.FloatTensorof 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索引转换为相关向量，这非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values密钥值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情请见返回的张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情请见返回的张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.Seq2SeqModelOutput 或一个由 torch.FloatTensor 组成的元组（如果传递参数 return_dict=False 或当 config.return_dict=False），根据配置（MvpConfig）和输入包含各种元素。
-
last_hidden_state (
torch.FloatTensor的形状为(batch_size, sequence_length, hidden_size)) — 模型解码器最后一层的隐藏状态的序列。如果使用
past_key_values，只有形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态被输出。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的元组，每个元组包含2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及2个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。包含预先计算的隐藏状态（在自注意力块和交叉注意力块中的键和值）可用于（请参阅
past_key_values输入）以加快顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入层的输出加上每层的输出）。在每个层输出的解码器的隐藏状态以及可选的初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器的注意力权重，在注意力softmax之后，用于在自注意力头中计算加权平均。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器交叉注意力层的注意力权重，在注意力softmax之后，用于计算交叉注意力头中的加权平均。
-
encoder_last_hidden_state (
形状为，可选) — 模型编码器的最后一个层输出的隐藏状态序列。(batch_size, sequence_length, hidden_size)的torch.FloatTensor -
encoder_hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入层的输出加上每层的输出）。编码器在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。编码器的注意力权重，在注意力softmax之后，用于计算自注意力头中的加权平均。
MvpModel的前向方法，覆盖了__call__特殊方法。
尽管前向传递的食谱需要在函数内定义，但应该调用Module实例之后而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MvpModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("RUCAIBox/mvp")
>>> model = MvpModel.from_pretrained("RUCAIBox/mvp")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateMvpForConditionalGeneration
类 transformers.MvpForConditionalGeneration
< 来源 >( config: MvpConfig )
参数
- config (MvpConfig) — 模型配置类，包含模型的全部参数。使用配置文件初始化不会加载与模型关联的权重，只有配置。查看 from_pretrained() 方法来加载模型权重。
带有语言建模头部的 MVP 模型。可用于各种文本生成任务。该模型继承自 PreTrainedModel。检查超类文档以查看库为其实现的所有模型的通用方法（如下载或保存、调整输入嵌入大小、剪枝头部等。）
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有内容。
前向
< source >( input_ids: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor的形状为(batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。如果提供的话，默认会忽略填充。 - attention_mask (
torch.Tensor的形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]范围内：- 1 表示 未掩码 的标记，
- 0 表示 掩码 的标记。
- decoder_input_ids （可选，形状为
torch.LongTensor的(batch_size, target_sequence_length)的 decoder_input_ids）— 词汇表中解码器输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Mvp 使用
eos_token_id作为decoder_input_ids生成时的起始标记。如果使用past_key_values，则选项性地只需要输入最后decoder_input_ids（请参阅past_key_values）。对于翻译和摘要训练，应提供
decoder_input_ids。如果没有提供decoder_input_ids，模型将根据论文创建此张量，通过将input_ids向右移动进行降噪预训练。 - decoder_attention_mask （可选，形状为
torch.LongTensor的(batch_size, target_sequence_length)的 decoder_attention_mask）— 默认行为：生成一个忽略decoder_input_ids中填充标记的张量。默认情况下还会使用因果掩码。如果您想要更改填充行为，应阅读
modeling_mvp._prepare_decoder_attention_mask并根据需要进行修改。有关默认策略的更多信息，请参见论文中的图 1。 - head_mask （形状为
(encoder_layers, encoder_attention_heads)的torch.Tensor，可选） — 用于取消编码器中注意力模块所选头的遮罩。在[0, 1]中选择的遮罩值：- 1 表示头未被遮罩，
- 0 表示头被遮罩。
- decoder_head_mask （形状为
(decoder_layers, decoder_attention_heads)的torch.Tensor，可选） — 用于取消解码器中注意力模块所选头的遮罩。在[0, 1]中选择的遮罩值：- 1 表示头未被遮罩，
- 0 表示头被遮罩。
- cross_attn_head_mask （形状为
(decoder_layers, decoder_attention_heads)的torch.Tensor，可选） — 用于取消解码器中交叉注意力模块所选头的遮罩。在[0, 1]中选择的遮罩值：- 1 表示头未被遮罩，
- 0 表示头被遮罩。
- encoder_outputs (
tuple(tuple(torch.FloatTensor), 可选) —— Tuple 由 (last_hidden_state，可选:hidden_states，可选:attentions) 组成last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力中用用。 - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，当传入use_cache=True或当config.use_cache=True时返回) —— Tuple 为长度为config.n_layers的tuple(torch.FloatTensor)，每个 tuple 包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量和 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加快序列解码。如果使用
past_key_values，用户可选择性地只输入最后一个decoder_input_ids（那些未向此模型提供过去键值状态的）的形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
torch.Sdk浮点数，形状为(批量大小, 序列长度, 隐藏大小)，可选)- 如果不是传递input_ids，可以选择直接传递嵌入表示。这在您想更多控制如何将input_ids索引转换为相关向量，而不是模型内部嵌入查找矩阵时很有用。 - decoder_inputs_embeds (
torch.Sdk浮点数，形状为(批量大小, 目标序列长度, 隐藏大小)，可选) - 如果不传递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 (
布尔，可选) - 如果设置为True，则返回past_key_values密钥值状态，可用于加速解码 (参见past_key_values)。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而非纯元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言模型损失的标签。索引应在[0, ..., config.vocab_size]内，或为 -100（参见input_ids文档）。设置为-100的索引的标记将被忽略（掩码），损失仅计算[0, ..., config.vocab_size]内的标签标记的标记。
返回
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 元组的组合（如果传递 return_dict=False 或当 config.return_dict=False）包含各种元素，这取决于配置（MvpConfig）和输入。
-
loss （
torch.FloatTensor形状为(1,)，可选，当提供labels时返回） — 语言模型损失。 -
logits （
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)） — 语言模型头部的预测分数（每个词汇的分数在 SoftMax 之前）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的元组，每个元组包含2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及2个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。包含预先计算的隐藏状态（在自注意力块和交叉注意力块中的键和值）可用于（请参阅
past_key_values输入）以加快顺序解码。 -
decoder_hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入层的输出加上每层的输出）。每个层的解码器隐藏状态以及初始嵌入输出。
-
decoder_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器的注意力权重，在注意力softmax之后，用于在自注意力头中计算加权平均。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。解码器交叉注意力层的注意力权重，在注意力softmax之后，用于计算交叉注意力头中的加权平均。
-
encoder_last_hidden_state (
形状为，可选) — 模型编码器的最后一个层输出的隐藏状态序列。(batch_size, sequence_length, hidden_size)的torch.FloatTensor -
encoder_hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入层的输出加上每层的输出）。每个层的编码器隐藏状态以及初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。编码器的注意力权重，在注意力softmax之后，用于计算自注意力头中的加权平均。
MvpForConditionalGeneration 前向方法覆盖了 __call__ 特殊方法。
尽管前向传递的食谱需要在函数内定义，但应该调用Module实例之后而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
摘要示例
模型微调
>>> import torch
>>> from transformers import AutoTokenizer, MvpForConditionalGeneration
>>> tokenizer = AutoTokenizer.from_pretrained("RUCAIBox/mvp")
>>> model = MvpForConditionalGeneration.from_pretrained("RUCAIBox/mvp")
>>> inputs = tokenizer(
... "Summarize: You may want to stick it to your boss and leave your job, but don't do it if these are your reasons.",
... return_tensors="pt",
... )
>>> labels = tokenizer("Bad Reasons To Quit Your Job", return_tensors="pt")["input_ids"]
>>> loss = model(**inputs, labels=labels).loss
>>> loss.backward()模型微调后的推理
MvpForSequenceClassification
类 transformers.MvpForSequenceClassification
< source >( config: MvpConfig **kwargs )
参数
- config (MvpConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化时不加载与模型关联的权重，只加载配置。查看from_pretrained() 方法来加载模型权重。
Mvp模型在顶部有一个序列分类头部（池化输出的线性层），例如用于GLUE任务。
此模型继承自PreTrainedModel。检查上层类文档以了解库为所有模型实现的一般方法（如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有内容。
前向
< source >( input_ids: LongTensor = None attention_mask: 可选 = None decoder_input_ids: 可选 = None decoder_attention_mask: 可选 = None head_mask: 可选 = None decoder_head_mask: 可选 = None cross_attn_head_mask: 可选 = None encoder_outputs: 可选 = None inputs_embeds: 可选 = None decoder_inputs_embeds: 可选 = None labels: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列token在词典中的索引。如果提供，默认会忽略填充。索引可以通过 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()。
Mvp使用
eos_token_id作为decoder_input_ids生成的起始令牌。如果使用past_key_values，则可选项中只能输入最后的decoder_input_ids（见past_key_values）。对于翻译和摘要训练，应该提供
decoder_input_ids。如果没有提供decoder_input_ids，模型将根据论文中的去噪预训练方法创建这个张量，将input_ids右移。 - decoder_attention_mask （类型为
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选）— 默认行为：生成一个忽略decoder_input_ids中的填充标记的张量。默认情况下也会使用因果掩码。 - head_mask （类型为
torch.Tensor，形状为(encoder_layers, encoder_attention_heads)，可选）— 用于取消编码器中注意力模块选定头的掩码。掩码值选择在[0, 1]： - decoder_head_mask （类型为
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选）— 用于取消解码器中注意力模块选定头的掩码。掩码值选择在[0, 1]： - cross_attn_head_mask（形状为
(decoder_layers, decoder_attention_heads)的torch.Tensor，可选）— 用于解码器中注销跨注意力模块选定头的掩码。掩码值选定在[0, 1]：- 1表示头未掩码，
- 0表示头已掩码。
- encoder_outputs（形状为
(tuple(tuple(torch.FloatTensor))，可选）— 包含 (last_hidden_state，可选hidden_states，可选attentions，)last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层的隐藏状态的序列。用于解码器的跨注意力中。 - past_key_values（形状为
(tuple(tuple(torch.FloatTensor)))，可选，当传递use_cache=True或当config.use_cache=True）时返回 — 长度为config.n_layers的元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的额外张量。包含预计算的隐藏状态（自我注意块和跨注意块中的键和值），可以用来（参见
past_key_values输入）加速顺序解码。如果使用
past_key_values，则用户可以选择性地输入仅最后decoder_input_ids（那些没有向此模型提供过去键值状态的）的形状(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递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）。如果需要比模型内部的嵌入查找矩阵更多控制，将索引转换为相关向量，这是有用的。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values密钥值状态并可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。关于返回张量下的更多细节，请参阅attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。关于返回张量下的更多细节，请参阅hidden_states。 - return_dict (
bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels > 1，则计算分类损失（交叉熵）。
MvpForSequenceClassification 前向方法，覆盖了 __call__ 特殊方法。
尽管前向传递的食谱需要在函数内定义，但应该调用Module实例之后而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
在 num_labels 个类别上微调模型
>>> import torch
>>> from transformers import AutoTokenizer, MvpForSequenceClassification
>>> num_labels = 2 # for example, this is a binary classification task
>>> tokenizer = AutoTokenizer.from_pretrained("RUCAIBox/mvp")
>>> model = MvpForSequenceClassification.from_pretrained("RUCAIBox/mvp", num_labels=num_labels)
>>> inputs = tokenizer("Classify: Hello, my dog is cute", return_tensors="pt")
>>> labels = torch.tensor(1) # the real label for inputs
>>> loss = model(**inputs, labels=labels).loss
>>> loss.backward()模型微调后的推理
MvpForQuestionAnswering
类 transformers.MvpForQuestionAnswering
< 来源 >( 配置 )
参数
- config (MvpConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化并不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
MVP模型，顶部带有跨度分类头，用于SQuAD等抽回答题任务（在隐藏状态输出之上有一个线性层来计算跨度开始logits和跨度结束logits）。
此模型继承自PreTrainedModel。检查上层类文档以了解库为所有模型实现的一般方法（如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以了解与一般用法和行为相关的所有内容。
前向
< source >( input_ids: Tensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None start_positions: Optional = None end_positions: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- 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()。
Mvp 用于使用
eos_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，则只需输入最后一个decoder_input_ids（请参阅past_key_values）。对于翻译和摘要训练，应提供
decoder_input_ids。如果没有提供decoder_input_ids，则模型将根据论文中的去噪预训练方法通过将input_ids向右移动来创建此张量。 - decoder_attention_mask （形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选） — 默认行为：生成一个忽略decoder_input_ids中的 padding 标记的 tensor。默认情况下还会使用因果掩码。如果您想更改填充行为，应阅读
modeling_mvp._prepare_decoder_attention_mask并修改以满足您的需求。有关默认策略的更多信息，请参阅论文中的图 1（链接）。 - head_mask （形状为
(encoder_layers, encoder_attention_heads)的torch.Tensor，可选） — 用于使编码器注意力模块中选定的头失效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部 未遮蔽，
- 0 表示头部 遮蔽。
- decoder_head_mask （形状为
(decoder_layers, decoder_attention_heads)的torch.Tensor，可选） — 用于使解码器注意力模块中选定的头失效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部 未遮蔽，
- 0 表示头部 遮蔽。
- cross_attn_head_mask （shape为
(decoder_layers, decoder_attention_heads)的torch.Tensor，可选）——对解码器中跨注意力模块选定头部的掩码。掩码值选择在[0, 1]之间：- 1表示头部未被掩码，
- 0表示头部被掩码。
- encoder_outputs （shape为
(batch_size, sequence_length, hidden_size)的last_hidden_state，可选：hidden_states、可选：attentions）——（可选的）元组，包括编码器最后一层的隐藏状态序列last_hidden_state。用于解码器的交叉注意力。 - past_key_values （
tuple(tuple(torch.FloatTensor))，可选，返回时传入use_cache=True或config.use_cache=True）—包含长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及2个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可以在（见
past_key_values输入）中用于加速顺序解码。如果使用
past_key_values，则用户可以选择性地输入形状为(batch_size, 1)的最后decoder_input_ids（这些没有将其过去键值状态提供给该模型）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds （形状为
torch.FloatTensor的(batch_size, sequence_length, hidden_size)的张量，可选）—除了传递input_ids外，您还可以直接传递嵌入表示。这适用于您想更多地控制如何将input_ids索引转换为相关向量，而不仅仅是模型内部的嵌入查找矩阵。 - decoder_inputs_embeds (
torch.FloatTensorof shape(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 而不是普通元组。 - start_positions (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算token分类损失的标记跨度起始位置（索引）的标签。位置将被限制为序列长度（sequence_length）。序列之外的位置不会被考虑用于计算损失。 - end_positions （
torch.LongTensor形状(batch_size,)，可选） — 计算token分类损失的标签，用于标记有标记的片段末尾的位置。位置被限制在序列长度（sequence_length）之内。序列之外的位置不计入损失计算。
MvpForQuestionAnswering 的 forward 方法，覆盖了特殊方法 __call__。
尽管前向传递的食谱需要在函数内定义，但应该调用Module实例之后而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
微调模型用于提取式问答，我们的模型也支持使用 BartForConditionalGeneration 进行生成式问答。
>>> import torch
>>> from transformers import AutoTokenizer, MvpForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("RUCAIBox/mvp")
>>> model = MvpForQuestionAnswering.from_pretrained("RUCAIBox/mvp")
>>> inputs = tokenizer(
... "Answer the following question: Who was Jim Henson? [SEP] Jim Henson was a nice puppet",
... return_tensors="pt",
... )
>>> target_start_index = torch.tensor([18])
>>> target_end_index = torch.tensor([19])
>>> loss = model(**inputs, start_positions=target_start_index, end_positions=target_end_index).loss
>>> loss.backward()模型微调后的推理
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> predict_answer = tokenizer.decode(predict_answer_tokens)MvpForCausalLM
前向
< 来源 >( input_ids: LongTensor = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或者 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 视频库中输入序列标记的索引。您提供时，默认会忽略填充。您可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]：- 1 表示 未掩码 的标记，
- 0 表示 掩码 的标记。
- encoder_hidden_states (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后层的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), 可选) — 用于禁止在编码器输入的填充标记索引上执行注意力的掩码。当模型配置为解码器时，此掩码用于交叉注意力。掩码值选择在[0, 1]之间： - head_mask (
torch.Tensorof shape(decoder_layers, decoder_attention_heads), 可选) — 掩码用于忽略注意力模块中选定的头部。掩码值选择在[0, 1]之间：- 1 表示头部未掩码
- 0 表示头部已掩码
- cross_attn_head_mask (
torch.Tensorof shape(decoder_layers, decoder_attention_heads), 可选) — 掩码用于忽略交叉注意力模块中选定的头部。掩码值选择在[0, 1]之间：- 1 表示头部未掩码
- 0 表示头部已掩码
- past_key_values (
tuple(tuple(torch.FloatTensor))，可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)的元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量以及 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。只有当模型用作序列到序列模型中的解码器时，这两个额外的张量才是必需的。包含可用于快速进行序列解码的预计算的隐藏状态（自注意力块和交叉注意力块中的键和值）。
如果使用
past_key_values，则用户可以选择只输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将过去键值状态给此模型的）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 对于计算掩码语言模型损失的标签。索引应为[0, ..., config.vocab_size]或 -100（请参阅input_ids文档字符串）。设置为-100的索引的标记将被忽略（掩码），损失仅计算为标签在[0, ..., config.vocab_size]范围内的标记。 - 使用缓存 (
布尔值，可选) — 如果设置为True，将返回past_key_values关键值状态，并可用于加快解码速度（见past_key_values）。- 对于非掩码标记，为1，
- 对于掩码标记标记，为0。
- 返回注意力 (
布尔值，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - 返回隐藏状态 (
布尔值，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict（《布尔型`, 可选）—— 是否返回ModelOutput而非一个普通的元组。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions或tuple(torch.FloatTensor)
如果transformers.modeling_outputs.CausalLMOutputWithCrossAttentions或一个torch.FloatTensor的元组（如果传递了return_dict=False或config.return_dict=False），它包含根据配置（《MvpConfig》）和输入的不同元素。
-
loss（
torch.FloatTensor的形状(1,)，可选，当提供labels时返回）—— 语言建模损失（用于下一编号预测）。 -
logits （
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)） — 语言模型头部的预测分数（每个词汇的分数在 SoftMax 之前）。 -
hidden_states（《tuple(torch.FloatTensor)`），可选，当传递
output_hidden_states=True或config.output_hidden_states=True时返回）—— 一个torch.FloatTensor的元组（如果有嵌入层，则为嵌入层的输出，另外每个层的输出为每个层）的形状为（batch_size, sequence_length, hidden_size）。模型在每个层输出的隐藏状态，以及可选的初始嵌入输出。
-
attentions（《tuple(torch.FloatTensor)`），可选，当传递
output_attentions=True或config.output_attentions=True时返回）—— 一个torch.FloatTensor的元组（每个层有一个），形状为（《batch_size, num_heads, sequence_length, sequence_length》）。注意软归一化后的注意力权重，用于在自注意力头中计算加权平均。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意软归一化后的交叉注意力权重，用于在交叉注意力头中计算加权平均。
-
past_key_values（《tuple(tuple(torch.FloatTensor))`），可选，当传递
use_cache=True或config.use_cache=True时返回）—— 一个长度为config.n_layers的torch.FloatTensor元组元组，包含如果模型在编码器-解码器设置中使用时的自注意力和交叉注意力层的缓存的键、值状态。只有当config.is_decoder = True时才相关。包含预计算的隐藏状态（注意块中的键和值）可用于（按
past_key_values输入）加速顺序编码。
示例
>>> from transformers import AutoTokenizer, MvpForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("RUCAIBox/mvp")
>>> model = MvpForCausalLM.from_pretrained("RUCAIBox/mvp", add_cross_attention=False)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> list(logits.shape)
[1, 8, 50267]