Transformers 文档
XLNet
并获得增强的文档体验
开始使用
此模型于 2019-06-19 发布，并于 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，通常优势明显，包括问答、自然语言推理、情感分析和文档排名。
此模型由 thomwolf 贡献。原始代码可在 此处 找到。
使用技巧
- 可以使用
perm_mask输入在训练和测试时控制特定的注意力模式。 - 由于在不同的分解顺序上训练一个完全自回归模型存在困难，XLNet 在预训练时仅使用输出令牌的一个子集作为目标，这些令牌通过
target_mapping输入进行选择。 - 要将 XLNet 用于顺序解码（即非完全双向设置），请使用
perm_mask和target_mapping输入来控制注意力跨度和输出（请参阅 *examples/pytorch/text-generation/run_generation.py* 中的示例）。 - XLNet 是少数没有序列长度限制的模型之一。
- XLNet 不是传统的自回归模型，但使用了基于自回归的训练策略。它对句子中的令牌进行排列，然后允许模型使用前 n 个令牌来预测第 n+1 个令牌。由于这一切都是通过掩码完成的，句子实际上是以正确的顺序馈入模型的，但 XLNet 不会像 n+1 那样掩盖前 n 个令牌，而是使用一个掩码来隐藏给定排列 1,…,序列长度中的先前令牌。
- XLNet 还使用与 Transformer-XL 相同的循环机制来构建长期依赖关系。
资源
XLNetConfig
class transformers.XLNetConfig
< source >( vocab_size = 32000 d_model = 1024 n_layer = 24 n_head = 16 d_inner = 4096 ff_activation = 'gelu' attn_type = 'bi' initializer_range = 0.02 layer_norm_eps = 1e-12 dropout = 0.1 mem_len = 512 reuse_len = None use_mems_eval = True use_mems_train = False bi_data = False clamp_len = -1 same_length = False summary_type = 'last' summary_use_proj = True summary_activation = 'tanh' summary_last_dropout = 0.1 start_n_top = 5 end_n_top = 5 pad_token_id = 5 bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = True **kwargs )
参数
- vocab_size (
int, optional, defaults to 32000) — XLNet 模型的词汇表大小。定义了调用 XLNetModel 时传入的inputs_ids可以表示的不同令牌的数量。 - d_model (
int, optional, defaults to 1024) — 编码器层和池化层的维度。 - n_layer (
int, optional, defaults to 24) — Transformer 编码器中的隐藏层数量。 - n_head (
int, optional, defaults to 16) — Transformer 编码器中每个注意力层的注意力头数量。 - d_inner (
int, optional, defaults to 4096) — Transformer 编码器中“中间”（通常称为前馈）层的维度。 - ff_activation (
strorCallable, optional, defaults to"gelu") — 非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - attn_type (
str, optional, defaults to"bi") — 模型使用的注意力类型。XLNet 设置为"bi"，Transformer-XL 设置为"uni"。 - initializer_range (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-12) — 层归一化层使用的 epsilon。 - dropout (
float, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。 - mem_len (
intorNone, optional) — 要缓存的令牌数量。在前一个正向传递中已预先计算的键/值对将不会重新计算。有关更多信息，请参阅 quickstart。 - reuse_len (
int, optional) — 当前批次中要缓存并在将来重用的令牌数量。 - bi_data (
bool, optional, defaults toFalse) — 是否使用双向输入管道。通常在预训练期间设置为True，在微调期间设置为False。 - clamp_len (
int, optional, defaults to -1) — 钳制所有大于 clamp_len 的相对距离。将此属性设置为 -1 表示不进行钳制。 - same_length (
bool, optional, defaults toFalse) — 是否对每个令牌使用相同的注意力长度。 - summary_type (
str, optional, defaults to “last”) — 进行序列摘要时使用的参数。用于序列分类和多项选择模型。必须是以下选项之一：
"last"：获取最后一个令牌隐藏状态（如 XLNet）。"first"：获取第一个令牌隐藏状态（如 BERT）。"mean"：获取所有令牌隐藏状态的平均值。"cls_index"：提供分类令牌位置的 Tensor（如 GPT/GPT-2）。"attn"：目前未实现，使用多头注意力。
- summary_use_proj (
bool, optional, defaults toTrue) — 进行序列摘要时使用的参数。用于序列分类和多项选择模型。向量提取后是否添加投影。
- summary_activation (
str, optional) — 进行序列摘要时使用的参数。用于序列分类和多项选择模型。传入
"tanh"以对输出应用 tanh 激活函数，任何其他值将导致不应用激活函数。 - summary_proj_to_labels (
boo, optional, defaults toTrue) — 用于序列分类和多项选择模型。投影输出应具有
config.num_labels类还是config.hidden_size类。 - summary_last_dropout (
float, optional, defaults to 0.1) — 用于序列分类和多项选择模型。在投影和激活之后使用的丢弃率。
- start_n_top (
int, optional, defaults to 5) — SQuAD 评估脚本中使用的参数。 - end_n_top (
int, optional, defaults to 5) — 用于 SQuAD 评估脚本。 - use_mems_eval (
bool, optional, defaults toTrue) — 模型在评估模式下是否应使用循环记忆机制。 - use_mems_train (
bool, optional, defaults toFalse) — 模型在训练模式下是否应使用循环记忆机制。对于预训练，建议将
use_mems_train设置为True。对于微调，建议将use_mems_train设置为False，如此处所讨论。如果将use_mems_train设置为True，则必须确保训练批次已正确预处理，例如batch_1 = [[This line is], [This is the]]和batch_2 = [[ the first line], [ second line]]，并且所有批次的大小都相等。
这是用于存储 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
class transformers.XLNetTokenizer
< source >( 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>' additional_special_tokens = None **kwargs )
参数
- vocab (
list of tuples, optional) — Unigram 模型的 (token, score) 元组列表。如果未提供，则使用空列表。 - unk_id (
int, optional, defaults to 0) — 词汇表中未知标记的 ID。 - do_lower_case (
bool, optional, defaults toFalse) — 对输入进行分词时是否转换为小写。 - remove_space (
bool, optional, defaults toTrue) — 分词时是否去除文本中的空格（删除字符串开头和结尾多余的空格）。 - keep_accents (
bool, optional, defaults toFalse) — 分词时是否保留重音符号。 - bos_token (
str, optional, defaults to"<s>") — 预训练期间使用的序列开始标记。可用作序列分类标记。使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - eos_token (
str, optional, defaults to"</s>") — 序列结束标记。使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是
sep_token。 - unk_token (
str, optional, defaults to"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，并被设置为此标记。 - sep_token (
str, optional, defaults to"<sep>") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, optional, defaults to"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - cls_token (
str, optional, defaults to"<cls>") — 分类器标记，用于进行序列分类（对整个序列进行分类，而不是按标记进行分类）。它是在使用特殊标记构建序列时的第一个标记。 - mask_token (
str, optional, defaults to"<mask>") — 用于掩盖值的标记。在对模型进行掩码语言建模训练时使用此标记。模型将尝试预测此标记。 - additional_special_tokens (
list[str], optional, defaults to["<eop>", "<eod>"]) — 分词器使用的额外特殊标记。
构建 XLNet 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 Unigram。
此分词器继承自 TokenizersBackend，其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
get_special_tokens_mask
< source >( token_ids_0: list[int] token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → 一个介于 0 和 1 之间的整数列表
Retrieve sequence ids from a token list that has no special tokens added.
For fast tokenizers, data collators call this with already_has_special_tokens=True to build a mask over an already-formatted sequence. In that case, we compute the mask by checking membership in all_special_ids.
XLNetTokenizerFast
class transformers.XLNetTokenizer
< source >( 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>' additional_special_tokens = None **kwargs )
参数
- vocab (
list of tuples, optional) — Unigram 模型的 (token, score) 元组列表。如果未提供，则使用空列表。 - unk_id (
int, optional, defaults to 0) — 词汇表中未知标记的 ID。 - do_lower_case (
bool, optional, defaults toFalse) — 对输入进行分词时是否转换为小写。 - remove_space (
bool, optional, defaults toTrue) — 分词时是否去除文本中的空格（删除字符串开头和结尾多余的空格）。 - keep_accents (
bool, optional, defaults toFalse) — 分词时是否保留重音符号。 - bos_token (
str, optional, defaults to"<s>") — 预训练期间使用的序列开始标记。可用作序列分类标记。使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - eos_token (
str, optional, defaults to"</s>") — 序列结束标记。使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是
sep_token。 - unk_token (
str, optional, defaults to"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，并被设置为此标记。 - sep_token (
str, optional, defaults to"<sep>") — 分隔符标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, optional, defaults to"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - cls_token (
str, optional, defaults to"<cls>") — 分类器标记，用于进行序列分类（对整个序列进行分类，而不是按标记进行分类）。它是在使用特殊标记构建序列时的第一个标记。 - mask_token (
str, optional, defaults to"<mask>") — 用于掩盖值的标记。在对模型进行掩码语言建模训练时使用此标记。模型将尝试预测此标记。 - additional_special_tokens (
list[str], optional, defaults to["<eop>", "<eod>"]) — 分词器使用的额外特殊标记。
构建 XLNet 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 Unigram。
此分词器继承自 TokenizersBackend，其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
XLNet 特定输出
class transformers.models.xlnet.modeling_xlnet.XLNetModelOutput
< source >( last_hidden_state: FloatTensor mems: list[torch.FloatTensor] | None = None hidden_states: tuple[torch.FloatTensor, ...] | None = None attentions: tuple[torch.FloatTensor, ...] | None = None )
参数
- last_hidden_state (
torch.FloatTensor，形状为(batch_size, num_predict, hidden_size)) — 模型最后一层的隐藏状态序列。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。 - mems (
list[torch.FloatTensor]，长度为config.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将过去信息提供给此模型的标记 ID 不应作为input_ids传递，因为它们已被计算。 - hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层输出，如果模型有嵌入层，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetModel 的输出类型。
class transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput
< source >( loss: torch.FloatTensor | None = None logits: torch.FloatTensor | None = None mems: list[torch.FloatTensor] | None = None hidden_states: tuple[torch.FloatTensor, ...] | None = None attentions: tuple[torch.FloatTensor, ...] | None = None )
参数
- loss (
torch.FloatTensor，形状为 (1,)，optional，当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 - logits (
torch.FloatTensor，形状为(batch_size, num_predict, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。 - mems (
list[torch.FloatTensor]，长度为config.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将过去信息提供给此模型的标记 ID 不应作为input_ids传递，因为它们已被计算。 - hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层输出，如果模型有嵌入层，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetLMHeadModel 的输出类型。
class transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput
< source >( loss: torch.FloatTensor | None = None logits: torch.FloatTensor | None = None mems: list[torch.FloatTensor] | None = None hidden_states: tuple[torch.FloatTensor, ...] | None = None attentions: tuple[torch.FloatTensor, ...] | None = None )
参数
- loss (
torch.FloatTensor，形状为(1,)，optional，当提供label时返回) — 分类（或回归，如果 config.num_labels==1）损失。 - logits (
torch.FloatTensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（SoftMax 之前）。 - mems (
list[torch.FloatTensor]，长度为config.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将过去信息提供给此模型的标记 ID 不应作为input_ids传递，因为它们已被计算。 - hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层输出，如果模型有嵌入层，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForSequenceClassification 的输出类型。
class transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput
< source >( loss: torch.FloatTensor | None = None logits: torch.FloatTensor | None = None mems: list[torch.FloatTensor] | None = None hidden_states: tuple[torch.FloatTensor, ...] | None = None attentions: tuple[torch.FloatTensor, ...] | None = None )
参数
- loss (
torch.FloatTensor，形状为 (1,)，optional，当提供labels时返回) — 分类损失。 - logits (
torch.FloatTensor，形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见上面的 input_ids）。分类分数（SoftMax 之前）。
- mems (
list[torch.FloatTensor]，长度为config.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速顺序解码。已将过去信息提供给此模型的标记 ID 不应作为input_ids传递，因为它们已被计算。 - hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入层输出，如果模型有嵌入层，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForMultipleChoice 的输出类型。
class transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput
< source >( loss: torch.FloatTensor | None = None logits: torch.FloatTensor | None = None mems: list[torch.FloatTensor] | None = None hidden_states: tuple[torch.FloatTensor, ...] | None = None attentions: tuple[torch.FloatTensor, ...] | None = None )
参数
- loss (
torch.FloatTensor，形状为(1,)，optional，当提供labels时返回) — 分类损失。 - logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。 - mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 - hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入层输出，加上每层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForTokenClassificationOutput 的输出类型。
class transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput
< source >( loss: torch.FloatTensor | None = None start_logits: torch.FloatTensor | None = None end_logits: torch.FloatTensor | None = None mems: list[torch.FloatTensor] | None = None hidden_states: tuple[torch.FloatTensor, ...] | None = None attentions: tuple[torch.FloatTensor, ...] | None = None )
参数
- loss (
torch.FloatTensorof shape(1,), optional, 当提供labels时返回) — 总跨度提取损失是起始和结束位置的交叉熵之和。 - start_logits (
torch.FloatTensorof shape(batch_size, sequence_length,)) — 跨度起始得分（SoftMax 之前）。 - end_logits (
torch.FloatTensorof shape(batch_size, sequence_length,)) — 跨度结束得分（SoftMax 之前）。 - mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 - hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入层输出，加上每层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
class transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput
< source >( loss: torch.FloatTensor | None = None start_top_log_probs: torch.FloatTensor | None = None start_top_index: torch.LongTensor | None = None end_top_log_probs: torch.FloatTensor | None = None end_top_index: torch.LongTensor | None = None cls_logits: torch.FloatTensor | None = None mems: list[torch.FloatTensor] | None = None hidden_states: tuple[torch.FloatTensor, ...] | None = None attentions: tuple[torch.FloatTensor, ...] | None = None )
参数
- loss (
torch.FloatTensorof shape(1,), optional, 当同时提供start_positions和end_positions时返回) — 分类损失，是起始标记、结束标记（以及如果提供的话，is_impossible）分类损失的总和。 - start_top_log_probs (
torch.FloatTensorof shape(batch_size, config.start_n_top), optional, 当未提供start_positions或end_positions时返回) — 前 config.start_n_top 个起始标记可能性的对数概率（束搜索）。 - start_top_index (
torch.LongTensorof shape(batch_size, config.start_n_top), optional, 当未提供start_positions或end_positions时返回) — 前 config.start_n_top 个起始标记可能性的索引（束搜索）。 - end_top_log_probs (
torch.FloatTensorof shape(batch_size, config.start_n_top * config.end_n_top), optional, 当未提供start_positions或end_positions时返回) — 前config.start_n_top * config.end_n_top个结束标记可能性的对数概率（束搜索）。 - end_top_index (
torch.LongTensorof shape(batch_size, config.start_n_top * config.end_n_top), optional, 当未提供start_positions或end_positions时返回) — 前config.start_n_top * config.end_n_top个结束标记可能性的索引（束搜索）。 - cls_logits (
torch.FloatTensorof shape(batch_size,), optional, 当未提供start_positions或end_positions时返回) — 答案的is_impossible标签的对数概率。 - mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 - hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入层输出，加上每层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForQuestionAnswering 的输出类型。
XLNetModel
class transformers.XLNetModel
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (XLNetModel) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
裸 XLNet 模型，输出原始隐藏状态，顶部没有特定头部。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None mems: torch.Tensor | None = None perm_mask: torch.Tensor | None = None target_mapping: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None input_mask: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None use_mems: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.xlnet.modeling_xlnet.XLNetModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 输入序列标记在词汇表中的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态（参见下面的mems输出）。可用于加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。必须将
use_mems设置为True才能使用mems。 - perm_mask (
torch.FloatTensorof shape(batch_size, sequence_length, sequence_length), optional) — 用于指示每个输入标记的注意力模式的掩码，值选择在[0, 1]中：- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 注意 j； - 如果
perm_mask[k, i, j] = 1，则批次 k 中的 i 不注意 j。
如果未设置，则每个标记都会注意所有其他标记（完全双向注意力）。仅在预训练期间（用于定义因式分解顺序）或序列解码（生成）时使用。
- 如果
- target_mapping (
torch.FloatTensorof shape(batch_size, num_predict, sequence_length), optional) — 用于指示要使用的输出标记的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应第 j 个标记。仅在预训练期间用于部分预测或序列解码（生成）时使用。 - token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。
- input_mask (
torch.FloatTensorof shapebatch_size, sequence_length, optional) — 用于避免在填充标记索引上执行注意力的掩码。与attention_mask相反，即真实标记为 0，填充标记为 1，以保持与原始代码库的兼容性。掩码值选择在
[0, 1]中：- 1 表示**被掩码**的标记，
- 0 表示**未被掩码**的标记。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这将非常有用。 - use_mems (
bool, optional) — 是否使用内存状态来加速序列解码。如果设置为True，模型将使用来自先前正向传递的隐藏状态来计算注意力，这可以显著提高序列解码任务的性能。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.models.xlnet.modeling_xlnet.XLNetModelOutput or tuple(torch.FloatTensor)
一个 transformers.models.xlnet.modeling_xlnet.XLNetModelOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (XLNetConfig) 和输入而定的各种元素。
-
last_hidden_state (
torch.FloatTensorof shape(batch_size, num_predict, hidden_size)) — 模型最后一层的隐藏状态序列。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。 -
mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 -
hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
XLNetLMHeadModel
class transformers.XLNetLMHeadModel
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (XLNetLMHeadModel) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有语言建模头（与输入嵌入权重绑定的线性层）的 XLNet 模型。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None mems: torch.Tensor | None = None perm_mask: torch.Tensor | None = None target_mapping: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None input_mask: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = 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: int | torch.Tensor = 0 **kwargs ) → transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 输入序列标记在词汇表中的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态（参见下面的mems输出）。可用于加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。必须将
use_mems设置为True才能使用mems。 - perm_mask (
torch.FloatTensorof shape(batch_size, sequence_length, sequence_length), optional) — 用于指示每个输入 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.FloatTensorof shape(batch_size, num_predict, sequence_length), optional) — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应第 j 个 token。仅在预训练期间用于部分预测或用于顺序解码（生成）时使用。 - token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 片段 token 索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]：- 0 对应一个 *句子 A* token，
- 1 对应一个 *句子 B* token。
- input_mask (
torch.FloatTensorof shapebatch_size, sequence_length, optional) — 用于避免在填充 token 索引上执行注意力的掩码。与attention_mask相反，即真实 token 为 0，填充 token 为 1，以保持与原始代码库的兼容性。掩码值选自
[0, 1]：- 1 表示**被掩盖**的 token，
- 0 表示**未被掩盖**的 token。
只能使用
input_mask和attention_mask中的一个。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这很有用。 - labels (
torch.LongTensorof shape(batch_size, num_predict), optional) — 用于掩码语言建模的标签。num_predict对应于target_mapping.shape[1]。如果target_mapping为None，则num_predict对应于sequence_length。标签应对应于应预测的被掩码输入词，并取决于
target_mapping。请注意，为了执行标准的自回归语言建模，必须在input_ids中添加一个 ** token（请参阅 prepare_inputs_for_generation函数和下面的示例）索引选自
[-100, 0, ..., config.vocab_size]所有设置为-100的标签将被忽略，仅针对[0, ..., config.vocab_size]中的标签计算损失 - use_mems (
bool, optional) — 是否使用内存状态来加快顺序解码。如果设置为True，模型将使用前一个正向传播的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。 - logits_to_keep (
Union[int, torch.Tensor], optional, defaults to0) — 如果为int，则计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成时只需要最后一个 token 的 logits，只计算该 token 的 logits可以节省内存，这对于长序列或大词汇量来说非常重要。如果为torch.Tensor，则必须是 1D，对应于序列长度维度中要保留的索引。当使用打包张量格式（批次和序列长度的单维度）时，这很有用。
返回
transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput or tuple(torch.FloatTensor)
一个 transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLNetConfig) 和输入。
-
loss (
torch.FloatTensorof shape (1,), optional, returned whenlabelsis provided) — 语言建模损失（用于下一个 token 预测）。 -
logits (
torch.FloatTensorof shape(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.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 -
hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetLMHeadModel 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> 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 model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (XLNetForSequenceClassification) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
XLNet 模型，顶部带有一个序列分类/回归头部（在池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None mems: torch.Tensor | None = None perm_mask: torch.Tensor | None = None target_mapping: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None input_mask: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None use_mems: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值选自[0, 1]：- 1 表示**未被掩盖**的 token，
- 0 表示**被掩盖**的 token。
- mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态（请参阅下面的mems输出）。可用于加快顺序解码。已将过去状态提供给此模型的 token id 不应作为input_ids传递，因为它们已被计算。必须将
use_mems设置为True才能使用mems。 - perm_mask (
torch.FloatTensorof shape(batch_size, sequence_length, sequence_length), optional) — 用于指示每个输入 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.FloatTensorof shape(batch_size, num_predict, sequence_length), optional) — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应第 j 个 token。仅在预训练期间用于部分预测或用于顺序解码（生成）时使用。 - token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 片段 token 索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]：- 0 对应一个 *句子 A* token，
- 1 对应一个 *句子 B* token。
- input_mask (
torch.FloatTensorof shapebatch_size, sequence_length, optional) — 用于避免在填充 token 索引上执行注意力的掩码。与attention_mask相反，即真实 token 为 0，填充 token 为 1，以保持与原始代码库的兼容性。掩码值选自
[0, 1]：- 1 表示**被掩盖**的 token，
- 0 表示**未被掩盖**的 token。
只能使用
input_mask和attention_mask中的一个。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这很有用。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方误差损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。 - use_mems (
bool, optional) — 是否使用内存状态来加快顺序解码。如果设置为True，模型将使用前一个正向传播的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput or tuple(torch.FloatTensor)
一个 transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含各种元素，具体取决于配置 (XLNetConfig) 和输入。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供label时返回) — 分类 (如果 config.num_labels==1 则为回归) 损失。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 -
hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForSequenceClassification 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> 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 model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (XLNetForMultipleChoice) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
XLNet 模型，顶部带有一个多项选择分类头部（在池化输出顶部的线性层和 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None input_mask: torch.Tensor | None = None attention_mask: torch.Tensor | None = None mems: torch.Tensor | None = None perm_mask: torch.Tensor | None = None target_mapping: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None use_mems: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length)) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length), optional) — 片段 token 索引，用于指示输入的第一个和第二个部分。索引选自[0, 1]：- 0 对应一个 *句子 A* token，
- 1 对应一个 *句子 B* token。
- input_mask (
torch.FloatTensorof shapebatch_size, num_choices, sequence_length, optional) — 用于避免在填充 token 索引上执行注意力的掩码。与attention_mask相反，即真实 token 为 0，填充 token 为 1，以保持与原始代码库的兼容性。掩码值选自
[0, 1]：- 1 表示**被掩盖**的 token，
- 0 表示**未被掩盖**的 token。
只能使用
input_mask和attention_mask中的一个。 - attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值选自[0, 1]：- 1 表示**未被掩盖**的 token，
- 0 表示**被掩盖**的 token。
- mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态（请参阅下面的mems输出）。可用于加快顺序解码。已将过去状态提供给此模型的 token id 不应作为input_ids传递，因为它们已被计算。必须将
use_mems设置为True才能使用mems。 - perm_mask (
torch.FloatTensorof shape(batch_size, sequence_length, sequence_length), optional) — 用于指示每个输入 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.FloatTensorof shape(batch_size, num_predict, sequence_length), optional) — 用于指示要使用的输出 token 的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测对应第 j 个 token。仅在预训练期间用于部分预测或用于顺序解码（生成）时使用。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, num_choices, sequence_length, hidden_size), optional) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这很有用。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在 `[0, …, - use_mems (
bool, optional) — 是否使用内存状态来加快顺序解码。如果设置为True，模型将使用前一个前向传播的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput or tuple(torch.FloatTensor)
一个 transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (XLNetConfig) 和输入而定的各种元素。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
-
mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 -
hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForMultipleChoice 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> 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 model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (XLNetForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法加载模型权重。
Xlnet transformer 顶部带有令牌分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None mems: torch.Tensor | None = None perm_mask: torch.Tensor | None = None target_mapping: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None input_mask: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None use_mems: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 输入序列中词汇表的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- mems (长度为
config.n_layers的list[torch.FloatTensor]) — 包含预先计算的隐藏状态（见下面的mems输出）。可用于加快顺序解码。已将过去提供给该模型的标记 ID 不应作为input_ids传递，因为它们已被计算。必须将
use_mems设置为True才能使用mems。 - perm_mask (
torch.FloatTensorof shape(batch_size, sequence_length, sequence_length), optional) — 用于指示每个输入标记的注意力模式的掩码，值选择在[0, 1]中：- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 注意 j； - 如果
perm_mask[k, i, j] = 1，则批次 k 中的 i 不注意 j。
如果未设置，则每个标记都会注意所有其他标记（完全双向注意力）。仅在预训练期间（用于定义分解顺序）或顺序解码（生成）时使用。
- 如果
- target_mapping (
torch.FloatTensorof shape(batch_size, num_predict, sequence_length), optional) — 用于指示要使用的输出标记的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测位于第 j 个标记上。仅在预训练期间用于部分预测或顺序解码（生成）时使用。 - token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。
- input_mask (
torch.FloatTensorof shapebatch_size, sequence_length, optional) — 用于避免在填充标记索引上执行注意力的掩码。与attention_mask相反，即真实标记为 0，填充标记为 1，这与原始代码库兼容。掩码值选择在
[0, 1]中：- 1 表示**被掩码**的标记，
- 0 表示**未被掩码**的标记。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices]范围内，其中 num_choices 是输入张量的第二维大小。（参见上面的 input_ids） - use_mems (
bool, optional) — 是否使用内存状态来加快顺序解码。如果设置为True，模型将使用前一个前向传播的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput or tuple(torch.FloatTensor)
一个 transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (XLNetConfig) 和输入而定的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 -
hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForTokenClassification 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> 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 model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (XLNetForQuestionAnsweringSimple) — 包含模型所有参数的模型配置类。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法加载模型权重。
XLNet 模型顶部带有用于抽取式问答任务（如 SQuAD）的跨度分类头（隐藏状态输出顶部的线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None mems: torch.Tensor | None = None perm_mask: torch.Tensor | None = None target_mapping: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None input_mask: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None start_positions: torch.Tensor | None = None end_positions: torch.Tensor | None = None use_mems: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 输入序列中词汇表的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- mems (长度为
config.n_layers的list[torch.FloatTensor]) — 包含预先计算的隐藏状态（见下面的mems输出）。可用于加快顺序解码。已将过去提供给该模型的标记 ID 不应作为input_ids传递，因为它们已被计算。必须将
use_mems设置为True才能使用mems。 - perm_mask (
torch.FloatTensorof shape(batch_size, sequence_length, sequence_length), optional) — 用于指示每个输入标记的注意力模式的掩码，值选择在[0, 1]中：- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 注意 j； - 如果
perm_mask[k, i, j] = 1，则批次 k 中的 i 不注意 j。
如果未设置，则每个标记都会注意所有其他标记（完全双向注意力）。仅在预训练期间（用于定义分解顺序）或顺序解码（生成）时使用。
- 如果
- target_mapping (
torch.FloatTensorof shape(batch_size, num_predict, sequence_length), optional) — 用于指示要使用的输出标记的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测位于第 j 个标记上。仅在预训练期间用于部分预测或顺序解码（生成）时使用。 - token_type_ids (
torch.Tensorof shape(batch_size, sequence_length), optional) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。
- input_mask (
torch.FloatTensorof shapebatch_size, sequence_length, optional) — 用于避免在填充标记索引上执行注意力的掩码。与attention_mask相反，即真实标记为 0，填充标记为 1，这与原始代码库兼容。掩码值选择在
[0, 1]中：- 1 表示**被掩码**的标记，
- 0 表示**未被掩码**的标记。
您只能使用
input_mask和attention_mask中的一个。 - inputs_embeds (
torch.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - start_positions (
torch.Tensorof shape(batch_size,), optional) — 用于计算标记分类损失的标注跨度起始位置（索引）的标签。位置被限制为序列长度（sequence_length）。序列外的位置不计入损失计算。 - end_positions (
torch.Tensorof shape(batch_size,), optional) — 用于计算标记分类损失的标注跨度结束位置（索引）的标签。位置被限制为序列长度（sequence_length）。序列外的位置不计入损失计算。 - use_mems (
bool, optional) — 是否使用内存状态来加快顺序解码。如果设置为True，模型将使用前一个前向传播的隐藏状态来计算注意力，这可以显著提高顺序解码任务的性能。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput or tuple(torch.FloatTensor)
一个 transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (XLNetConfig) 和输入而定的各种元素。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length,)) — 跨度起始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length,)) — 跨度结束分数（SoftMax 之前）。 -
mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 -
hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForQuestionAnsweringSimple 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> 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
class transformers.XLNetForQuestionAnswering
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (XLNetForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化时不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法加载模型权重。
Xlnet transformer 顶部带有用于抽取式问答任务（如 SQuAD）的跨度分类头（隐藏状态输出顶部的线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None mems: torch.Tensor | None = None perm_mask: torch.Tensor | None = None target_mapping: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None input_mask: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None start_positions: torch.Tensor | None = None end_positions: torch.Tensor | None = None is_impossible: torch.Tensor | None = None cls_index: torch.Tensor | None = None p_mask: torch.Tensor | None = None use_mems: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor, shape为(batch_size, sequence_length), 可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, shape为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- mems (长度为
config.n_layers的list[torch.FloatTensor]) — 包含预先计算的隐藏状态（见下面的mems输出）。可用于加速顺序解码。已将过去状态提供给此模型的标记 ID 不应作为input_ids传递，因为它们已被计算。必须将
use_mems设置为True才能使用mems。 - perm_mask (
torch.FloatTensor, shape为(batch_size, sequence_length, sequence_length), 可选) — 用于指示每个输入标记的注意力模式的掩码，其值选择范围为[0, 1]：- 如果
perm_mask[k, i, j] = 0，则批次 k 中的 i 注意 j； - 如果
perm_mask[k, i, j] = 1，则批次 k 中的 i 不注意 j。
如果未设置，则每个标记都会注意所有其他标记（完全双向注意力）。仅在预训练期间（用于定义分解顺序）或用于顺序解码（生成）时使用。
- 如果
- target_mapping (
torch.FloatTensor, shape为(batch_size, num_predict, sequence_length), 可选) — 用于指示要使用的输出标记的掩码。如果target_mapping[k, i, j] = 1，则批次 k 中的第 i 个预测位于第 j 个标记上。仅在预训练期间用于部分预测或用于顺序解码（生成）时使用。 - token_type_ids (
torch.Tensor, shape为(batch_size, sequence_length), 可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。
- input_mask (
torch.FloatTensor, shape为batch_size, sequence_length, 可选) — 用于避免对填充标记索引执行注意力的掩码。与attention_mask相反，即真实标记为 0，填充标记为 1，这保留了与原始代码库的兼容性。掩码值选择范围为
[0, 1]：- 1 表示**被掩码**的标记，
- 0 表示**未被掩码**的标记。
只能使用
input_mask和attention_mask中的一个。 - inputs_embeds (
torch.Tensor, shape为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有比模型内部嵌入查找矩阵更多的控制，这将非常有用。 - start_positions (
torch.Tensor, shape为(batch_size,), 可选) — 用于计算标记分类损失的已标记跨度起始位置（索引）的标签。位置被限制为序列长度（sequence_length）。序列之外的位置不计入损失计算。 - end_positions (
torch.Tensor, shape为(batch_size,), 可选) — 用于计算标记分类损失的已标记跨度结束位置（索引）的标签。位置被限制为序列长度（sequence_length）。序列之外的位置不计入损失计算。 - is_impossible (
torch.LongTensor, shape为(batch_size,), 可选) — 标签指示问题是否有答案或没有答案（SQuAD 2.0） - cls_index (
torch.LongTensor, shape为(batch_size,), 可选) — 用于作为输入计算答案合理性的分类标记位置（索引）的标签。 - p_mask (
torch.FloatTensor, shape为(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 而不是普通的元组。
返回
transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (XLNetConfig) 和输入的不同元素。
-
loss (
torch.FloatTensorof shape(1,), optional, 如果同时提供start_positions和end_positions则返回) — 分类损失，是起始 token、结束 token（如果提供则包括 is_impossible）分类损失的总和。 -
start_top_log_probs (
torch.FloatTensorof shape(batch_size, config.start_n_top), optional, 如果未提供start_positions或end_positions则返回) — 前 config.start_n_top 个起始 token 可能性（束搜索）的对数概率。 -
start_top_index (
torch.LongTensorof shape(batch_size, config.start_n_top), optional, 如果未提供start_positions或end_positions则返回) — 前 config.start_n_top 个起始 token 可能性（束搜索）的索引。 -
end_top_log_probs (
torch.FloatTensorof shape(batch_size, config.start_n_top * config.end_n_top), optional, 如果未提供start_positions或end_positions则返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性（束搜索）的对数概率。 -
end_top_index (
torch.LongTensorof shape(batch_size, config.start_n_top * config.end_n_top), optional, 如果未提供start_positions或end_positions则返回) — 前config.start_n_top * config.end_n_top个结束 token 可能性（束搜索）的索引。 -
cls_logits (
torch.FloatTensorof shape(batch_size,), optional, 如果未提供start_positions或end_positions则返回) — 答案的is_impossible标签的对数概率。 -
mems (
list[torch.FloatTensor]of lengthconfig.n_layers) — 包含预先计算的隐藏状态。可用于（参见mems输入）加速序列解码。已提供给此模型的历史标记 ID 不应作为input_ids传入，因为它们已被计算。 -
hidden_states (
tuple[torch.FloatTensor, ...] | None.hidden_states, 当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor, ...] | None.attentions, 当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
XLNetForQuestionAnswering 的 forward 方法，它重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> 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