Transformers documentation
XLNet
该模型于 2019-06-19 在 HF papers 上发表，并于 2020-11-16 贡献给 Hugging Face Transformers。
XLNet
概述
XLNet 模型由 Zhilin Yang、Zihang Dai、Yiming Yang、Jaime Carbonell、Ruslan Salakhutdinov 和 Quoc V. Le 在 XLNet: Generalized Autoregressive Pretraining for Language Understanding 中提出。XLNet 是 Transformer-XL 模型的扩展，它使用自回归方法进行预训练，通过最大化输入序列所有分解顺序排列上的期望似然，来学习双向上下文。
该论文的摘要如下：
凭借对双向上下文的建模能力，基于去噪自编码的预训练方法（如 BERT）在性能上优于基于自回归语言建模的预训练方法。然而，由于依赖对输入进行掩码破坏，BERT 忽略了被掩码位置之间的依赖关系，并存在预训练与微调之间的不一致性。鉴于这些优缺点，我们提出了 XLNet，这是一种广义的自回归预训练方法，它（1）通过对所有分解顺序排列的期望似然进行最大化，从而实现对双向上下文的学习；（2）得益于其自回归形式，克服了 BERT 的局限性。此外，XLNet 将 Transformer-XL（最先进的自回归模型）中的思想整合到了预训练中。实验表明，在可比的实验设置下，XLNet 在 20 项任务上均优于 BERT，且往往具有显著优势，这些任务包括问答、自然语言推理、情感分析和文档排序。
使用技巧
- 可以使用
perm_mask输入在训练和测试时控制具体的注意力模式。 - 由于在多种分解顺序上训练完全自回归模型较为困难，XLNet 在预训练时仅使用由
target_mapping输入选定的部分输出 token 作为目标。 - 要在顺序解码（即非完全双向设置）中使用 XLNet，请使用
perm_mask和target_mapping输入来控制注意力范围和输出 - XLNet 是少数没有序列长度限制的模型之一。
- XLNet 并非传统的自回归模型，而是采用了一种基于自回归的训练策略。它会打乱句子中 token 的顺序，然后让模型利用最后 n 个 token 来预测第 n+1 个 token。由于整个过程都通过掩码实现，句子实际上是以正确的顺序输入模型的，但 XLNet 并不是像传统做法那样为预测第 n+1 个 token 而屏蔽前 n 个 token，而是使用一种掩码，在 1 到序列长度的某个给定排列中隐藏之前的 token。
- XLNet 也使用与 Transformer-XL 相同的循环机制来构建长期依赖关系。
资源
XLNetConfig
类 transformers.XLNetConfig
< source >( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 32000d_model: int = 1024n_layer: int = 24n_head: int = 16d_inner: int = 4096d_head: int | None = Noneff_activation: str = 'gelu'attn_type: str = 'bi'initializer_range: float = 0.02layer_norm_eps: float = 1e-12dropout: float | int = 0.1mem_len: int | None = 512reuse_len: int | None = Noneuse_mems_eval: bool = Trueuse_mems_train: bool = Falsebi_data: bool = Falseclamp_len: int = -1same_length: bool = Falsesummary_type: str = 'last'summary_use_proj: bool = Truesummary_activation: str = 'tanh'summary_last_dropout: float | int = 0.1start_n_top: int = 5end_n_top: int = 5pad_token_id: int | None = 5bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2tie_word_embeddings: bool = True )
参数
- vocab_size (
int，可选，默认为32000) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 数量。 - d_model (
int，可选，默认为1024) — 编码器层和池化层的维度大小。 - n_layer (
int，可选，默认为24) — Transformer 解码器中的隐藏层数。 - n_head (
int，可选，默认为16) — Transformer 解码器中每个注意力层的注意力头数量。 - d_inner (
int，可选，默认为4096) — MLP 表示的维度。 - d_head (
int, 可选) — 注意力头维度。如果为 None，则默认为 hidden_size // num_attention_heads - ff_activation (
str或Callable，可选，默认为"gelu") — 前馈网络中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - attn_type (
str，可选，默认为"bi") — 模型使用的注意力类型。对于 XLNet，请设置为"bi"；对于 Transformer-XL，请设置为"uni"。 - initializer_range (
float，可选，默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float，可选，默认为1e-12) — 层归一化层所使用的 epsilon 值。 - dropout (
Union[float, int]，可选，默认为0.1) — 所有 dropout 层的比率。 - mem_len (
int或None，可选) — 要缓存的 token 数量。在之前的前向传播中已经预先计算好的键/值对不会被重新计算。更多信息请参阅 快速入门。 - reuse_len (
int, 可选) — 当前批次中将被缓存并在未来复用的 token 数量。 - use_mems_eval (
bool，可选，默认为True) — 模型在评估模式下是否应使用循环记忆机制。 - use_mems_train (
bool, optional, defaults toFalse) — Whether or not the model should make use of the recurrent memory mechanism in train mode.For pretraining, it is recommended to set `use_mems_train` to `True`. For fine-tuning, it is recommended to set `use_mems_train` to `False` as discussed [here](https://github.com/zihangdai/xlnet/issues/41#issuecomment-505102587). If `use_mems_train` is set to `True`, one has to make sure that the train batches are correctly pre-processed, *e.g.* `batch_1 = [[This line is], [This is the]]` and `batch_2 = [[ the first line], [ second line]]` and that all batches are of equal size. - bi_data (
bool，可选，默认为False) — 是否使用双向输入流水线。通常在预训练期间设置为True，在微调期间设置为False。 - clamp_len (
int，可选，默认为 -1) — 将所有大于该值的相对距离截断。将此属性设置为 -1 表示不进行截断。 - same_length（
bool，可选，默认为False）— 是否为每个 token 使用相同的注意力长度。 - summary_type (
str, 可选, ，默认为 “last”）— 用于执行序列摘要时的参数。在序列分类和多选模型中使用。 必须是以下选项之一："last"：取最后一个 token 的隐藏状态（类似于 XLNet）。"first"：取第一个 token 的隐藏状态（类似 BERT）。"mean"：对所有 token 的隐藏状态取平均值。"cls_index"：提供一个张量，指定分类标记的位置（类似于 GPT/GPT-2）。"attn"：目前未实现，请使用多头注意力。
- summary_use_proj (
bool，可选，默认为True) — 用于执行序列摘要时的参数。在序列分类和多选模型中使用。 是否在执行向量提取后添加投影层。 - summary_activation (
str, 可选) — 用于执行序列摘要时的参数。在序列分类和多选模型中使用。 传入"tanh"可对输出应用 tanh 激活函数，传入其他任何值则不应用激活函数。 - summary_last_dropout (
float，可选，默认为 0.1) — 用于序列分类和多选模型。 在投影和激活之后使用的 dropout 比率。 - start_n_top (
int，可选，默认为 5) — 用于 SQuAD 评估脚本。 - end_n_top（
int，可选，默认为 5）— 用于 SQuAD 评估脚本。 - pad_token_id (
int，可选，默认为5) — 词表中用于填充的 token id。 - bos_token_id (
int，可选，默认为1) — 词汇表中用于表示流起始的 token id。 - eos_token_id (
Union[int, list[int]]，可选，默认为2) — 词汇表中用于表示流结束（end-of-stream）的 token id。 - tie_word_embeddings (
bool，可选，默认为True) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。
这是用于存储 XLNetModel 配置的类。它根据指定的参数实例化 Xlnet 模型，并定义模型架构。使用默认值实例化配置将生成与 xlnet/xlnet-large-cased 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PreTrainedConfig 的文档。
示例：
>>> from transformers import XLNetConfig, XLNetModel
>>> # Initializing a XLNet configuration
>>> configuration = XLNetConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = XLNetModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configXLNetTokenizer
类 transformers.XLNetTokenizer
< source >( vocab: str | list[tuple[str, float]] | None = Noneunk_id: int = 0do_lower_case = Falseremove_space = Truekeep_accents = Falsebos_token = '<s>'eos_token = '</s>'unk_token = '<unk>'sep_token = '<sep>'pad_token = '<pad>'cls_token = '<cls>'mask_token = '<mask>'_spm_precompiled_charsmap = Noneadditional_special_tokens = None**kwargs )
参数
- vocab (
list of tuples，可选) — Unigram 模型的 (token, score) 元组列表。如果未提供，则使用空列表。 - unk_id (
int，可选，默认为 0) — 词表中未知令牌的 ID。 - do_lower_case（
bool，可选，默认为False）— 分词时是否将输入转换为小写。 - remove_space (
bool，可选，默认为True) — 是否在分词时去除文本中的空格（删除字符串前后的多余空格）。 - keep_accents (
bool，可选，默认为False) — 分词时是否保留重音符号。 - bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列起始标记。也可用作序列分类标记。在构建序列时，如果使用了特殊标记，序列开头使用的并不是这个标记。实际使用的标记是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。在构建包含特殊标记的序列时，序列结束使用的并非此标记，而是 sep_token。在构建包含特殊标记的序列时，序列末尾使用的并不是这个标记。 实际使用的是
sep_token。 - unk_token (
str，可选，默认为"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，因此会被设置为该标记。 - sep_token (
str，可选，默认为"<sep>") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也被用作使用特殊 token 构建的序列的最后一个 token。 - pad_token (
str，可选，默认为"<pad>") — 用于填充的标记，例如在对长度不同的序列进行批处理时。 - cls_token (
str，可选，默认为"<cls>") — 用于序列分类的分类器标记（对整个序列进行分类，而非逐标记分类）。当使用特殊标记构建序列时，它是序列的第一个标记。 - mask_token (
str, 可选，默认为"<mask>") — 用于掩码值的标记。这是在以掩码语言建模方式训练该模型时所使用的标记，也是模型将尝试预测的标记。 - additional_special_tokens (
list[str]，可选，默认为["<eop>", "<eod>"]) — 分词器使用的额外特殊标记。
构建一个 XLNet 分词器（基于 HuggingFace 的 tokenizers 库）。基于 Unigram。
该分词器继承自 TokenizersBackend，其中包含了大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
get_special_tokens_mask
< source >( token_ids_0: list[int]token_ids_1: list[int] | None = Nonealready_has_special_tokens: bool = False ) → A list of integers in the range [0, 1]
从未添加特殊标记的标记列表中检索序列 ID。
对于快速分词器，数据整理器会传入 already_has_special_tokens=True 来调用此方法，以在已格式化的序列上构建掩码。在这种情况下，我们通过检查元素是否属于 all_special_ids 来计算掩码。
XLNet 特定输出
类 transformers.models.xlnet.modeling_xlnet.XLNetModelOutput
< source >( last_hidden_state: Tensormems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
参数
- last_hidden_state (
torch.Tensor形状为(batch_size, num_predict, hidden_size)) — 模型最后一层的隐藏状态序列。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。 - mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。 - hidden_states (
tuple[torch.Tensor, ...], 可选, 在传入output_hidden_states=True或config.output_hidden_states=True) — 的元组torch.Tensor(（如果模型有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.Tensor, ...], 可选, 在传入output_attentions=True或config.output_attentions=True) — 的元组torch.Tensor(（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
XLNetModel 的输出类型。
类 transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
参数
- loss (
torch.Tensor，形状为 (1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个词元预测）。 - logits (
torch.Tensor形状为(batch_size, num_predict, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。 - mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。 - hidden_states (
tuple[torch.Tensor, ...], 可选, 在传入output_hidden_states=True或config.output_hidden_states=True) — 的元组torch.Tensor(（如果模型有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.Tensor, ...], 可选, 在传入output_attentions=True或config.output_attentions=True) — 的元组torch.Tensor(（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
XLNetLMHeadModel 的输出类型。
类 transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
参数
- loss (
torch.Tensor，形状为(1,)，可选，在提供label时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 - logits（形状为
(batch_size, config.num_labels)的torch.Tensor）— 分类（如果 config.num_labels==1 则为回归）得分（SoftMax 之前）。 - mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。 - hidden_states (
tuple[torch.Tensor, ...], 可选, 在传入output_hidden_states=True或config.output_hidden_states=True) — 的元组torch.Tensor(（如果模型有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.Tensor, ...], 可选, 在传入output_attentions=True或config.output_attentions=True) — 的元组torch.Tensor(（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
类 transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
参数
- loss (
torch.Tensor，形状为 (1,)，可选，在提供labels时返回) — 分类损失。 - logits (
torch.Tensor形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见 input_ids ）。分类分数（SoftMax 之前）。
- mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。 - hidden_states (
tuple[torch.Tensor, ...], 可选, 在传入output_hidden_states=True或config.output_hidden_states=True) — 的元组torch.Tensor(（如果模型有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.Tensor, ...], 可选, 在传入output_attentions=True或config.output_attentions=True) — 的元组torch.Tensor(（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
XLNetForMultipleChoice 的输出类型。
类 transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
参数
- loss (
torch.Tensor，形状为(1,)，可选，在提供labels时返回) — 分类损失。 - logits（形状为
(batch_size, sequence_length, config.num_labels)的torch.Tensor）— 分类分数（SoftMax 之前）。 - mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。 - hidden_states (
tuple[torch.Tensor, ...], 可选, 在传入output_hidden_states=True或config.output_hidden_states=True) — 的元组torch.Tensor(（如果模型有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.Tensor, ...], 可选, 在传入output_attentions=True或config.output_attentions=True) — 的元组torch.Tensor(（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
XLNetForTokenClassificationOutput 的输出类型。
类 transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonestart_logits: typing.Optional[torch.Tensor] = Noneend_logits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
参数
- loss (
torch.Tensor，形状为(1,)，可选，在提供labels时返回) — 总跨度提取损失是起始位置和结束位置的交叉熵之和。 - start_logits（形状为
(batch_size, sequence_length,)的torch.Tensor）— 跨度起始分数（SoftMax 之前）。 - end_logits（形状为
(batch_size, sequence_length,)的torch.Tensor）— 跨度结束分数（SoftMax 之前）。 - mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。 - hidden_states (
tuple[torch.Tensor, ...], 可选, 在传入output_hidden_states=True或config.output_hidden_states=True) — 的元组torch.Tensor(（如果模型有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.Tensor, ...], 可选, 在传入output_attentions=True或config.output_attentions=True) — 的元组torch.Tensor(（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
类 transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonestart_top_log_probs: typing.Optional[torch.Tensor] = Nonestart_top_index: typing.Optional[torch.LongTensor] = Noneend_top_log_probs: typing.Optional[torch.Tensor] = Noneend_top_index: typing.Optional[torch.LongTensor] = Nonecls_logits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
参数
- loss (
torch.Tensor，形状为(1,)，可选，当同时提供start_positions和end_positions时返回) — 分类损失，即起始 token、结束 token（如果提供了 is_impossible，则还包括其）分类损失的总和。 - start_top_log_probs (
torch.Tensor，形状为(batch_size, config.start_n_top)，可选，当未提供start_positions或end_positions时返回) — 前 config.start_n_top 个起始 token 可能性的对数概率（束搜索）。 - start_top_index（形状为
(batch_size, config.start_n_top)的torch.LongTensor，可选，当未提供start_positions或end_positions时返回） — 前 config.start_n_top 个起始 token 候选的索引（束搜索）。 - end_top_log_probs (
torch.Tensor，形状为(batch_size, config.start_n_top * config.end_n_top)，可选，当未提供start_positions或end_positions时返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性的对数概率（束搜索）。 - end_top_index（形状为
(batch_size, config.start_n_top * config.end_n_top)的torch.LongTensor，可选，当未提供start_positions或end_positions时返回） — 前config.start_n_top * config.end_n_top个结束 token 候选的索引（束搜索）。 - cls_logits（形状为
(batch_size,)的torch.Tensor，可选，在未提供start_positions或end_positions时返回） — 答案的is_impossible标签的对数概率。 - mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。 - hidden_states (
tuple[torch.Tensor, ...], 可选, 在传入output_hidden_states=True或config.output_hidden_states=True) — 的元组torch.Tensor(（如果模型有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.Tensor, ...], 可选, 在传入output_attentions=True或config.output_attentions=True) — 的元组torch.Tensor(（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
XLNetForQuestionAnswering 的输出类型。
XLNetModel
class transformers.XLNetModel
< source >( config: XLNetConfig )
参数
- config (XLNetConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
未附加任何特定头部的裸 Xlnet 模型，输出原始的隐藏状态。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetModelOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 输入序列中各 token 在词表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mems (
list[torch.Tensor]长度为config.n_layers) — 包含预计算的隐藏状态（参见mems下方的输出）。可用于加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经被计算过了。use_mems必须设置为True才能使用mems。 - perm_mask (
torch.Tensor形状为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入 token 的注意力模式的掩码，取值范围为[0, 1]:- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 会关注 j； - 如果
perm_mask[k, i, j] = 1，则在批次 k 中，i 不会关注 j。
如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。
- 如果
- target_mapping（形状为
(batch_size, num_predict, sequence_length)的torch.Tensor，可选） — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。 - token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于指示输入中第一和第二部分的片段标记索引。索引取自[0, 1]:- 0 对应 sentence A 标记，
- 1 对应于 sentence B 标记。
- input_mask (
torch.Tensor形状为batch_size, sequence_length, ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。它是attention_mask, 的负值，即真实 token 为 0，填充为 1，保留此形式以兼容原始代码库。在
[0, 1]中选择的掩码值：- 1 表示被屏蔽的 token，
- 对于未被屏蔽的 token，值为 0。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - use_mems (
bool, 可选) — 是否使用内存状态来加速顺序解码。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
XLNetModelOutput 或 tuple(torch.Tensor)
一个 XLNetModelOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（XLNetConfig）和输入。
XLNetModel 的 forward 方法会覆盖 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
last_hidden_state（形状为
(batch_size, num_predict, hidden_size)的torch.Tensor）— 模型最后一层的隐藏状态序列。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。hidden_states (
tuple[torch.Tensor, ...]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple[torch.Tensor, ...]，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
XLNetLMHeadModel
class transformers.XLNetLMHeadModel
< source >( config: XLNetConfig )
参数
- config (XLNetConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
在顶部带有语言建模头（线性层，其权重与输入嵌入共享）的 XLNet 模型。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → XLNetLMHeadModelOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 输入序列中各 token 在词表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mems (
list[torch.Tensor]长度为config.n_layers) — 包含预计算的隐藏状态（参见mems下方的输出）。可用于加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经被计算过了。use_mems必须设置为True才能使用mems。 - perm_mask (
torch.Tensor形状为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入 token 的注意力模式的掩码，取值范围为[0, 1]:- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 会关注 j； - 如果
perm_mask[k, i, j] = 1，则在批次 k 中，i 不会关注 j。
如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。
- 如果
- target_mapping（形状为
(batch_size, num_predict, sequence_length)的torch.Tensor，可选） — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。 - token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于指示输入中第一和第二部分的片段标记索引。索引取自[0, 1]:- 0 对应 sentence A 标记，
- 1 对应于 sentence B 标记。
- input_mask (
torch.Tensor形状为batch_size, sequence_length, ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。它是attention_mask, 的负值，即真实 token 为 0，填充为 1，保留此形式以兼容原始代码库。在
[0, 1]中选择的掩码值：- 1 表示被屏蔽的 token，
- 对于未被屏蔽的 token，值为 0。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (
torch.LongTensor形状为(batch_size, num_predict), 可选) — 用于掩码语言建模的标签。num_predict对应于target_mapping.shape[1]. 如果target_mapping为None, 则num_predict对应于sequence_length.标签应与需要预测的掩码输入词相对应，并且取决于
target_mapping。请注意，为了执行标准的自回归语言建模，需要在input_ids中添加一个 <mask> 标记（参见prepare_inputs_for_generation函数以及下方的示例）索引在
[-100, 0, ..., config.vocab_size]范围内选取。所有设置为-100的标签都会被忽略，损失仅针对[0, ..., config.vocab_size]范围内的标签进行计算。 - use_mems (
bool, 可选) — 是否使用内存状态来加速顺序解码。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - logits_to_keep (
Union[int, torch.Tensor], 可选，默认为0) — 如果为int，则计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成过程只需要最后一个 token 的 logits，仅针对该 token 进行计算可以节省内存，对于长序列或大词汇量而言，这种节省相当显著。 如果为torch.Tensor，则必须是一维张量，对应于序列长度维度中需要保留的索引。 这在使用打包张量格式（将批次和序列长度合并为单一维度）时非常有用。
返回值
XLNetLMHeadModelOutput 或 tuple(torch.Tensor)
一个 XLNetLMHeadModelOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（XLNetConfig）和输入。
XLNetLMHeadModel 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为 (1,) 的
torch.Tensor，可选，在提供labels时返回） — 语言建模损失（用于下一个词元预测）。logits（形状为
(batch_size, num_predict, config.vocab_size)的torch.Tensor）— 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。hidden_states (
tuple[torch.Tensor, ...]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple[torch.Tensor, ...]，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoTokenizer, XLNetLMHeadModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetLMHeadModel.from_pretrained("xlnet/xlnet-large-cased")
>>> # We show how to setup inputs to predict a next token using a bi-directional context.
>>> input_ids = torch.tensor(
... tokenizer.encode("Hello, my dog is very <mask>", add_special_tokens=False)
... ).unsqueeze(
... 0
... ) # We will predict the masked token
>>> perm_mask = torch.zeros((1, input_ids.shape[1], input_ids.shape[1]), dtype=torch.float)
>>> perm_mask[:, :, -1] = 1.0 # Previous tokens don't see last token
>>> target_mapping = torch.zeros(
... (1, 1, input_ids.shape[1]), dtype=torch.float
... ) # Shape [1, 1, seq_length] => let's predict one token
>>> target_mapping[
... 0, 0, -1
... ] = 1.0 # Our first (and only) prediction will be the last token of the sequence (the masked token)
>>> outputs = model(input_ids, perm_mask=perm_mask, target_mapping=target_mapping)
>>> next_token_logits = outputs[
... 0
... ] # Output has shape [target_mapping.size(0), target_mapping.size(1), config.vocab_size]
>>> # The same way can the XLNetLMHeadModel be used to be trained by standard auto-regressive language modeling.
>>> input_ids = torch.tensor(
... tokenizer.encode("Hello, my dog is very <mask>", add_special_tokens=False)
... ).unsqueeze(
... 0
... ) # We will predict the masked token
>>> labels = torch.tensor(tokenizer.encode("cute", add_special_tokens=False)).unsqueeze(0)
>>> assert labels.shape[0] == 1, "only one word will be predicted"
>>> perm_mask = torch.zeros((1, input_ids.shape[1], input_ids.shape[1]), dtype=torch.float)
>>> perm_mask[
... :, :, -1
... ] = 1.0 # Previous tokens don't see last token as is done in standard auto-regressive lm training
>>> target_mapping = torch.zeros(
... (1, 1, input_ids.shape[1]), dtype=torch.float
... ) # Shape [1, 1, seq_length] => let's predict one token
>>> target_mapping[
... 0, 0, -1
... ] = 1.0 # Our first (and only) prediction will be the last token of the sequence (the masked token)
>>> outputs = model(input_ids, perm_mask=perm_mask, target_mapping=target_mapping, labels=labels)
>>> loss = outputs.loss
>>> next_token_logits = (
... outputs.logits
... ) # Logits have shape [target_mapping.size(0), target_mapping.size(1), config.vocab_size]XLNetForSequenceClassification
class transformers.XLNetForSequenceClassification
< source >( config: XLNetConfig )
参数
- config (XLNetConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
在顶部带有序列分类/回归头的 XLNet 模型（在池化输出之上添加一个线性层），例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForSequenceClassificationOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 输入序列中各 token 在词表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mems (
list[torch.Tensor]长度为config.n_layers) — 包含预计算的隐藏状态（参见mems下方的输出）。可用于加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经被计算过了。use_mems必须设置为True才能使用mems。 - perm_mask (
torch.Tensor形状为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入 token 的注意力模式的掩码，取值范围为[0, 1]:- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 会关注 j； - 如果
perm_mask[k, i, j] = 1，则在批次 k 中，i 不会关注 j。
如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。
- 如果
- target_mapping（形状为
(batch_size, num_predict, sequence_length)的torch.Tensor，可选） — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。 - token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于指示输入中第一和第二部分的片段标记索引。索引取自[0, 1]:- 0 对应 sentence A 标记，
- 1 对应于 sentence B 标记。
- input_mask (
torch.Tensor形状为batch_size, sequence_length, ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。它是attention_mask, 的负值，即真实 token 为 0，填充为 1，保留此形式以兼容原始代码库。在
[0, 1]中选择的掩码值：- 1 表示被屏蔽的 token，
- 对于未被屏蔽的 token，值为 0。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_mems (
bool, 可选) — 是否使用内存状态来加速顺序解码。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
XLNetForSequenceClassificationOutput 或 tuple(torch.Tensor)
一个 XLNetForSequenceClassificationOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（XLNetConfig）和输入。
XLNetForSequenceClassification 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss (
torch.Tensor，形状为(1,)，可选，在提供label时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。logits（形状为
(batch_size, config.num_labels)的torch.Tensor）— 分类（或当 config.num_labels==1 时为回归）得分（SoftMax 之前）。mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。hidden_states (
tuple[torch.Tensor, ...]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple[torch.Tensor, ...]，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
单标签分类示例：
>>> import torch
>>> from transformers import AutoTokenizer, XLNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased")
>>> 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 = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例：
>>> import torch
>>> from transformers import AutoTokenizer, XLNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased", 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 = XLNetForSequenceClassification.from_pretrained(
... "xlnet/xlnet-large-cased", 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).lossXLNetForMultipleChoice
class transformers.XLNetForMultipleChoice
< source >( config: XLNetConfig )
参数
- config (XLNetConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
在顶部带有多项选择分类头的 Xlnet 模型（在池化输出之上添加一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForMultipleChoiceOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length)) — 输入序列 token 在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length), 可选) — 用于指示输入中第一和第二部分的片段标记索引。索引取值范围为[0, 1]:- 0 对应 sentence A 标记，
- 1 对应于 sentence B 标记。
- input_mask (
torch.Tensor形状为batch_size, num_choices, sequence_length, ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。是attention_mask, 的负值，即真实 token 为 0，填充为 1，保留此形式以兼容原始代码库。在
[0, 1]中选择的掩码值：- 1 表示被屏蔽的 token，
- 对于未被屏蔽的 token，值为 0。
您只能使用
input_mask和attention_mask中的一个。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mems (
list[torch.Tensor]长度为config.n_layers) — 包含预计算的隐藏状态（参见mems下方的输出）。可用于加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经被计算过了。use_mems必须设置为True才能使用mems。 - perm_mask (
torch.Tensor形状为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入 token 的注意力模式的掩码，取值范围为[0, 1]:- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 会关注 j； - 如果
perm_mask[k, i, j] = 1，则在批次 k 中，i 不会关注 j。
如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。
- 如果
- target_mapping（形状为
(batch_size, num_predict, sequence_length)的torch.Tensor，可选） — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。 - inputs_embeds (
torch.Tensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels（形状为
(batch_size,)的torch.LongTensor，可选）— 用于计算多选分类损失的标签。索引应在 `[0, …, - use_mems (
bool, 可选) — 是否使用内存状态来加速顺序解码。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
XLNetForMultipleChoiceOutput 或 tuple(torch.Tensor)
一个 XLNetForMultipleChoiceOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（XLNetConfig）和输入。
XLNetForMultipleChoice 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为 (1,) 的
torch.Tensor，可选，在提供labels时返回） — 分类损失。logits（形状为
(batch_size, num_choices)的torch.Tensor）— num_choices 是输入张量的第二维（参见上文中的 input_ids）。分类分数（SoftMax 之前）。
mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。hidden_states (
tuple[torch.Tensor, ...]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple[torch.Tensor, ...]，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoTokenizer, XLNetForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForMultipleChoice.from_pretrained("xlnet/xlnet-large-cased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsXLNetForTokenClassification
class transformers.XLNetForTokenClassification
< source >( config: XLNetConfig )
参数
- config (XLNetConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
Xlnet 转换器，其顶部带有一个用于标记分类的头部（即在隐藏状态输出之上添加一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForTokenClassificationOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 输入序列中各 token 在词表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mems (
list[torch.Tensor]长度为config.n_layers) — 包含预计算的隐藏状态（参见mems下方的输出）。可用于加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经被计算过了。use_mems必须设置为True才能使用mems。 - perm_mask (
torch.Tensor形状为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入 token 的注意力模式的掩码，取值范围为[0, 1]:- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 会关注 j； - 如果
perm_mask[k, i, j] = 1，则在批次 k 中，i 不会关注 j。
如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。
- 如果
- target_mapping（形状为
(batch_size, num_predict, sequence_length)的torch.Tensor，可选） — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。 - token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于指示输入中第一和第二部分的片段标记索引。索引取自[0, 1]:- 0 对应 sentence A 标记，
- 1 对应于 sentence B 标记。
- input_mask (
torch.Tensor形状为batch_size, sequence_length, ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。它是attention_mask, 的负值，即真实 token 为 0，填充为 1，保留此形式以兼容原始代码库。在
[0, 1]中选择的掩码值：- 1 表示被屏蔽的 token，
- 对于未被屏蔽的 token，值为 0。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算多选分类损失的标签。索引应在[0, ..., num_choices]范围内，其中 num_choices 是输入张量第二维的大小（参见上文 input_ids）。 - use_mems (
bool, 可选) — 是否使用内存状态来加速顺序解码。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。用于加速顺序解码的内存状态。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
XLNetForTokenClassificationOutput 或 tuple(torch.Tensor)
一个 XLNetForTokenClassificationOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（XLNetConfig）和输入。
XLNetForTokenClassification 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为
(1,)的torch.Tensor，可选，在提供labels时返回） — 分类损失。logits（形状为
(batch_size, sequence_length, config.num_labels)的torch.Tensor）— 分类分数（SoftMax 之前）。mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。hidden_states (
tuple[torch.Tensor, ...]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple[torch.Tensor, ...]，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoTokenizer, XLNetForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForTokenClassification.from_pretrained("xlnet/xlnet-large-cased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...XLNetForQuestionAnsweringSimple
class transformers.XLNetForQuestionAnsweringSimple
< source >( config: XLNetConfig )
参数
- config (XLNetConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
XLNet 模型，顶部带有用于抽取式问答任务（如 SQuAD）的跨度分类头（在隐藏状态输出之上添加线性层，用于计算 span start logits 和 span end logits）。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestart_positions: typing.Optional[torch.Tensor] = Noneend_positions: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForQuestionAnsweringSimpleOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 输入序列中各 token 在词表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mems (
list[torch.Tensor]长度为config.n_layers) — 包含预计算的隐藏状态（参见mems下方的输出）。可用于加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经被计算过了。use_mems必须设置为True才能使用mems。 - perm_mask (
torch.Tensor形状为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入 token 的注意力模式的掩码，取值范围为[0, 1]:- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 会关注 j； - 如果
perm_mask[k, i, j] = 1，则在批次 k 中，i 不会关注 j。
如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。
- 如果
- target_mapping（形状为
(batch_size, num_predict, sequence_length)的torch.Tensor，可选） — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。 - token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于指示输入中第一和第二部分的片段标记索引。索引取自[0, 1]:- 0 对应 sentence A 标记，
- 1 对应于 sentence B 标记。
- input_mask (
torch.Tensor形状为batch_size, sequence_length, ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。它是attention_mask, 的负值，即真实 token 为 0，填充为 1，保留此形式以兼容原始代码库。在
[0, 1]中选择的掩码值：- 1 表示被屏蔽的 token，
- 对于未被屏蔽的 token，值为 0。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - start_positions (
torch.Tensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标注片段起始位置（索引）的标签。 位置会被截断到序列长度（sequence_length）。序列之外的位置在计算损失时不予考虑。 - end_positions (
torch.Tensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标注片段结束位置（索引）的标签。 位置会被截断到序列长度（sequence_length）。序列之外的位置在计算损失时不予考虑。 - use_mems (
bool, 可选) — 是否使用内存状态来加速顺序解码。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
XLNetForQuestionAnsweringSimpleOutput 或 tuple(torch.Tensor)
一个 XLNetForQuestionAnsweringSimpleOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（XLNetConfig）和输入。
XLNetForQuestionAnsweringSimple 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss (
torch.Tensor，形状为(1,)，可选，当提供labels时返回) — 总跨度提取损失是起始位置和结束位置的交叉熵之和。start_logits（形状为
(batch_size, sequence_length,)的torch.Tensor）— 跨度起始分数（SoftMax 之前）。end_logits（形状为
(batch_size, sequence_length,)的torch.Tensor）— 跨度结束分数（SoftMax 之前）。mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。hidden_states (
tuple[torch.Tensor, ...]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple[torch.Tensor, ...]，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoTokenizer, XLNetForQuestionAnsweringSimple
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForQuestionAnsweringSimple.from_pretrained("xlnet/xlnet-large-cased")
>>> 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)
...XLNetForQuestionAnswering
类 transformers.XLNetForQuestionAnswering
< source >( config: XLNetConfig )
参数
- config (XLNetConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有用于抽取式问答任务（如 SQuAD）的跨度分类头的 Xlnet 变压器（在隐藏状态输出之上添加一个线性层，用于计算 span start logits 和 span end logits）。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestart_positions: typing.Optional[torch.Tensor] = Noneend_positions: typing.Optional[torch.Tensor] = Noneis_impossible: typing.Optional[torch.Tensor] = Nonecls_index: typing.Optional[torch.Tensor] = Nonep_mask: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForQuestionAnsweringOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 输入序列中各 token 在词表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mems (
list[torch.Tensor]长度为config.n_layers) — 包含预计算的隐藏状态（参见mems下方的输出）。可用于加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经被计算过了。use_mems必须设置为True才能使用mems。 - perm_mask (
torch.Tensor形状为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入 token 的注意力模式的掩码，取值范围为[0, 1]:- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 会关注 j； - 如果
perm_mask[k, i, j] = 1，则在批次 k 中，i 不会关注 j。
如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。
- 如果
- target_mapping（形状为
(batch_size, num_predict, sequence_length)的torch.Tensor，可选） — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。 - token_type_ids (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于指示输入中第一和第二部分的片段标记索引。索引取自[0, 1]:- 0 对应 sentence A 标记，
- 1 对应于 sentence B 标记。
- input_mask (
torch.Tensor形状为batch_size, sequence_length, ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。它是attention_mask, 的负值，即真实 token 为 0，填充为 1，保留此形式以兼容原始代码库。在
[0, 1]中选择的掩码值：- 1 表示被屏蔽的 token，
- 对于未被屏蔽的 token，值为 0。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - start_positions (
torch.Tensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标注片段起始位置（索引）的标签。 位置会被截断到序列长度（sequence_length）。序列之外的位置在计算损失时不予考虑。 - end_positions (
torch.Tensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标注片段结束位置（索引）的标签。 位置会被截断到序列长度（sequence_length）。序列之外的位置在计算损失时不予考虑。 - is_impossible (
torch.LongTensor，形状为(batch_size,)，可选) — 标签，指示问题是否有答案或无答案（SQuAD 2.0） - cls_index (
torch.LongTensor，形状为(batch_size,)，可选) — 用于指定分类 token 位置（索引）的标签，作为计算答案合理性的输入。 - p_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 可选的掩码，用于标记不能出现在答案中的 token（例如 [CLS]、[PAD] 等）。1.0 表示该 token 应被掩码，0.0 表示该 token 未被掩码。 - use_mems (
bool, 可选) — 是否使用内存状态来加速顺序解码。如果设置为True，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
XLNetForQuestionAnsweringOutput 或 tuple(torch.Tensor)
一个 XLNetForQuestionAnsweringOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（XLNetConfig）和输入。
XLNetForQuestionAnswering 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss (
torch.Tensor，形状为(1,)，可选，当同时提供start_positions和end_positions时返回) — 分类损失，为起始 token、结束 token（以及如果提供了 is_impossible 则包含其）分类损失的总和。start_top_log_probs (
torch.Tensor，形状为(batch_size, config.start_n_top)，可选，当未提供start_positions或end_positions时返回) — 前 config.start_n_top 个起始 token 可能性的对数概率（束搜索）。start_top_index（形状为
(batch_size, config.start_n_top)的torch.LongTensor，可选，当未提供start_positions或end_positions时返回） — 前 config.start_n_top 个起始 token 候选项的索引（束搜索）。end_top_log_probs (
torch.Tensor，形状为(batch_size, config.start_n_top * config.end_n_top)，可选，当未提供start_positions或end_positions时返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性的对数概率 (beam-search)。end_top_index（形状为
(batch_size, config.start_n_top * config.end_n_top)的torch.LongTensor，可选，当未提供start_positions或end_positions时返回） — 前config.start_n_top * config.end_n_top个结束 token 候选项的索引（束搜索）。cls_logits（形状为
(batch_size,)的torch.Tensor，可选，当未提供start_positions或end_positions时返回） — 答案的is_impossible标签的对数概率。mems（长度为
config.n_layers的list[torch.Tensor]）— 包含预计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将其过去状态提供给该模型的 token id 不应再作为input_ids传入，因为它们已经计算过了。hidden_states (
tuple[torch.Tensor, ...]，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple[torch.Tensor, ...]，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoTokenizer, XLNetForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-base-cased")
>>> model = XLNetForQuestionAnswering.from_pretrained("xlnet/xlnet-base-cased")
>>> input_ids = torch.tensor(tokenizer.encode("Hello, my dog is cute", add_special_tokens=True)).unsqueeze(
... 0
... ) # Batch size 1
>>> start_positions = torch.tensor([1])
>>> end_positions = torch.tensor([3])
>>> outputs = model(input_ids, start_positions=start_positions, end_positions=end_positions)
>>> loss = outputs.loss