# XLNet

## 概述

XLNet 模型由 Zhilin Yang、Zihang Dai、Yiming Yang、Jaime Carbonell、Ruslan Salakhutdinov 和 Quoc V. Le 在 [XLNet: Generalized Autoregressive Pretraining for Language Understanding](https://huggingface.co/papers/1906.08237) 中提出。XLNet 是 Transformer-XL 模型的扩展，它使用自回归方法进行预训练，通过最大化输入序列所有分解顺序排列的期望似然来学习双向上下文。

该论文的摘要如下：

*凭借对双向上下文的建模能力，基于去噪自编码的预训练方法（如 BERT）比基于自回归语言建模的预训练方法取得了更好的性能。然而，由于依赖对输入进行掩码破坏，BERT 忽略了被掩码位置之间的依赖关系，并存在预训练与微调之间的不一致性。鉴于这些优缺点，我们提出了 XLNet，这是一种广义的自回归预训练方法，它（1）通过对分解顺序的所有排列最大化期望似然，从而实现对双向上下文的学习；（2）得益于其自回归形式，克服了 BERT 的局限性。此外，XLNet 将最先进自回归模型 Transformer-XL 的思想整合到了预训练中。在可比的实验设置下，实证结果表明，XLNet 在 20 项任务上优于 BERT，且往往具有显著优势，这些任务包括问答、自然语言推理、情感分析和文档排序。*

该模型由 [thomwolf](https://huggingface.co/thomwolf) 贡献。原始代码可在[此处](https://github.com/zihangdai/xlnet/)找到。

## 使用技巧

- 可以使用 `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 相同的循环机制来构建长期依赖关系。

## 资源

- [文本分类任务指南](../tasks/sequence_classification)
- [Token 分类任务指南](../tasks/token_classification)
- [问答任务指南](../tasks/question_answering)
- [因果语言建模任务指南](../tasks/language_modeling)
- [多项选择任务指南](../tasks/multiple_choice)

## XLNetConfig[[transformers.XLNetConfig]]

#### transformers.XLNetConfig[[transformers.XLNetConfig]]

```python
transformers.XLNetConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, vocab_size: int = 32000, d_model: int = 1024, n_layer: int = 24, n_head: int = 16, d_inner: int = 4096, d_head: int | None = None, ff_activation: str = 'gelu', attn_type: str = 'bi', initializer_range: float = 0.02, layer_norm_eps: float = 1e-12, dropout: float | int = 0.1, mem_len: int | None = 512, reuse_len: int | None = None, use_mems_eval: bool = True, use_mems_train: bool = False, bi_data: bool = False, clamp_len: int = -1, same_length: bool = False, summary_type: str = 'last', summary_use_proj: bool = True, summary_activation: str = 'tanh', summary_last_dropout: float | int = 0.1, start_n_top: int = 5, end_n_top: int = 5, pad_token_id: int | None = 5, bos_token_id: int | None = 1, eos_token_id: int | list[int] | None = 2, tie_word_embeddings: bool = True)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/configuration_xlnet.py#L28)

**参数：**

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 数量。在之前的前向传播中已经预先计算好的键/值对不会被重新计算。更多信息请参阅[快速入门](https://huggingface.co/transformers/quickstart.html#using-the-past)。

reuse_len (`int`, *可选*) : 当前批次中将被缓存并在未来复用的 token 数量。

use_mems_eval (`bool`，*可选*，默认为 `True`)：模型在评估模式下是否应使用循环记忆机制。

use_mems_train (`bool`，*可选*，默认为 `False`)：模型在训练模式下是否应使用循环记忆机制。对于预训练，建议将 `use_mems_train` 设置为 `True`。对于微调，如[此处](https://github.com/zihangdai/xlnet/issues/41#issuecomment-505102587)所述，建议将 `use_mems_train` 设置为 `False`。如果将 `use_mems_train` 设置为 `True`，则必须确保训练批次已正确预处理，*例如* `batch_1 = [[This line is], [This is the]]` 和 `batch_2 = [[ the first line], [ second line]]`，并且所有批次的大小相等。

bi_data (`bool`, *可选*, 默认为 `False`) : 是否使用双向输入管道。通常在预训练期间设置为 `True`，在微调期间设置为 `False`。

clamp_len (`int`，*可选*，默认为 -1)：将所有大于 clamp_len 的相对距离截断为 clamp_len。将此属性设置为 -1 表示不进行截断。

same_length (`bool`，*可选*，默认为 `False`)：是否对每个 token 使用相同的注意力长度。

summary_type (`str`, *可选*, 默认为 "last") : 用于执行序列摘要时的参数。在序列分类和多选模型中使用。必须是以下选项之一： - `"last"`：取最后一个 token 的隐藏状态（如 XLNet）。 - `"first"`：取第一个 token 的隐藏状态（如 BERT）。 - `"mean"`：取所有 token 隐藏状态的均值。 - `"cls_index"`：提供一个分类 token 位置的 Tensor（如 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](https://huggingface.co/xlnet/xlnet-large-cased) 类似的配置。

配置对象继承自 [PreTrainedConfig](/docs/transformers/v5.23.0/zh/main_classes/configuration#transformers.PreTrainedConfig)，可用于控制模型输出。有关更多信息，请参阅 [PreTrainedConfig](/docs/transformers/v5.23.0/zh/main_classes/configuration#transformers.PreTrainedConfig) 的文档。

示例：

```python
>>> 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.config
```

## XLNetTokenizer[[transformers.XLNetTokenizer]]

#### transformers.XLNetTokenizer[[transformers.XLNetTokenizer]]

```python
transformers.XLNetTokenizer(vocab: str | list[tuple[str, float]] | None = None, unk_id: int = 0, do_lower_case = False, remove_space = True, keep_accents = False, bos_token = '<s>', eos_token = '</s>', unk_token = '<unk>', sep_token = '<sep>', pad_token = '<pad>', cls_token = '<cls>', mask_token = '<mask>', _spm_precompiled_charsmap = None, additional_special_tokens = None, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/tokenization_xlnet.py#L38)

**参数：**

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`。

unk_token (`str`，*可选*，默认为 `"<unk>"`)：未知标记。不在词汇表中的标记无法转换为 ID，因此会被设置为该标记。

sep_token (`str`，*可选*，默认为 `"<sep>"`)：分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。

pad_token (`str`，*可选*，默认为 `"<pad>"`)：用于填充的标记，例如在对长度不同的序列进行批处理时。

cls_token (`str`，*可选*，默认为 `"<cls>"`)：用于序列分类（对整个序列进行分类，而非逐 token 分类）的分类器标记。当使用特殊标记构建序列时，它是序列的第一个标记。

mask_token (`str`，*可选*，默认为 `"<mask>"`)：用于掩码值的标记。这是在通过掩码语言建模训练该模型时所使用的标记。模型将尝试预测此标记。

additional_special_tokens (`list[str]`，*可选*，默认为 `["<eop>", "<eod>"]`)：分词器使用的额外特殊标记。

构建一个 XLNet 分词器（基于 HuggingFace 的 *tokenizers* 库）。基于 [Unigram](https://huggingface.co/docs/tokenizers/python/latest/components.html?highlight=unigram#models)。

该分词器继承自 [TokenizersBackend](/docs/transformers/v5.23.0/zh/main_classes/tokenizer#transformers.TokenizersBackend)，其中包含了大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。

#### get_special_tokens_mask[[transformers.XLNetTokenizer.get_special_tokens_mask]]

```python
get_special_tokens_mask(token_ids_0: list[int], token_ids_1: list[int] | None = None, already_has_special_tokens: bool = False)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/tokenization_utils_base.py#L1337)

**参数：**

token_ids_0 : （可能已格式化的）序列的 ID 列表。

token_ids_1 : 当 `already_has_special_tokens=True` 时未使用。在这种情况下，必须为 None。

already_has_special_tokens : 序列是否已使用特殊标记进行格式化。

**返回：** 一个包含 [0, 1] 范围内整数的列表

1 表示特殊标记，0 表示序列标记。

从未添加特殊标记的标记列表中检索序列 ID。

对于快速分词器，数据整理器会传入 `already_has_special_tokens=True` 来调用此方法，以在已格式化的序列上构建掩码。在这种情况下，我们通过检查元素是否属于 `all_special_ids` 来计算掩码。

#### save_vocabulary[[transformers.XLNetTokenizer.save_vocabulary]]

```python
save_vocabulary(save_directory: str, filename_prefix: str | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/tokenization_utils_tokenizers.py#L547)

## XLNet 特定输出[[transformers.models.xlnet.modeling_xlnet.XLNetModelOutput]]

#### transformers.models.xlnet.modeling_xlnet.XLNetModelOutput[[transformers.models.xlnet.modeling_xlnet.XLNetModelOutput]]

```python
transformers.models.xlnet.modeling_xlnet.XLNetModelOutput(last_hidden_state: Tensor, mems: list[torch.Tensor] | None = None, hidden_states: tuple[torch.Tensor, ...] | None = None, attentions: tuple[torch.Tensor, ...] | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L659)

**参数：**

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 (`list[torch.Tensor]`，长度为 `config.n_layers`)：包含预计算的隐藏状态。可用于（参见 `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](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetModel) 的输出类型。

#### transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput[[transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput]]

```python
transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput(loss: typing.Optional[torch.Tensor] = None, logits: typing.Optional[torch.Tensor] = None, mems: list[torch.Tensor] | None = None, hidden_states: tuple[torch.Tensor, ...] | None = None, attentions: tuple[torch.Tensor, ...] | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L684)

**参数：**

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 (`list[torch.Tensor]`，长度为 `config.n_layers`)：包含预计算的隐藏状态。可用于（参见 `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](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetLMHeadModel) 的输出类型。

#### transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput[[transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput]]

```python
transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput(loss: typing.Optional[torch.Tensor] = None, logits: typing.Optional[torch.Tensor] = None, mems: list[torch.Tensor] | None = None, hidden_states: tuple[torch.Tensor, ...] | None = None, attentions: tuple[torch.Tensor, ...] | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L712)

**参数：**

loss (`torch.Tensor`，形状为 `(1,)`，*可选*，在提供 `label` 时返回)：分类损失（如果 config.num_labels==1，则为回归损失）。

logits (`torch.Tensor`，形状为 `(batch_size, config.num_labels)`)：分类（如果 config.num_labels==1 则为回归）得分（SoftMax 之前）。

mems (`list[torch.Tensor]`，长度为 `config.n_layers`)：包含预计算的隐藏状态。可用于（参见 `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 之后的注意力权重，用于在自注意力头中计算加权平均值。

[XLNetForSequenceClassification](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetForSequenceClassification) 的输出类型。

#### transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput[[transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput]]

```python
transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput(loss: typing.Optional[torch.Tensor] = None, logits: typing.Optional[torch.Tensor] = None, mems: list[torch.Tensor] | None = None, hidden_states: tuple[torch.Tensor, ...] | None = None, attentions: tuple[torch.Tensor, ...] | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L762)

**参数：**

loss (`torch.Tensor`，形状为 *(1,)*，*可选*，当提供 `labels` 时返回)：分类损失。

logits (`torch.Tensor`，形状为 `(batch_size, num_choices)`) : *num_choices* 是输入张量的第二个维度（参见上方的 *input_ids*）。分类分数（SoftMax 之前）。

mems (`list[torch.Tensor]`，长度为 `config.n_layers`)：包含预计算的隐藏状态。可用于（参见 `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](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetForMultipleChoice) 的输出类型。

#### transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput[[transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput]]

```python
transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput(loss: typing.Optional[torch.Tensor] = None, logits: typing.Optional[torch.Tensor] = None, mems: list[torch.Tensor] | None = None, hidden_states: tuple[torch.Tensor, ...] | None = None, attentions: tuple[torch.Tensor, ...] | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L737)

**参数：**

loss (`torch.Tensor`，形状为 `(1,)`，*可选*，在提供 `labels` 时返回)：分类损失。

logits (`torch.Tensor`，形状为 `(batch_size, sequence_length, config.num_labels)`)：分类分数（SoftMax 之前）。

mems (`list[torch.Tensor]`，长度为 `config.n_layers`)：包含预计算的隐藏状态。可用于（参见 `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[[transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput]]

```python
transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput(loss: typing.Optional[torch.Tensor] = None, start_logits: typing.Optional[torch.Tensor] = None, end_logits: typing.Optional[torch.Tensor] = None, mems: list[torch.Tensor] | None = None, hidden_states: tuple[torch.Tensor, ...] | None = None, attentions: tuple[torch.Tensor, ...] | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L789)

**参数：**

loss (`torch.Tensor`，形状为 `(1,)`，*可选*，在提供 `labels` 时返回)：总跨度提取损失是起始位置和结束位置的交叉熵之和。

start_logits (`torch.Tensor`，形状为 `(batch_size, sequence_length,)`)：跨度起始分数（SoftMax 之前）。

end_logits (`torch.Tensor`，形状为 `(batch_size, sequence_length,)`)：跨度结束分数（SoftMax 之前）。

mems (`list[torch.Tensor]`，长度为 `config.n_layers`)：包含预计算的隐藏状态。可用于（参见 `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 之后的注意力权重，用于在自注意力头中计算加权平均值。

[XLNetForQuestionAnsweringSimple](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetForQuestionAnsweringSimple) 的输出类型。

#### transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput[[transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput]]

```python
transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput(loss: typing.Optional[torch.Tensor] = None, start_top_log_probs: typing.Optional[torch.Tensor] = None, start_top_index: typing.Optional[torch.LongTensor] = None, end_top_log_probs: typing.Optional[torch.Tensor] = None, end_top_index: typing.Optional[torch.LongTensor] = None, cls_logits: typing.Optional[torch.Tensor] = None, mems: list[torch.Tensor] | None = None, hidden_states: tuple[torch.Tensor, ...] | None = None, attentions: tuple[torch.Tensor, ...] | None = None)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L817)

**参数：**

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 (`torch.LongTensor`，形状为 `(batch_size, config.start_n_top)`，*可选*，当未提供 `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 (`torch.LongTensor`，形状为 `(batch_size, config.start_n_top * config.end_n_top)`，*可选*，在 `start_positions` 或 `end_positions` 未提供时返回)：前 `config.start_n_top * config.end_n_top` 个结束 token 可能性（束搜索）的索引。

cls_logits (`torch.Tensor`，形状为 `(batch_size,)`，*可选*，当未提供 `start_positions` 或 `end_positions` 时返回)：答案的 `is_impossible` 标签的对数概率。

mems (`list[torch.Tensor]`，长度为 `config.n_layers`)：包含预计算的隐藏状态。可用于（参见 `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](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetForQuestionAnswering) 的输出类型。

## XLNetModel[[transformers.XLNetModel]]

#### transformers.XLNetModel[[transformers.XLNetModel]]

```python
transformers.XLNetModel(config: XLNetConfig)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L851)

**参数：**

config ([XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig))：包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。请查看 [from_pretrained()](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel.from_pretrained) 方法以加载模型权重。

未附加任何特定头部的裸 Xlnet 模型，输出原始的隐藏状态。

该模型继承自 [PreTrainedModel](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel)。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

该模型也是 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) 的子类。请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。

#### forward[[transformers.XLNetModel.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, mems: typing.Optional[torch.Tensor] = None, perm_mask: typing.Optional[torch.Tensor] = None, target_mapping: typing.Optional[torch.Tensor] = None, token_type_ids: typing.Optional[torch.Tensor] = None, input_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, use_mems: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L976)

**参数：**

input_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：输入序列中各个 token 在词汇表中的索引。默认情况下，填充（padding）会被忽略。可以使用 [AutoTokenizer](/docs/transformers/v5.23.0/zh/model_doc/auto#transformers.AutoTokenizer) 获取这些索引。有关详细信息，请参阅 [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 和 [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)。[什么是输入 ID？](../glossary#input-ids)

attention_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。掩码值取自 `[0, 1]`： - 1 表示**未掩码**的标记， - 0 表示**已掩码**的标记。 [什么是注意力掩码？](../glossary#attention-mask)

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 中，token i 关注 token j； - 如果 `perm_mask[k, i, j] = 1`，则在批次 k 中，token i 不关注 token j。 如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。

target_mapping (`torch.Tensor`，形状为 `(batch_size, num_predict, sequence_length)`，*可选*)：用于指示要使用的输出 token 的掩码。如果 `target_mapping[k, i, j] = 1`，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。

token_type_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于指示输入中第一和第二部分的段标记索引。索引取自 `[0, 1]`： - 0 对应 *句子 A* 的标记， - 1 对应 *句子 B* 的标记。 [什么是标记类型 ID？](../glossary#token-type-ids)

input_mask (`torch.Tensor`，形状为 `batch_size, sequence_length`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。它是 `attention_mask` 的负值，即真实标记为 0，填充标记为 1，此设计是为了与原始代码库保持兼容。  `[0, 1]` 中选择的掩码值：  - 1 表示**被掩码**的标记， - 0 表示**未被掩码**的标记。  您只能使用 `input_mask` 和 `attention_mask` 中的一个。

inputs_embeds (`torch.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`，*可选*)：可选地，你可以选择直接传入嵌入表示，而不是传入 `input_ids`。如果你希望比模型内部的嵌入查找矩阵更精细地控制如何将 `input_ids` 索引转换为对应的向量，这将非常有用。

use_mems (`bool`, *可选*) : 是否使用内存状态来加速顺序解码。如果设置为 `True`，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。

output_attentions (`bool`, *可选*) : 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 `attentions`。

output_hidden_states (`bool`, *可选*) : 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 `hidden_states`。

return_dict (`bool`, *可选*) : 是否返回 [ModelOutput](/docs/transformers/v5.23.0/zh/main_classes/output#transformers.utils.ModelOutput) 而不是普通元组。

**返回：** [XLNetModelOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetModelOutput) 或 `tuple(torch.Tensor)`

一个 [XLNetModelOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetModelOutput) 或 `torch.Tensor` 元组（如果传入了 `return_dict=False` 或 `config.return_dict=False`），其包含的元素取决于配置（[XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig)）和输入。

[XLNetModel](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.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[[transformers.XLNetLMHeadModel]]

#### transformers.XLNetLMHeadModel[[transformers.XLNetLMHeadModel]]

```python
transformers.XLNetLMHeadModel(config: XLNetConfig)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1215)

**参数：**

config ([XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig))：包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。请查看 [from_pretrained()](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel.from_pretrained) 方法以加载模型权重。

在顶部带有语言建模头（线性层，其权重与输入嵌入共享）的 XLNet 模型。

该模型继承自 [PreTrainedModel](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel)。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

该模型也是 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) 的子类。请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。

#### forward[[transformers.XLNetLMHeadModel.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, mems: typing.Optional[torch.Tensor] = None, perm_mask: typing.Optional[torch.Tensor] = None, target_mapping: typing.Optional[torch.Tensor] = None, token_type_ids: typing.Optional[torch.Tensor] = None, input_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.Tensor] = None, use_mems: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, logits_to_keep: typing.Union[int, torch.Tensor] = 0, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1290)

**参数：**

input_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：输入序列中各个 token 在词汇表中的索引。默认情况下，填充（padding）会被忽略。可以使用 [AutoTokenizer](/docs/transformers/v5.23.0/zh/model_doc/auto#transformers.AutoTokenizer) 获取这些索引。有关详细信息，请参阅 [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 和 [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)。[什么是输入 ID？](../glossary#input-ids)

attention_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。掩码值取自 `[0, 1]`： - 1 表示**未掩码**的标记， - 0 表示**已掩码**的标记。 [什么是注意力掩码？](../glossary#attention-mask)

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 中，token i 关注 token j； - 如果 `perm_mask[k, i, j] = 1`，则在批次 k 中，token i 不关注 token j。 如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。

target_mapping (`torch.Tensor`，形状为 `(batch_size, num_predict, sequence_length)`，*可选*)：用于指示要使用的输出 token 的掩码。如果 `target_mapping[k, i, j] = 1`，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。

token_type_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于指示输入中第一和第二部分的段标记索引。索引取自 `[0, 1]`： - 0 对应 *句子 A* 的标记， - 1 对应 *句子 B* 的标记。 [什么是标记类型 ID？](../glossary#token-type-ids)

input_mask (`torch.Tensor`，形状为 `batch_size, sequence_length`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。它是 `attention_mask` 的负值，即真实标记为 0，填充标记为 1，此设计是为了与原始代码库保持兼容。  `[0, 1]` 中选择的掩码值：  - 1 表示**被掩码**的标记， - 0 表示**未被掩码**的标记。  您只能使用 `input_mask` 和 `attention_mask` 中的一个。

inputs_embeds (`torch.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`，*可选*)：可选地，你可以选择直接传入嵌入表示，而不是传入 `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` 中添加 ** 标记（参见 `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](/docs/transformers/v5.23.0/zh/main_classes/output#transformers.utils.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](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput) 或 `tuple(torch.Tensor)`

一个 [XLNetLMHeadModelOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput) 或 `torch.Tensor` 元组（如果传入了 `return_dict=False` 或 `config.return_dict=False`），其包含的元素取决于配置（[XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig)）和输入。

[XLNetLMHeadModel](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetLMHeadModel) 的 forward 方法重写了 `__call__` 特殊方法。

尽管前向传播的实现需要在此函数中定义，但之后应调用 `Module` 实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者会静默地忽略这些步骤。

- **loss** (`torch.Tensor`，形状为 *(1,)*，*可选*，当提供 `labels` 时返回) -- 语言建模损失（用于下一个 token 预测）。
- **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 后的注意力权重，用于在自注意力头中计算加权平均值。

示例：

```python
>>> 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[[transformers.XLNetForSequenceClassification]]

#### transformers.XLNetForSequenceClassification[[transformers.XLNetForSequenceClassification]]

```python
transformers.XLNetForSequenceClassification(config: XLNetConfig)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1462)

**参数：**

config ([XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig))：包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。请查看 [from_pretrained()](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel.from_pretrained) 方法以加载模型权重。

在顶部带有序列分类/回归头（即位于池化输出之上的线性层）的 XLNet 模型，例如用于 GLUE 任务。

该模型继承自 [PreTrainedModel](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel)。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

该模型也是 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) 的子类。请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。

#### forward[[transformers.XLNetForSequenceClassification.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, mems: typing.Optional[torch.Tensor] = None, perm_mask: typing.Optional[torch.Tensor] = None, target_mapping: typing.Optional[torch.Tensor] = None, token_type_ids: typing.Optional[torch.Tensor] = None, input_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.Tensor] = None, use_mems: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1475)

**参数：**

input_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：输入序列中各个 token 在词汇表中的索引。默认情况下，填充（padding）会被忽略。可以使用 [AutoTokenizer](/docs/transformers/v5.23.0/zh/model_doc/auto#transformers.AutoTokenizer) 获取这些索引。有关详细信息，请参阅 [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 和 [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)。[什么是输入 ID？](../glossary#input-ids)

attention_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。掩码值取自 `[0, 1]`： - 1 表示**未掩码**的标记， - 0 表示**已掩码**的标记。 [什么是注意力掩码？](../glossary#attention-mask)

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 中，token i 关注 token j； - 如果 `perm_mask[k, i, j] = 1`，则在批次 k 中，token i 不关注 token j。 如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。

target_mapping (`torch.Tensor`，形状为 `(batch_size, num_predict, sequence_length)`，*可选*)：用于指示要使用的输出 token 的掩码。如果 `target_mapping[k, i, j] = 1`，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。

token_type_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于指示输入中第一和第二部分的段标记索引。索引取自 `[0, 1]`： - 0 对应 *句子 A* 的标记， - 1 对应 *句子 B* 的标记。 [什么是标记类型 ID？](../glossary#token-type-ids)

input_mask (`torch.Tensor`，形状为 `batch_size, sequence_length`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。它是 `attention_mask` 的负值，即真实标记为 0，填充标记为 1，此设计是为了与原始代码库保持兼容。  `[0, 1]` 中选择的掩码值：  - 1 表示**被掩码**的标记， - 0 表示**未被掩码**的标记。  您只能使用 `input_mask` 和 `attention_mask` 中的一个。

inputs_embeds (`torch.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`，*可选*)：可选地，你可以选择直接传入嵌入表示，而不是传入 `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](/docs/transformers/v5.23.0/zh/main_classes/output#transformers.utils.ModelOutput) 而不是普通元组。

**返回：** [XLNetForSequenceClassificationOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput) 或 `tuple(torch.Tensor)`

一个 [XLNetForSequenceClassificationOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput) 或 `torch.Tensor` 元组（如果传入了 `return_dict=False` 或 `config.return_dict=False`），其包含的元素取决于配置（[XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig)）和输入。

[XLNetForSequenceClassification](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.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 后的注意力权重，用于在自注意力头中计算加权平均值。

单标签分类示例：

```python
>>> 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)
...
```

多标签分类示例：

```python
>>> 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).loss
```

## XLNetForMultipleChoice[[transformers.XLNetForMultipleChoice]]

#### transformers.XLNetForMultipleChoice[[transformers.XLNetForMultipleChoice]]

```python
transformers.XLNetForMultipleChoice(config: XLNetConfig)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1694)

**参数：**

config ([XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig))：包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。请查看 [from_pretrained()](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel.from_pretrained) 方法以加载模型权重。

在顶部带有多项选择分类头的 Xlnet 模型（在池化输出之上添加一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。

该模型继承自 [PreTrainedModel](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel)。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

该模型也是 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) 的子类。请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。

#### forward[[transformers.XLNetForMultipleChoice.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, token_type_ids: typing.Optional[torch.Tensor] = None, input_mask: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, mems: typing.Optional[torch.Tensor] = None, perm_mask: typing.Optional[torch.Tensor] = None, target_mapping: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.Tensor] = None, use_mems: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1705)

**参数：**

input_ids (`torch.LongTensor`，形状为 `(batch_size, num_choices, sequence_length)`)：输入序列标记在词汇表中的索引。可以使用 [AutoTokenizer](/docs/transformers/v5.23.0/zh/model_doc/auto#transformers.AutoTokenizer) 获取索引。有关详细信息，请参阅 [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 和 [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)。[什么是输入 ID？](../glossary#input-ids)

token_type_ids (`torch.LongTensor`，形状为 `(batch_size, num_choices, sequence_length)`，*可选*)：用于指示输入中第一和第二部分的片段令牌索引。索引选自 `[0, 1]`： - 0 对应 *句子 A* 令牌， - 1 对应 *句子 B* 令牌。 [什么是令牌类型 ID？](../glossary#token-type-ids)

input_mask (`torch.Tensor`，形状为 `batch_size, num_choices, sequence_length`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。它是 `attention_mask` 的负值，即真实标记为 0，填充标记为 1，此设计是为了与原始代码库保持兼容。  `[0, 1]` 中选择的掩码值：  - 1 表示**被掩码**的标记， - 0 表示**未被掩码**的标记。  您只能使用 `input_mask` 和 `attention_mask` 中的一个。

attention_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。掩码值取自 `[0, 1]`： - 1 表示**未掩码**的标记， - 0 表示**已掩码**的标记。 [什么是注意力掩码？](../glossary#attention-mask)

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 中，token i 关注 token j； - 如果 `perm_mask[k, i, j] = 1`，则在批次 k 中，token i 不关注 token j。 如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。

target_mapping (`torch.Tensor`，形状为 `(batch_size, num_predict, sequence_length)`，*可选*)：用于指示要使用的输出 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 (`torch.LongTensor`，形状为 `(batch_size,)`，*可选*)：用于计算多选分类损失的标签。索引应在 `[0, ...,

use_mems (`bool`, *可选*) : 是否使用内存状态来加速顺序解码。如果设置为 `True`，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。

output_attentions (`bool`, *可选*) : 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 `attentions`。

output_hidden_states (`bool`, *可选*) : 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 `hidden_states`。

return_dict (`bool`, *可选*) : 是否返回 [ModelOutput](/docs/transformers/v5.23.0/zh/main_classes/output#transformers.utils.ModelOutput) 而不是普通元组。

**返回：** [XLNetForMultipleChoiceOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput) 或 `tuple(torch.Tensor)`

一个 [XLNetForMultipleChoiceOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput) 或 `torch.Tensor` 元组（如果传入了 `return_dict=False` 或 `config.return_dict=False`），其包含的元素取决于配置（[XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig)）和输入。

[XLNetForMultipleChoice](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.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 后的注意力权重，用于在自注意力头中计算加权平均值。

示例：

```python
>>> 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.logits
```

## XLNetForTokenClassification[[transformers.XLNetForTokenClassification]]

#### transformers.XLNetForTokenClassification[[transformers.XLNetForTokenClassification]]

```python
transformers.XLNetForTokenClassification(config: XLNetConfig)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1586)

**参数：**

config ([XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig))：包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。请查看 [from_pretrained()](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel.from_pretrained) 方法以加载模型权重。

在 Xlnet 转换器顶部添加了一个用于令牌分类的头部（即在隐藏状态输出之上添加了一个线性层），例如用于命名实体识别（NER）任务。

该模型继承自 [PreTrainedModel](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel)。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

该模型也是 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) 的子类。请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。

#### forward[[transformers.XLNetForTokenClassification.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, mems: typing.Optional[torch.Tensor] = None, perm_mask: typing.Optional[torch.Tensor] = None, target_mapping: typing.Optional[torch.Tensor] = None, token_type_ids: typing.Optional[torch.Tensor] = None, input_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.Tensor] = None, use_mems: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1597)

**参数：**

input_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：输入序列中各个 token 在词汇表中的索引。默认情况下，填充（padding）会被忽略。可以使用 [AutoTokenizer](/docs/transformers/v5.23.0/zh/model_doc/auto#transformers.AutoTokenizer) 获取这些索引。有关详细信息，请参阅 [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 和 [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)。[什么是输入 ID？](../glossary#input-ids)

attention_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。掩码值取自 `[0, 1]`： - 1 表示**未掩码**的标记， - 0 表示**已掩码**的标记。 [什么是注意力掩码？](../glossary#attention-mask)

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 中，token i 关注 token j； - 如果 `perm_mask[k, i, j] = 1`，则在批次 k 中，token i 不关注 token j。 如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。

target_mapping (`torch.Tensor`，形状为 `(batch_size, num_predict, sequence_length)`，*可选*)：用于指示要使用的输出 token 的掩码。如果 `target_mapping[k, i, j] = 1`，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。

token_type_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于指示输入中第一和第二部分的段标记索引。索引取自 `[0, 1]`： - 0 对应 *句子 A* 的标记， - 1 对应 *句子 B* 的标记。 [什么是标记类型 ID？](../glossary#token-type-ids)

input_mask (`torch.Tensor`，形状为 `batch_size, sequence_length`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。它是 `attention_mask` 的负值，即真实标记为 0，填充标记为 1，此设计是为了与原始代码库保持兼容。  `[0, 1]` 中选择的掩码值：  - 1 表示**被掩码**的标记， - 0 表示**未被掩码**的标记。  您只能使用 `input_mask` 和 `attention_mask` 中的一个。

inputs_embeds (`torch.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`，*可选*)：可选地，你可以选择直接传入嵌入表示，而不是传入 `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](/docs/transformers/v5.23.0/zh/main_classes/output#transformers.utils.ModelOutput) 而不是普通元组。

**返回：** [XLNetForTokenClassificationOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput) 或 `tuple(torch.Tensor)`

一个 [XLNetForTokenClassificationOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput) 或 `torch.Tensor` 元组（如果传入了 `return_dict=False` 或 `config.return_dict=False`），其包含的元素取决于配置（[XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig)）和输入。

[XLNetForTokenClassification](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetForTokenClassification) 的 forward 方法重写了 `__call__` 特殊方法。

尽管前向传播的实现需要在此函数中定义，但之后应调用 `Module` 实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者会静默地忽略这些步骤。

- **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 后的注意力权重，用于在自注意力头中计算加权平均值。

示例：

```python
>>> 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[[transformers.XLNetForQuestionAnsweringSimple]]

#### transformers.XLNetForQuestionAnsweringSimple[[transformers.XLNetForQuestionAnsweringSimple]]

```python
transformers.XLNetForQuestionAnsweringSimple(config: XLNetConfig)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1838)

**参数：**

config ([XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig))：包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。请查看 [from_pretrained()](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel.from_pretrained) 方法以加载模型权重。

用于 SQuAD 等抽取式问答任务的 XLNet 模型，其顶部带有跨度分类头（在隐藏状态输出之上添加一个线性层，用于计算`span start logits`和`span end logits`）。

该模型继承自 [PreTrainedModel](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel)。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

该模型也是 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) 的子类。请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。

#### forward[[transformers.XLNetForQuestionAnsweringSimple.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, mems: typing.Optional[torch.Tensor] = None, perm_mask: typing.Optional[torch.Tensor] = None, target_mapping: typing.Optional[torch.Tensor] = None, token_type_ids: typing.Optional[torch.Tensor] = None, input_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, start_positions: typing.Optional[torch.Tensor] = None, end_positions: typing.Optional[torch.Tensor] = None, use_mems: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1849)

**参数：**

input_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：输入序列中各个 token 在词汇表中的索引。默认情况下，填充（padding）会被忽略。可以使用 [AutoTokenizer](/docs/transformers/v5.23.0/zh/model_doc/auto#transformers.AutoTokenizer) 获取这些索引。有关详细信息，请参阅 [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 和 [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)。[什么是输入 ID？](../glossary#input-ids)

attention_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。掩码值取自 `[0, 1]`： - 1 表示**未掩码**的标记， - 0 表示**已掩码**的标记。 [什么是注意力掩码？](../glossary#attention-mask)

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 中，token i 关注 token j； - 如果 `perm_mask[k, i, j] = 1`，则在批次 k 中，token i 不关注 token j。 如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。

target_mapping (`torch.Tensor`，形状为 `(batch_size, num_predict, sequence_length)`，*可选*)：用于指示要使用的输出 token 的掩码。如果 `target_mapping[k, i, j] = 1`，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。

token_type_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于指示输入中第一和第二部分的段标记索引。索引取自 `[0, 1]`： - 0 对应 *句子 A* 的标记， - 1 对应 *句子 B* 的标记。 [什么是标记类型 ID？](../glossary#token-type-ids)

input_mask (`torch.Tensor`，形状为 `batch_size, sequence_length`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。它是 `attention_mask` 的负值，即真实标记为 0，填充标记为 1，此设计是为了与原始代码库保持兼容。  `[0, 1]` 中选择的掩码值：  - 1 表示**被掩码**的标记， - 0 表示**未被掩码**的标记。  您只能使用 `input_mask` 和 `attention_mask` 中的一个。

inputs_embeds (`torch.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`，*可选*)：可选地，你可以选择直接传入嵌入表示，而不是传入 `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](/docs/transformers/v5.23.0/zh/main_classes/output#transformers.utils.ModelOutput) 而不是普通元组。

**返回：** [XLNetForQuestionAnsweringSimpleOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput) 或 `tuple(torch.Tensor)`

一个 [XLNetForQuestionAnsweringSimpleOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput) 或 `torch.Tensor` 元组（如果传入了 `return_dict=False` 或 `config.return_dict=False`），其包含的元素取决于配置（[XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig)）和输入。

[XLNetForQuestionAnsweringSimple](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.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 后的注意力权重，用于在自注意力头中计算加权平均值。

示例：

```python
>>> 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]]

#### transformers.XLNetForQuestionAnswering[[transformers.XLNetForQuestionAnswering]]

```python
transformers.XLNetForQuestionAnswering(config: XLNetConfig)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1959)

**参数：**

config ([XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig))：包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。请查看 [from_pretrained()](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel.from_pretrained) 方法以加载模型权重。

带有用于抽取式问答任务（如 SQuAD）的跨度分类头的 Xlnet 变压器（在隐藏状态输出之上添加一个线性层，用于计算`span start logits`和`span end logits`）。

该模型继承自 [PreTrainedModel](/docs/transformers/v5.23.0/zh/main_classes/model#transformers.PreTrainedModel)。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

该模型也是 PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) 的子类。请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。

#### forward[[transformers.XLNetForQuestionAnswering.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, mems: typing.Optional[torch.Tensor] = None, perm_mask: typing.Optional[torch.Tensor] = None, target_mapping: typing.Optional[torch.Tensor] = None, token_type_ids: typing.Optional[torch.Tensor] = None, input_mask: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, start_positions: typing.Optional[torch.Tensor] = None, end_positions: typing.Optional[torch.Tensor] = None, is_impossible: typing.Optional[torch.Tensor] = None, cls_index: typing.Optional[torch.Tensor] = None, p_mask: typing.Optional[torch.Tensor] = None, use_mems: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, **kwargs)
```

[来源](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/xlnet/modeling_xlnet.py#L1973)

**参数：**

input_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：输入序列中各个 token 在词汇表中的索引。默认情况下，填充（padding）会被忽略。可以使用 [AutoTokenizer](/docs/transformers/v5.23.0/zh/model_doc/auto#transformers.AutoTokenizer) 获取这些索引。有关详细信息，请参阅 [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) 和 [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/zh/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__)。[什么是输入 ID？](../glossary#input-ids)

attention_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。掩码值取自 `[0, 1]`： - 1 表示**未掩码**的标记， - 0 表示**已掩码**的标记。 [什么是注意力掩码？](../glossary#attention-mask)

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 中，token i 关注 token j； - 如果 `perm_mask[k, i, j] = 1`，则在批次 k 中，token i 不关注 token j。 如果未设置，则每个 token 都会关注所有其他 token（完全双向注意力）。仅在预训练（用于定义分解顺序）或顺序解码（生成）期间使用。

target_mapping (`torch.Tensor`，形状为 `(batch_size, num_predict, sequence_length)`，*可选*)：用于指示要使用的输出 token 的掩码。如果 `target_mapping[k, i, j] = 1`，则批次 k 中的第 i 个预测对应于第 j 个 token。仅在预训练期间用于部分预测或顺序解码（生成）。

token_type_ids (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：用于指示输入中第一和第二部分的段标记索引。索引取自 `[0, 1]`： - 0 对应 *句子 A* 的标记， - 1 对应 *句子 B* 的标记。 [什么是标记类型 ID？](../glossary#token-type-ids)

input_mask (`torch.Tensor`，形状为 `batch_size, sequence_length`，*可选*)：用于避免对填充（padding）标记索引执行注意力机制的掩码。它是 `attention_mask` 的负值，即真实标记为 0，填充标记为 1，此设计是为了与原始代码库保持兼容。  `[0, 1]` 中选择的掩码值：  - 1 表示**被掩码**的标记， - 0 表示**未被掩码**的标记。  您只能使用 `input_mask` 和 `attention_mask` 中的一个。

inputs_embeds (`torch.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`，*可选*)：可选地，你可以选择直接传入嵌入表示，而不是传入 `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,)`，*可选*)：用于计算答案合理性的分类标记的位置（索引）标签。

p_mask (`torch.Tensor`，形状为 `(batch_size, sequence_length)`，*可选*)：可选的标记掩码，用于指示哪些标记不能出现在答案中（例如 [CLS]、[PAD] 等）。1.0 表示该标记应被掩码，0.0 表示该标记未被掩码。

use_mems (`bool`, *可选*) : 是否使用内存状态来加速顺序解码。如果设置为 `True`，模型将使用之前前向传播中的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。

output_attentions (`bool`, *可选*) : 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 `attentions`。

output_hidden_states (`bool`, *可选*) : 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 `hidden_states`。

return_dict (`bool`, *可选*) : 是否返回 [ModelOutput](/docs/transformers/v5.23.0/zh/main_classes/output#transformers.utils.ModelOutput) 而不是普通元组。

**返回：** [XLNetForQuestionAnsweringOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput) 或 `tuple(torch.Tensor)`

一个 [XLNetForQuestionAnsweringOutput](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput) 或 `torch.Tensor` 元组（如果传入了 `return_dict=False` 或 `config.return_dict=False`），其包含的元素取决于配置（[XLNetConfig](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.XLNetConfig)）和输入。

[XLNetForQuestionAnswering](/docs/transformers/v5.23.0/zh/model_doc/xlnet#transformers.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** (`torch.LongTensor`，形状为 `(batch_size, config.start_n_top)`，*可选*，当未提供 `start_positions` 或 `end_positions` 时返回) -- 前 config.start_n_top 个起始 token 候选项的索引（束搜索）。
- **end_top_log_probs**（形状为 `(batch_size, config.start_n_top * config.end_n_top)` 的 `torch.Tensor`，*可选*，当未提供 `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 后的注意力权重，用于在自注意力头中计算加权平均值。

示例：

```python
>>> 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
```

