Transformers 文档
BART
并获得增强的文档体验
开始使用
该模型于 2019 年 10 月 29 日在 HF 论文中发表，并于 2020 年 11 月 16 日贡献给 Hugging Face Transformers。
BART
BART 是一个序列到序列（sequence-to-sequence）模型，它结合了 BERT 和 GPT 的预训练目标。它通过多种方式损坏文本（如删除单词、打乱句子顺序或遮蔽 token）并学习如何修复这些损坏，从而进行预训练。编码器对损坏的文档进行编码，解码器则负责修复这些损坏的文本。由于学习了恢复原始文本，BART 在理解和生成语言方面表现得非常出色。
你可以在 AI at Meta 组织下找到所有原始的 BART 检查点。
下面的示例演示了如何使用 Pipeline、AutoModel 以及通过命令行来预测 [MASK] token。
from transformers import pipeline
fill_mask_pipeline = pipeline(
task="fill-mask",
model="facebook/bart-large",
device=0
)
pipeline("Plants create <mask> through a process known as photosynthesis.")注意事项
- 输入应该在右侧进行填充（padding），因为 BART 使用了绝对位置嵌入。
- facebook/bart-large-cnn 检查点不包含
mask_token_id，这意味着它无法执行掩码填充（mask-filling）任务。 - BART 在序列分类中不使用
token_type_ids。请使用 BartTokenizer 或 encode() 来获取正确的切分。 - 如果未传递
decoder_input_ids，BartModel 的前向传播会自动创建它们。这可能与其他模型 API 有所不同，但它是执行掩码填充任务的有用特性。 - 当
forced_bos_token_id=0时，模型预测结果旨在与原始实现保持一致。这仅在传递给fairseq.encode的文本以空格开头时有效。 - 对于诸如摘要生成等条件生成任务，应该使用 generate()。
BartConfig
class transformers.BartConfig
< 源代码 >( 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 | None = True vocab_size: int = 50265 max_position_embeddings: int = 1024 encoder_layers: int | None = 12 encoder_ffn_dim: int | None = 4096 encoder_attention_heads: int | None = 16 decoder_layers: int | None = 12 decoder_ffn_dim: int | None = 4096 decoder_attention_heads: int | None = 16 encoder_layerdrop: float | None = 0.0 decoder_layerdrop: float | None = 0.0 activation_function: str | None = 'gelu' d_model: int | None = 1024 dropout: float | int | None = 0.1 attention_dropout: float | int | None = 0.0 activation_dropout: float | int | None = 0.0 init_std: float | None = 0.02 classifier_dropout: float | int | None = 0.0 scale_embedding: bool | None = False use_cache: bool = True pad_token_id: int | None = 1 bos_token_id: int | None = 0 eos_token_id: int | list[int] | None = 2 decoder_start_token_id: int | None = 2 forced_eos_token_id: int | list[int] | None = 2 is_decoder: bool | None = False tie_word_embeddings: bool = True )
参数
- is_encoder_decoder (
bool, 可选, 默认为True) — 模型是否用作编码器/解码器。 - vocab_size (
int, 可选, 默认为50265) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - max_position_embeddings (
int, 可选, 默认为1024) — 该模型可能使用的最大序列长度。 - encoder_layers (
int, 可选, 默认为12) — Transformer 编码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - encoder_ffn_dim (
int, 可选, 默认为4096) — 编码器中“中间”层（通常称为前馈层）的维度。 - encoder_attention_heads (
int, 可选, 默认为16) — Transformer 编码器中每个注意力层的注意力头数量。 - decoder_layers (
int, 可选, 默认为12) — Transformer 解码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - decoder_ffn_dim (
int, 可选, 默认为4096) — 解码器中“中间”层（通常称为前馈层）的维度。 - decoder_attention_heads (
int, 可选, 默认为16) — Transformer 解码器中每个注意力层的注意力头数量。 - 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)。 - activation_function (
str, 可选, 默认为gelu) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu"、"relu"、"silu"等。 - d_model (
int, 可选, 默认为1024) — 编码器层和池化层（pooler layer）的大小。 - dropout (
Union[float, int], 可选, 默认为0.1) — 所有 dropout 层的丢弃比例。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力概率的 dropout 比例。 - activation_dropout (
Union[float, int], 可选, 默认为0.0) — 全连接层内部激活函数的 dropout 比例。 - init_std (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - classifier_dropout (
Union[float, int], 可选, 默认为0.0) — 分类器的 dropout 比例。 - scale_embedding (
bool, 可选, 默认为False) — 是否通过除以 sqrt(d_model) 来缩放嵌入。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型为仅解码器的生成模型时相关。 - pad_token_id (
int, 可选, 默认为1) — 词表中用于填充（padding）的 token ID。 - bos_token_id (
int, 可选, 默认为0) — 词表中用于流开始（beginning-of-stream）的 token ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词表中用于流结束（end-of-stream）的 token ID。 - decoder_start_token_id (
int, 可选, 默认为2) — 如果编码器-解码器模型开始解码时使用的 token 与bos不同，则为该 token 的 ID。 - forced_eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 达到max_length时强制作为最后一个生成 token 的 token ID。通常设置为eos_token_id。 - is_decoder (
bool, 可选, 默认为False) — 模型是否用作解码器。如果为False，则模型用作编码器。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。
这是用于存储 BartModel 配置的配置类。它根据指定的参数实例化一个 Bart 模型，从而定义模型架构。使用默认值实例化配置将产生与 facebook/bart-large 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import BartConfig, BartModel
>>> # Initializing a BART facebook/bart-large style configuration
>>> configuration = BartConfig()
>>> # Initializing a model (with random weights) from the facebook/bart-large style configuration
>>> model = BartModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configBartTokenizer
class transformers.RobertaTokenizer
< source >( vocab: str | dict[str, int] | None = None merges: str | list[str] | None = None errors: str = 'replace' bos_token: str = '<s>' eos_token: str = '</s>' sep_token: str = '</s>' cls_token: str = '<s>' unk_token: str = '<unk>' pad_token: str = '<pad>' mask_token: str = '<mask>' add_prefix_space: bool = False trim_offsets: bool = True **kwargs )
参数
- vocab (
str,dict或list, 可选) — 自定义词表字典。如果未提供，则从 vocab_file 加载词表。 - merges (
str或list, 可选) — 自定义合并列表。如果未提供，则从 merges_file 加载合并列表。 - 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，而是被设置为此标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充 (padding) 的标记，例如在对不同长度的序列进行批处理时使用。 - mask_token (
str, 可选, 默认为"<mask>") — 用于掩码值的标记。这是在使用掩码语言建模 (MLM) 训练此模型时使用的标记。这是模型将尝试预测的标记。 - add_prefix_space (
bool, 可选, 默认为False) — 是否在输入中添加初始空格。这允许像处理其他单词一样处理前导词。（RoBERTa 分词器通过前面的空格来检测单词的开始）。 - trim_offsets (
bool, 可选, 默认为True) — 后处理步骤是否应修整偏移量以避免包含空格。
Construct a RoBERTa tokenizer (backed by HuggingFace’s tokenizers library). Based on Byte-Pair-Encoding.
这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会
无论是否在句子开头（无空格），编码方式都会不同
>>> from transformers import RobertaTokenizer
>>> tokenizer = RobertaTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> 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进行实例化。
该分词器继承自 TokenizersBackend，后者包含其大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
BartTokenizerFast
class transformers.RobertaTokenizer
< source >( vocab: str | dict[str, int] | None = None merges: str | list[str] | None = None errors: str = 'replace' bos_token: str = '<s>' eos_token: str = '</s>' sep_token: str = '</s>' cls_token: str = '<s>' unk_token: str = '<unk>' pad_token: str = '<pad>' mask_token: str = '<mask>' add_prefix_space: bool = False trim_offsets: bool = True **kwargs )
参数
- vocab (
str,dict或list, 可选) — 自定义词表字典。如果未提供，则从 vocab_file 加载词表。 - merges (
str或list, 可选) — 自定义合并列表。如果未提供，则从 merges_file 加载合并列表。 - 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，而是被设置为此标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充 (padding) 的标记，例如在对不同长度的序列进行批处理时使用。 - mask_token (
str, 可选, 默认为"<mask>") — 用于掩码值的标记。这是在使用掩码语言建模 (MLM) 训练此模型时使用的标记。这是模型将尝试预测的标记。 - add_prefix_space (
bool, 可选, 默认为False) — 是否在输入中添加初始空格。这允许像处理其他单词一样处理前导词。（RoBERTa 分词器通过前面的空格来检测单词的开始）。 - trim_offsets (
bool, 可选, 默认为True) — 后处理步骤是否应修整偏移量以避免包含空格。
Construct a RoBERTa tokenizer (backed by HuggingFace’s tokenizers library). Based on Byte-Pair-Encoding.
这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会
无论是否在句子开头（无空格），编码方式都会不同
>>> from transformers import RobertaTokenizer
>>> tokenizer = RobertaTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> 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进行实例化。
该分词器继承自 TokenizersBackend，后者包含其大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
BartModel
class transformers.BartModel
< 源码 >( config: BartConfig )
参数
- config (BartConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
基础 Bart 模型，输出原始隐藏状态，顶部没有任何特定的层。
该模型继承自 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: list[torch.FloatTensor] | 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 (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 词表中输入序列 token 的索引。默认情况下，填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力操作的掩码。掩码值选自[0, 1]：- 1 表示 token 未被掩码，
- 0 表示 token 被掩码。
- decoder_input_ids (
torch.LongTensor, 形状为(batch_size, target_sequence_length), 可选) — 词表中解码器输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Bart 使用
eos_token_id作为decoder_input_ids生成的起始 token。如果使用了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中填充 token 的掩码。默认情况下也会使用因果掩码（causal mask）。如果您想更改填充行为，应该阅读
modeling_bart._prepare_decoder_attention_mask并根据需要进行修改。有关默认策略的更多信息，请参阅论文中的图 1。 - encoder_outputs (
list[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)，last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在之前的解码阶段返回，当use_cache=True或config.use_cache=True时使用。输入仅允许 Cache 实例，请参阅我们的 kv 缓存指南。如果没有传递
past_key_values，默认将初始化 DynamicCache。模型将输出与作为输入传入时相同的缓存格式。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即那些没有将其过去键值状态提供给此模型的 ID），形状为(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的值。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（参阅past_key_values）。
返回
Seq2SeqModelOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置（BartConfig）和输入。
BartModel 的前向传播方法，覆盖了 __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 之后，用于计算自注意力头中的加权平均。
BartForConditionalGeneration
class transformers.BartForConditionalGeneration
< 源码 >( config: BartConfig )
参数
- config (BartConfig) — 模型配置类，包含模型的所有参数。仅使用配置文件进行初始化不会加载模型权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
带有语言建模头的 BART 模型，可用于文本摘要。
该模型继承自 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: list[torch.FloatTensor] | 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, 可选) — 词汇表中输入序列 token 的索引。默认情况下，填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值选自[0, 1]：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)的torch.LongTensor, 可选) — 词汇表中解码器输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Bart 使用
eos_token_id作为decoder_input_ids生成的起始 token。如果使用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中填充 token 的张量。默认也会使用因果掩码（causal mask）。如果您想更改填充行为，请阅读
modeling_bart._prepare_decoder_attention_mask并根据需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。 - encoder_outputs (
list[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state（可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常由模型在解码的先前阶段返回（当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的值。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]范围内或为 -100（请参阅input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的 token 进行计算。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。
返回
Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqLMOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（BartConfig）和输入，包含各种元素。
BartForConditionalGeneration 的前向传播方法，覆盖了 __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, BartForConditionalGeneration
>>> model = BartForConditionalGeneration.from_pretrained("facebook/bart-large-cnn")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large-cnn")
>>> ARTICLE_TO_SUMMARIZE = (
... "PG&E stated it scheduled the blackouts in response to forecasts for high winds "
... "amid dry conditions. The aim is to reduce the risk of wildfires. Nearly 800 thousand customers were "
... "scheduled to be affected by the shutoffs which were expected to last through at least midday tomorrow."
... )
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=1024, return_tensors="pt")
>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"], num_beams=2, min_length=0, max_length=20)
>>> tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'PG&E scheduled the blackouts in response to forecasts for high winds amid dry conditions'掩码填充示例
>>> from transformers import AutoTokenizer, BartForConditionalGeneration
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-base")
>>> model = BartForConditionalGeneration.from_pretrained("facebook/bart-base")
>>> TXT = "My friends are <mask> but they eat too many carbs."
>>> input_ids = tokenizer([TXT], return_tensors="pt")["input_ids"]
>>> logits = model(input_ids).logits
>>> masked_index = (input_ids[0] == tokenizer.mask_token_id).nonzero().item()
>>> probs = logits[0, masked_index].softmax(dim=0)
>>> values, predictions = probs.topk(5)
>>> tokenizer.decode(predictions).split()
['not', 'good', 'healthy', 'great', 'very']BartForSequenceClassification
class transformers.BartForSequenceClassification
< 源码 >( config: BartConfig **kwargs )
参数
- config (BartConfig) — 模型配置类，包含模型的所有参数。仅使用配置文件进行初始化不会加载模型权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
顶部带有序列分类头的 Bart 模型（池化输出之上的线性层），例如用于 GLUE 任务。
该模型继承自 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: list[torch.FloatTensor] | 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] ) → Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 词汇表中输入序列 token 的索引。默认情况下，填充将被忽略。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值选自[0, 1]：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- decoder_input_ids (形状为
(batch_size, target_sequence_length)的torch.LongTensor, 可选) — 词汇表中解码器输入序列 token 的索引。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
Bart 使用
eos_token_id作为decoder_input_ids生成的起始 token。如果使用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中填充 token 的张量。默认也会使用因果掩码。如果您想更改填充行为，请阅读
modeling_bart._prepare_decoder_attention_mask并根据需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。 - encoder_outputs (
list[torch.FloatTensor], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)。形状为(batch_size, sequence_length, hidden_size)的last_hidden_state（可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - 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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels > 1，则会计算分类损失（交叉熵）。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。
返回
Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqSequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False 时），根据配置 (BartConfig) 和输入包含不同的元素。
BartForSequenceClassification 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供label时返回) — 分类 (如果 config.num_labels==1 则为回归) 损失。logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（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 之后，用于计算自注意力头中的加权平均。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BartForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large")
>>> model = BartForSequenceClassification.from_pretrained("facebook/bart-large")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = BartForSequenceClassification.from_pretrained("facebook/bart-large", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, BartForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large")
>>> model = BartForSequenceClassification.from_pretrained("facebook/bart-large", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = BartForSequenceClassification.from_pretrained(
... "facebook/bart-large", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossBartForQuestionAnswering
class transformers.BartForQuestionAnswering
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (BartForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查阅 from_pretrained() 方法来加载模型权重。
用于抽取式问答任务（如 SQuAD）的 Bart Transformer，顶部带有一个跨度（span）分类头（在隐藏状态输出之上添加一个线性层，以计算 span start logits 和 span end logits）。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None, attention_mask: torch.Tensor | None = None, decoder_input_ids: torch.LongTensor | None = None, decoder_attention_mask: torch.LongTensor | None = None, encoder_outputs: list[torch.FloatTensor] | None = None, start_positions: torch.LongTensor | None = None, end_positions: torch.LongTensor | 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] ) → Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词表中输入序列标记的索引。默认情况下，填充（Padding）将被忽略。索引可以使用 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()。
Bart 使用
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中填充标记的张量。默认情况下还将使用因果（Causal）掩码。如果你想更改填充行为，应该阅读
modeling_bart._prepare_decoder_attention_mask并按需修改。有关默认策略的更多信息，请参见论文中的图 1。 - encoder_outputs (
list[torch.FloatTensor]，可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)；last_hidden_state（形状为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标注跨度（span）起始位置（索引）的标签。位置会被截断（clamp）至序列长度（sequence_length）。序列之外的位置不会被计入损失计算。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标注跨度（span）结束位置（索引）的标签。位置会被截断（clamp）至序列长度（sequence_length）。序列之外的位置不会被计入损失计算。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - decoder_inputs_embeds (
torch.FloatTensor，形状为(batch_size, target_sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入decoder_input_ids。如果使用了past_key_values，则可以选择仅传入最后的decoder_inputs_embeds（请参阅past_key_values）。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将decoder_input_ids索引转换为关联向量，这将非常有用。如果
decoder_input_ids和decoder_inputs_embeds均未设置，则decoder_inputs_embeds将采用inputs_embeds的值。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。
返回
Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 Seq2SeqQuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False 时），根据配置 (BartConfig) 和输入包含不同的元素。
BartForQuestionAnswering 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（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, BartForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-large")
>>> model = BartForQuestionAnswering.from_pretrained("facebook/bart-large")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> 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]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...BartForCausalLM
class transformers.BartForCausalLM
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (BartForCausalLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有语言建模头的 BART 解码器（线性层，权重与输入嵌入绑定）。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
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，则必须是一维的，对应于需要在序列长度维度上保留的索引。这在使用打包张量格式（batch 和序列长度使用单一维度）时非常有用。
返回
CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
一个 CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（BartConfig）和输入，包含不同的元素。
BartForCausalLM 的前向传播方法，覆盖了 __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, BartForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/bart-base")
>>> model = BartForCausalLM.from_pretrained("facebook/bart-base")
>>> 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