Transformers 文档
Funnel Transformer
并获得增强的文档体验
开始使用
该模型于 2020-06-05 发布，并于 2020-11-16 添加到 Hugging Face Transformers 中。
Funnel Transformer
概述
Funnel Transformer 模型是在论文 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出的。它是一个像 BERT 一样的双向 Transformer 模型，但在每组层（block）之后都有一个池化操作，有点类似于计算机视觉中传统的卷积神经网络（CNN）。
论文摘要如下：
随着语言预训练的成功，非常需要开发具有良好扩展性的更高效架构，从而以更低的成本利用丰富的无标签数据。为了提高效率，我们检查了在维护全长令牌级表示中被大大忽视的冗余，特别是对于仅需要序列单向量表示的任务。基于这一直觉，我们提出了 Funnel-Transformer，它逐渐将隐藏状态序列压缩为更短的序列，从而降低计算成本。更重要的是，通过将长度缩减节省的 FLOPs 重新投入到构建更深或更宽的模型中，我们进一步提高了模型容量。此外，为了执行常见预训练目标所需的令牌级预测，Funnel-Transformer 能够通过解码器从缩减后的隐藏序列中为每个令牌恢复深层表示。实证结果显示，在具有相当或更少 FLOPs 的情况下，Funnel-Transformer 在各种序列级预测任务上优于标准 Transformer，包括文本分类、语言理解和阅读理解。
该模型由 sgugger 贡献。原始代码可以在 这里 找到。
使用技巧
- 由于 Funnel Transformer 使用了池化，隐藏状态的序列长度在每组层之后都会发生变化。通过这种方式，它们的长度被除以 2，从而加速了后续隐藏状态的计算。因此，基础（base）模型的最终序列长度是原始长度的四分之一。该模型可以直接用于仅需要句子摘要的任务（如序列分类或多项选择）。对于其他任务，则使用完整（full）模型；该完整模型带有一个解码器，可以将最终的隐藏状态上采样到与输入相同的序列长度。
- 对于分类等任务，这不成问题，但对于掩码语言建模或令牌分类等任务，我们需要一个与原始输入序列长度相同的隐藏状态。在这些情况下，最终的隐藏状态会被上采样到输入序列长度，并经过两个额外的层。这就是为什么每个检查点有两个版本的原因。以“-base”结尾的版本仅包含三个代码块，而不带该后缀的版本则包含三个代码块以及带有额外层的上采样头。
- Funnel Transformer 检查点均提供完整版和基础版。前者应用于 FunnelModel, FunnelForPreTraining, FunnelForMaskedLM, FunnelForTokenClassification 和 FunnelForQuestionAnswering。后者应用于 FunnelBaseModel, FunnelForSequenceClassification 和 FunnelForMultipleChoice。
资源
FunnelConfig
class transformers.FunnelConfig
< 代码源 >( vocab_size = 30522 block_sizes = [4, 4, 4] block_repeats = None num_decoder_layers = 2 d_model = 768 n_head = 12 d_head = 64 d_inner = 3072 hidden_act = 'gelu_new' hidden_dropout = 0.1 attention_dropout = 0.1 activation_dropout = 0.0 initializer_range = 0.1 initializer_std = None layer_norm_eps = 1e-09 pooling_type = 'mean' attention_type = 'relative_shift' separate_cls = True truncate_seq = True pool_q_only = True pad_token_id = None tie_word_embeddings = True **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30522) — Funnel Transformer 的词汇表大小。定义了调用 FunnelModel 时传递的inputs_ids可以表示的不同令牌数量。 - block_sizes (
list[int], 可选, 默认为[4, 4, 4]) — 模型中使用的块的大小。 - block_repeats (
list[int], 可选) — 如果传递该参数，每个块的每一层将按指定的次数重复。 - num_decoder_layers (
int, 可选, 默认为 2) — 解码器中的层数（不使用基础模型时）。 - d_model (
int, 可选, 默认为 768) — 模型隐藏状态的维度。 - n_head (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - d_head (
int, 可选, 默认为 64) — 模型头的维度。 - d_inner (
int, 可选, 默认为 3072) — 前馈块中的内部维度。 - hidden_act (
str或callable, 可选, 默认为"gelu_new") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu","relu","silu"和"gelu_new"。 - hidden_dropout (
float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃（dropout）概率。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力概率的丢弃（dropout）概率。 - activation_dropout (
float, 可选, 默认为 0.0) — 在前馈块的两层之间使用的丢弃（dropout）概率。 - initializer_range (
float, 可选, 默认为 0.1) — 用于初始化注意力层中所有权重矩阵的均匀初始化器（uniform initializer）的上界。 - initializer_std (
float, 可选) — 用于初始化嵌入矩阵和线性层权重的正态初始化器（normal initializer）的标准差。嵌入矩阵默认值为 1，线性层默认值为 Xavier 初始化给出的值。 - layer_norm_eps (
float, 可选, 默认为 1e-09) — 层归一化层使用的 epsilon 值。 - pooling_type (
str, 可选, 默认为"mean") — 可选值为"mean"或"max"。指在每个块开始处执行池化的方式。 - attention_type (
str, 可选, 默认为"relative_shift") — 可选值为"relative_shift"或"factorized"。前者在 CPU/GPU 上较快，而后者在 TPU 上较快。 - separate_cls (
bool, 可选, 默认为True) — 应用池化时是否分离 cls 令牌。 - truncate_seq (
bool, 可选, 默认为True) — 使用separate_cls时，池化时是否截断最后一个令牌，以避免得到不是 2 的倍数的序列长度。 - pool_q_only (
bool, 可选, 默认为True) — 是否仅对查询（query）应用池化，或者对注意力层的查询、键（key）和值（value）都应用池化。 - pad_token_id (
int, 可选) — 填充令牌 ID。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否绑定权重嵌入层。
这是用于存储 FunnelModel 配置的配置类。它用于根据指定的参数实例化一个 Funnel Transformer 模型，定义模型架构。使用默认值实例化配置将产生与 Funnel Transformer funnel-transformer/small 架构类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PreTrainedConfig 的文档。
FunnelTokenizer
class transformers.FunnelTokenizer
< 代码源 >( vocab: str | dict[str, int] | None = None do_lower_case: bool = True unk_token: str = '<unk>' sep_token: str = '<sep>' pad_token: str = '<pad>' cls_token: str = '<cls>' mask_token: str = '<mask>' bos_token: str = '<s>' eos_token: str = '</s>' clean_text: bool = True tokenize_chinese_chars: bool = True strip_accents: bool | None = None wordpieces_prefix: str = '##' **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 分词时是否将输入转换为小写。 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，将被设置为此标记。 - sep_token (
str, 可选, 默认为"<sep>") — 分隔符标记，在从多个序列构建序列时使用（例如，用于序列分类的两个序列，或用于问答的文本和问题）。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - cls_token (
str, 可选, 默认为"<cls>") — 在进行序列分类（对整个序列进行分类，而不是对每个标记进行分类）时使用的分类器标记。它是使用特殊标记构建序列时的第一个标记。 - mask_token (
str, 可选, 默认为"<mask>") — 用于遮盖值的标记。这是在使用遮盖语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - clean_text (
bool, 可选, 默认为True) — 是否在分词前通过移除任何控制字符并将所有空白字符替换为标准空格来清洗文本。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。日语可能应该禁用此选项（参见 此 issue）。 - bos_token (
str,可选, 默认为"<s>") — 句子开始标记。 - eos_token (
str,可选, 默认为"</s>") — 句子结束标记。 - strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则由lowercase的值决定（与原始 BERT 相同）。 - wordpieces_prefix (
str, 可选, 默认为"##") — 子词的前缀。 - vocab (
str或dict[str, int], 可选) — 自定义词汇表字典。
构建一个 Funnel Transformer 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 WordPiece。
此分词器继承自 TokenizersBackend，其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
get_special_tokens_mask
< 源码 >( 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.
FunnelTokenizerFast
class transformers.FunnelTokenizer
< 代码源 >( vocab: str | dict[str, int] | None = None do_lower_case: bool = True unk_token: str = '<unk>' sep_token: str = '<sep>' pad_token: str = '<pad>' cls_token: str = '<cls>' mask_token: str = '<mask>' bos_token: str = '<s>' eos_token: str = '</s>' clean_text: bool = True tokenize_chinese_chars: bool = True strip_accents: bool | None = None wordpieces_prefix: str = '##' **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 分词时是否将输入转换为小写。 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，将被设置为此标记。 - sep_token (
str, 可选, 默认为"<sep>") — 分隔符标记，在从多个序列构建序列时使用（例如，用于序列分类的两个序列，或用于问答的文本和问题）。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - cls_token (
str, 可选, 默认为"<cls>") — 在进行序列分类（对整个序列进行分类，而不是对每个标记进行分类）时使用的分类器标记。它是使用特殊标记构建序列时的第一个标记。 - mask_token (
str, 可选, 默认为"<mask>") — 用于遮盖值的标记。这是在使用遮盖语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - clean_text (
bool, 可选, 默认为True) — 是否在分词前通过移除任何控制字符并将所有空白字符替换为标准空格来清洗文本。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。日语可能应该禁用此选项（参见 此 issue）。 - bos_token (
str,可选, 默认为"<s>") — 句子开始标记。 - eos_token (
str,可选, 默认为"</s>") — 句子结束标记。 - strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则由lowercase的值决定（与原始 BERT 相同）。 - wordpieces_prefix (
str, 可选, 默认为"##") — 子词的前缀。 - vocab (
str或dict[str, int], 可选) — 自定义词汇表字典。
构建一个 Funnel Transformer 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 WordPiece。
此分词器继承自 TokenizersBackend，其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
Funnel 特定输出
class transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput
< 源码 >( loss: torch.FloatTensor | None = None logits: torch.FloatTensor | None = None hidden_states: tuple[torch.FloatTensor] | None = None attentions: tuple[torch.FloatTensor] | None = None )
参数
- loss (
*可选*, 当提供labels时返回, 形状为(1,)的torch.FloatTensor) — ELECTRA 风格目标的总损失。 - logits (形状为
(batch_size, sequence_length)的torch.FloatTensor) — 预测头的分数（SoftMax 之前每个标记的分数）。 - 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForPreTraining 的输出类型。
FunnelBaseModel
class transformers.FunnelBaseModel
< 源码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
输出原始隐状态的基础 Funnel Transformer 模型，不包含上采样头（也称为解码器）或任何顶层的特定任务头。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 遮罩，以避免对填充标记索引执行注意力。遮罩值在[0, 1]中选择：- 1 表示未遮罩的标记，
- 0 表示已遮罩的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要比模型内部嵌入查找矩阵更多地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），由取决于配置 (FunnelConfig) 和输入的各种元素组成。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelBaseModel 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelBaseModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelBaseModel.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFunnelModel
class transformers.FunnelModel
< 源码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
输出原始隐状态且不带任何特定顶层头的纯粹 Funnel 模型。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 遮罩，以避免对填充标记索引执行注意力。遮罩值在[0, 1]中选择：- 1 表示未遮罩的标记，
- 0 表示已遮罩的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要比模型内部嵌入查找矩阵更多地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），由取决于配置 (FunnelConfig) 和输入的各种元素组成。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelModel 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
FunnelModelForPreTraining
class transformers.FunnelForPreTraining
< 源码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
顶层带有二分类头的 Funnel Transformer 模型，如预训练期间用于识别生成的标记。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 遮罩，以避免对填充标记索引执行注意力。遮罩值在[0, 1]中选择：- 1 表示未遮罩的标记，
- 0 表示已遮罩的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应 句子 A 标记，
- 1 对应 句子 B 标记。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 选填。您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将input_ids索引转换为关联向量，这将非常有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算 ELECTRA 风格损失的标签。输入应为标记序列（参见input_ids文档字符串）。索引应在[0, 1]中：- 0 表示该标记是原始标记，
- 1 表示该标记已被替换。
- output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (FunnelConfig) 和输入而变化的各种元素。
-
loss (
*可选*，在提供labels时返回，形状为(1,)的torch.FloatTensor) — ELECTRA 风格目标的总损失。 -
logits (形状为
(batch_size, sequence_length)的torch.FloatTensor) — 预测头得分（SoftMax 之前每个标记的得分）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForPreTraining 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForPreTraining.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> logits = model(**inputs).logitsFunnelForMaskedLM
class transformers.FunnelForMaskedLM
< 源码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
在顶部带有 语言建模 头的 Funnel 模型。”
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 遮罩，以避免对填充标记索引执行注意力。遮罩值选在[0, 1]中：- 1 表示 未被遮盖 的标记，
- 0 表示 已被遮盖 的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应 句子 A 标记，
- 1 对应 句子 B 标记。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 选填。您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将input_ids索引转换为关联向量，这将非常有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算遮盖语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（遮盖），损失仅针对标签在[0, ..., config.vocab_size]中的标记进行计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (FunnelConfig) 和输入而变化的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForMaskedLM 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForMaskedLM.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
...
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
...FunnelForSequenceClassification
class transformers.FunnelForSequenceClassification
< 源码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
顶部带有序列分类/回归头（在最后一个隐藏状态的第一个时间步之上的两个线性层）的 Funnel Transformer 模型，例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 遮罩，以避免对填充标记索引执行注意力。遮罩值选在[0, 1]中：- 1 表示 未被遮盖 的标记，
- 0 表示 已被遮盖 的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应 句子 A 标记，
- 1 对应 句子 B 标记。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 选填。您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将input_ids索引转换为关联向量，这将非常有用。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (FunnelConfig) 和输入而变化的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForSequenceClassification 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FunnelForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small")
>>> 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 = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FunnelForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small", 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 = FunnelForSequenceClassification.from_pretrained(
... "funnel-transformer/small", 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).lossFunnelForMultipleChoice
class transformers.FunnelForMultipleChoice
< 源码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有向多选分类头（池化输出之上的线性层和 softmax）的 Funnel 模型，例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 遮罩，以避免对填充标记索引执行注意力。遮罩值选在[0, 1]中：- 1 表示 未被遮盖 的标记，
- 0 表示 已被遮盖 的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应 句子 A 标记，
- 1 对应 句子 B 标记。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 选填。您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将input_ids索引转换为关联向量，这将非常有用。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算多选分类损失的标签。索引应在[0, ..., num_choices-1]中，其中num_choices是输入张量第二维的大小。（见上文input_ids） - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (FunnelConfig) 和输入而变化的各种元素。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForMultipleChoice 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForMultipleChoice.from_pretrained("funnel-transformer/small")
>>> 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.logitsFunnelForTokenClassification
class transformers.FunnelForTokenClassification
< source >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有令牌分类头的 Funnel Transformer（在隐藏状态输出之上的线性层），例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列令牌的索引。默认情况下将忽略填充（Padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 掩码，用于避免在填充令牌索引上执行注意力。掩码值选在[0, 1]之间：- 1 表示 未被掩盖 的令牌，
- 0 表示 已被掩盖 的令牌。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段令牌索引，用于指示输入的第一部分和第二部分。索引选在[0, 1]之间：- 0 对应于 句子 A 令牌，
- 1 对应于 句子 B 令牌。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，你可以选择直接传递嵌入式表示，而不是传递input_ids。如果你想比模型的内部嵌入查找矩阵更可控地将input_ids索引转换为关联向量，这很有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算令牌分类损失的标签。索引应在[0, ..., config.num_labels - 1]之间。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (FunnelConfig) 和输入而定的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForTokenClassification 的前向传播（forward）方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForTokenClassification.from_pretrained("funnel-transformer/small")
>>> 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)
...FunnelForQuestionAnswering
class transformers.FunnelForQuestionAnswering
< source >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有跨度分类头的 Funnel 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 token_type_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None start_positions: torch.Tensor | None = None end_positions: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列令牌的索引。默认情况下将忽略填充（Padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 掩码，用于避免在填充令牌索引上执行注意力。掩码值选在[0, 1]之间：- 1 表示 未被掩盖 的令牌，
- 0 表示 已被掩盖 的令牌。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段令牌索引，用于指示输入的第一部分和第二部分。索引选在[0, 1]之间：- 0 对应于 句子 A 令牌，
- 1 对应于 句子 B 令牌。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，你可以选择直接传递嵌入式表示，而不是传递input_ids。如果你想比模型的内部嵌入查找矩阵更可控地将input_ids索引转换为关联向量，这很有用。 - start_positions (形状为
(batch_size,)的torch.Tensor，可选) — 标记跨度起始位置（索引）的标签，用于计算令牌分类损失。位置被限制在序列长度 (sequence_length) 之内。序列之外的位置不计入损失计算。 - end_positions (形状为
(batch_size,)的torch.Tensor，可选) — 标记跨度结束位置（索引）的标签，用于计算令牌分类损失。位置被限制在序列长度 (sequence_length) 之内。序列之外的位置不计入损失计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (FunnelConfig) 和输入而定的各种元素。
-
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 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForQuestionAnswering 的前向传播（forward）方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelForQuestionAnswering.from_pretrained("funnel-transformer/small")
>>> 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)
...