Transformers 文档
Funnel Transformer
并获得增强的文档体验
开始使用
Funnel Transformer
概述
Funnel Transformer 模型在论文 Funnel-Transformer：过滤序列冗余以实现高效语言处理 中提出。它是一种双向 Transformer 模型，类似于 BERT，但在每组层之后都有一个池化操作，有点像计算机视觉中传统的卷积神经网络（CNN）。
论文摘要如下：
随着语言预训练的成功，开发具有良好可扩展性的更高效架构，以便以更低的成本利用丰富的未标注数据，变得非常可取。为了提高效率，我们研究了在维护全长词元级表示中被严重忽视的冗余问题，特别是对于那些只需要序列的单个向量表示的任务。基于这一直觉，我们提出了 Funnel-Transformer，它将隐藏状态序列逐渐压缩成一个更短的序列，从而减少计算成本。更重要的是，通过将从长度缩减中节省的 FLOPs 重新投入到构建更深或更宽的模型中，我们进一步提高了模型容量。此外，为了执行常见预训练目标所需的词元级预测，Funnel-Transformer 能够通过解码器从缩减的隐藏序列中恢复每个词元的深层表示。在实验中，Funnel-Transformer 在各种序列级预测任务（包括文本分类、语言理解和阅读理解）上，以相当或更少的 FLOPs 优于标准 Transformer。
使用技巧
- 由于 Funnel Transformer 使用了池化操作，隐藏状态的序列长度在每组层之后都会发生变化。通过这种方式，它们的长度减少了一半，从而加快了后续隐藏状态的计算。因此，基础模型的最终序列长度是原始长度的四分之一。该模型可以直接用于仅需要句子摘要的任务（如序列分类或多项选择）。对于其他任务，则使用完整模型；这个完整模型有一个解码器，可以将最终的隐藏状态上采样到与输入相同的序列长度。
- 对于像分类这样的任务，这不是问题，但对于像掩码语言建模或词元分类这样的任务，我们需要一个与原始输入序列长度相同的隐藏状态。在这些情况下，最终的隐藏状态会被上采样到输入序列长度，并经过两个额外的层。这就是为什么每个检查点都有两个版本的原因。带有“-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 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30522) — Funnel Transformer 的词汇表大小。定义了在调用 FunnelModel 或 TFFunnelModel 时，可以通过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) — 嵌入、编码器和池化器中所有全连接层的丢弃概率。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力概率的丢弃概率。 - activation_dropout (
float, 可选, 默认为 0.0) — 前馈块中两层之间使用的丢弃概率。 - initializer_range (
float, 可选, 默认为 0.1) — 用于初始化注意力层中所有权重矩阵的均匀初始化器的上限。 - initializer_std (
float, 可选) — 用于初始化嵌入矩阵和线性层权重的正态初始化器的标准差。嵌入矩阵的默认值为 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）和值（values）都应用池化。
这是一个配置类，用于存储 FunnelModel 或 TFBertModel 的配置。它用于根据指定的参数实例化一个 Funnel Transformer 模型，定义模型架构。使用默认值实例化一个配置将产生一个与 Funnel Transformer funnel-transformer/small 架构相似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。请阅读 PretrainedConfig 的文档以获取更多信息。
FunnelTokenizer
class transformers.FunnelTokenizer
< 源文件 >( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '<unk>' sep_token = '<sep>' pad_token = '<pad>' cls_token = '<cls>' mask_token = '<mask>' bos_token = '<s>' eos_token = '</s>' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, optional, 默认为True) — 是否在分词时将输入转换为小写。 - do_basic_tokenize (
bool, optional, 默认为True) — 是否在 WordPiece 之前进行基本分词。 - never_split (
Iterable, optional) — 在分词过程中永远不会被分割的词元集合。仅在do_basic_tokenize=True时有效。 - unk_token (
str, optional, 默认为"<unk>") — 未知词元。不在词汇表中的词元无法转换成 ID，将被设置为此词元。 - sep_token (
str, optional, 默认为"<sep>") — 分隔符词元，用于从多个序列构建一个序列时使用，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊词元构建的序列的最后一个词元。 - pad_token (
str, optional, 默认为"<pad>") — 用于填充的词元，例如在批处理不同长度的序列时使用。 - cls_token (
str, optional, 默认为"<cls>") — 分类器词元，用于序列分类（对整个序列进行分类，而不是按词元分类）。当使用特殊词元构建序列时，它是序列的第一个词元。 - mask_token (
str, optional, 默认为"<mask>") — 用于掩码值的词元。在使用掩码语言模型训练此模型时使用此词元。模型将尝试预测此词元。 - bos_token (
str, optional, 默认为"<s>") — 句子开始词元。 - eos_token (
str, optional, 默认为"</s>") — 句子结束词元。 - tokenize_chinese_chars (
bool, optional, 默认为True) — 是否对中文字符进行分词。对于日语，这可能应该停用（参见此 问题）。
- strip_accents (
bool, optional) — 是否移除所有重音符号。如果未指定此选项，则将由lowercase的值决定（与原始 BERT 中一样）。 - clean_up_tokenization_spaces (
bool, optional, 默认为True) — 是否在解码后清理空格，清理操作包括移除可能的多余空格等伪影。
构建一个 Funnel Transformer 分词器。基于 WordPiece。
该分词器继承自 PreTrainedTokenizer，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
通过连接和添加特殊标记，从一个序列或一对序列构建用于序列分类任务的模型输入。BERT 序列的格式如下：
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
根据传入的两个序列创建一个掩码，用于序列对分类任务。一个 Funnel
Transformer 序列对掩码具有以下格式
2 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence | second sequence |如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0s）。
FunnelTokenizerFast
class transformers.FunnelTokenizerFast
< source >( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '<unk>' sep_token = '<sep>' pad_token = '<pad>' cls_token = '<cls>' mask_token = '<mask>' bos_token = '<s>' eos_token = '</s>' clean_text = True tokenize_chinese_chars = True strip_accents = None wordpieces_prefix = '##' **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, optional, 默认为True) — 是否在分词时将输入转换为小写。 - unk_token (
str, optional, 默认为"<unk>") — 未知词元。不在词汇表中的词元无法转换成 ID，将被设置为此词元。 - sep_token (
str, optional, 默认为"<sep>") — 分隔符词元，用于从多个序列构建一个序列时使用，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊词元构建的序列的最后一个词元。 - pad_token (
str, optional, 默认为"<pad>") — 用于填充的词元，例如在批处理不同长度的序列时使用。 - cls_token (
str, optional, 默认为"<cls>") — 分类器词元，用于序列分类（对整个序列进行分类，而不是按词元分类）。当使用特殊词元构建序列时，它是序列的第一个词元。 - mask_token (
str, optional, 默认为"<mask>") — 用于掩码值的词元。在使用掩码语言模型训练此模型时使用此词元。模型将尝试预测此词元。 - clean_text (
bool, optional, 默认为True) — 是否在分词前通过移除任何控制字符并将所有空白替换为经典空格来清理文本。 - tokenize_chinese_chars (
bool, optional, 默认为True) — 是否对中文字符进行分词。对于日语，这可能应该停用（参见此问题）。 - bos_token (
str,optional, 默认为"<s>") — 句子开始词元。 - eos_token (
str,optional, 默认为"</s>") — 句子结束词元。 - strip_accents (
bool, optional) — 是否移除所有重音符号。如果未指定此选项，则将由lowercase的值决定（与原始 BERT 中一样）。 - wordpieces_prefix (
str, optional, 默认为"##") — 子词的前缀。
构建一个“快速”的 Funnel Transformer 分词器（由 HuggingFace 的 *tokenizers* 库支持）。基于 WordPiece。
该分词器继承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0 token_ids_1 = None ) → List[int]
通过连接和添加特殊词元，从一个序列或一对序列构建模型输入，用于序列分类任务。一个 Funnel 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
根据传入的两个序列创建一个掩码，用于序列对分类任务。一个 Funnel
Transformer 序列对掩码具有以下格式
2 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence | second sequence |如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0s）。
Funnel 特定输出
class transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None logits: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )
参数
- loss (
*optional*, 当提供labels时返回,torch.FloatTensor形状为(1,)) — ELECTRA 式目标的总损失。 - logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 预测头的预测分数（SoftMax 之前的每个词元的分数）。 - hidden_states (
tuple[torch.FloatTensor]，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的隐藏状态，以及可选的初始嵌入输出。
- attentions (
tuple[torch.FloatTensor]，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。经过注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
FunnelForPreTraining 的输出类型。
class transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput
< source >( logits: Optional[tf.Tensor] = None hidden_states: tuple[tf.Tensor] | None = None attentions: tuple[tf.Tensor] | None = None )
参数
- logits (
tf.Tensor，形状为(batch_size, sequence_length)) — 头的预测分数（在 SoftMax 之前的每个词元的分数）。 - hidden_states (
tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的隐藏状态，以及初始嵌入输出。
- attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(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 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列词元的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示词元未被掩码，
- 0 表示词元被掩码。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在[0, 1]中选择：- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。在 `[0, config.n_positions - 1]` 范围内选择。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩码，
- 0 表示头被掩码。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelBaseModel 的前向方法，重写了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `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 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列词元的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示词元未被掩码，
- 0 表示词元被掩码。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在[0, 1]中选择：- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelModel 的前向方法，重写了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
FunnelModelForPreTraining
class transformers.FunnelForPreTraining
< 源 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有二元分类头的 Funnel Transformer 模型，用于在预训练期间识别生成的词元。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列词元的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示词元未被掩码，
- 0 表示词元被掩码。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在[0, 1]中选择：- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递input_ids，而是直接传递一个嵌入表示。如果你想比模型的内部嵌入查找矩阵有更多控制权来将input_ids索引转换为相关向量，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算 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时返回，torch.FloatTensor，形状为(1,)) — ELECTRA 风格目标函数的总损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length)) — 模型头的预测分数（SoftMax之前的每个词元的分数）。 -
hidden_states (
tuple[torch.FloatTensor], 可选, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则第一个是嵌入层的输出，然后是每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor], 可选, 当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForPreTraining 的 forward 方法覆盖了 __call__ 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `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 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 输入序列词元在词汇表中的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的词元，
- 0 表示被掩码的词元。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一和第二部分的片段词元索引。索引在[0, 1]中选择：- 0 对应于*句子 A*的词元，
- 1 对应于*句子 B*的词元。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想对如何将input_ids索引转换为关联向量进行更多控制，而不是使用模型内部的嵌入查找矩阵，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在[-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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForMaskedLM 的 forward 方法覆盖了 __call__ 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `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 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 输入序列词元在词汇表中的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的词元，
- 0 表示被掩码的词元。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一和第二部分的片段词元索引。索引在[0, 1]中选择：- 0 对应于*句子 A*的词元，
- 1 对应于*句子 B*的词元。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想对如何将input_ids索引转换为关联向量进行更多控制，而不是使用模型内部的嵌入查找矩阵，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。 - 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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForSequenceClassification 的 forward 方法覆盖了 __call__ 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `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() 方法来加载模型权重。
Funnel 模型，带有一个多项选择分类头（在池化输出上加一个线性层和 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 输入序列词元在词汇表中的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的词元，
- 0 表示被掩码的词元。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一和第二部分的片段词元索引。索引在[0, 1]中选择：- 0 对应于*句子 A*的词元，
- 1 对应于*句子 B*的词元。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想对如何将input_ids索引转换为关联向量进行更多控制，而不是使用模型内部的嵌入查找矩阵，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size,), 可选) — 用于计算多项选择分类损失的标签。索引应在[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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForMultipleChoice 的 forward 方法覆盖了 __call__ 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `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
< 源代码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
Funnel Transformer，带有一个词元分类头（在隐藏状态输出上加一个线性层），例如用于命名实体识别 (NER) 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 输入序列词元在词汇表中的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的词元，
- 0 表示被掩码的词元。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一和第二部分的片段词元索引。索引在[0, 1]中选择：- 0 对应于*句子 A*的词元，
- 1 对应于*句子 B*的词元。
- inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想对如何将input_ids索引转换为关联向量进行更多控制，而不是使用模型内部的嵌入查找矩阵，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算词元分类损失的标签。索引应在[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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
`FunnelForTokenClassification` 的 forward 方法重写了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `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
< 来源 >( config: FunnelConfig )
参数
- config (`FunnelConfig`) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 `from_pretrained()` 方法来加载模型权重。
Funnel Transformer 模型，在其顶部增加了一个片段分类头，用于抽取式问答任务，如 SQuAD（在隐藏状态输出之上增加一个线性层，以计算 `span start logits` 和 `span end logits`）。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规的 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → `transformers.modeling_outputs.QuestionAnsweringModelOutput` 或 `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` 索引转换为相关联的向量，这很有用。
- 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)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层都有一个输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
`FunnelForQuestionAnswering` 的 forward 方法重写了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `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)
...TFFunnelBaseModel
class transformers.TFFunnelBaseModel
< 来源 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 `from_pretrained()` 方法来加载模型权重。
基础的 Funnel Transformer 模型，输出原始的隐藏状态，没有上采样头（也称为解码器）或任何任务特定的头。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 来源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → `transformers.modeling_tf_outputs.TFBaseModelOutput` 或 `tuple(tf.Tensor)`
参数
- input_ids (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`) — 词汇表中输入序列词元的索引。
可以使用 `AutoTokenizer` 获取索引。有关详细信息，请参阅 `PreTrainedTokenizer.__call__()` 和 `PreTrainedTokenizer.encode()`。
- attention_mask (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`，可选) — 用于避免对填充词元索引执行注意力操作的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示词元未被掩码，
- 0 表示词元被掩码。
- token_type_ids (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`，可选) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在 `[0, 1]` 中选择：
- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (形状为 `(batch_size, sequence_length, hidden_size)` 的 `tf.Tensor`，可选) — 可选地，你可以不传递 `input_ids`，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关联的向量，这很有用。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回的张量下的 `attentions`。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的 `hidden_states`。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回`ModelOutput`而非普通元组。此参数可在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False`) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 `transformers.modeling_tf_outputs.TFBaseModelOutput` 或一个 `tf.Tensor` 的元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），包含的各种元素取决于配置（`FunnelConfig`）和输入。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (`tuple(tf.FloatTensor)`，可选，当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `tf.Tensor` 的元组（一个用于嵌入层的输出 + 一个用于每层的输出），形状为 `(batch_size, sequence_length, hidden_size)`。
模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
`TFFunnelBaseModel` 的 forward 方法重写了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelBaseModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = TFFunnelBaseModel.from_pretrained("funnel-transformer/small-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFFunnelModel
class transformers.TFFunnelModel
< 来源 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 `from_pretrained()` 方法来加载模型权重。
基础的 Funnel Transformer 模型，输出原始的隐藏状态，顶部没有任何特定的头。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 来源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → `transformers.modeling_tf_outputs.TFBaseModelOutput` 或 `tuple(tf.Tensor)`
参数
- input_ids (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`) — 词汇表中输入序列词元的索引。
可以使用 `AutoTokenizer` 获取索引。有关详细信息，请参阅 `PreTrainedTokenizer.__call__()` 和 `PreTrainedTokenizer.encode()`。
- attention_mask (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`，可选) — 用于避免对填充词元索引执行注意力操作的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示词元未被掩码，
- 0 表示词元被掩码。
- token_type_ids (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`，可选) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在 `[0, 1]` 中选择：
- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (形状为 `(batch_size, sequence_length, hidden_size)` 的 `tf.Tensor`，可选) — 可选地，你可以不传递 `input_ids`，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关联的向量，这很有用。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回的张量下的 `attentions`。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的 `hidden_states`。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回`ModelOutput`而非普通元组。此参数可在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False`) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 `transformers.modeling_tf_outputs.TFBaseModelOutput` 或一个 `tf.Tensor` 的元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），包含的各种元素取决于配置（`FunnelConfig`）和输入。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (`tuple(tf.FloatTensor)`，可选，当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `tf.Tensor` 的元组（一个用于嵌入层的输出 + 一个用于每层的输出），形状为 `(batch_size, sequence_length, hidden_size)`。
模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
`TFFunnelModel` 的 forward 方法重写了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelModel.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFFunnelModelForPreTraining
class transformers.TFFunnelForPreTraining
< 来源 >( config: FunnelConfig **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 `from_pretrained()` 方法来加载模型权重。
带有二元分类头的 Funnel 模型，用于在预训练期间识别生成的词元。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 来源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False **kwargs ) → `transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput` 或 `tuple(tf.Tensor)`
参数
- input_ids (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`) — 词汇表中输入序列词元的索引。
可以使用 `AutoTokenizer` 获取索引。有关详细信息，请参阅 `PreTrainedTokenizer.__call__()` 和 `PreTrainedTokenizer.encode()`。
- attention_mask (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`，可选) — 用于避免对填充词元索引执行注意力操作的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示词元未被掩码，
- 0 表示词元被掩码。
- token_type_ids (`Numpy 数组`或形状为 `(batch_size, sequence_length)` 的 `tf.Tensor`，可选) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在 `[0, 1]` 中选择：
- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (形状为 `(batch_size, sequence_length, hidden_size)` 的 `tf.Tensor`，可选) — 可选地，你可以不传递 `input_ids`，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关联的向量，这很有用。
- output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可在 Eager 模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。
返回
transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput 或 tuple(tf.Tensor)
一个 transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput 或一个 tf.Tensor 的元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），包含各种元素，具体取决于配置 (FunnelConfig) 和输入。
-
logits (
tf.Tensor, 形状为(batch_size, sequence_length)) — 预测头的预测分数（SoftMax 之前的每个词元的分数）。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) —tf.Tensor的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFunnelForPreTraining 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelForPreTraining.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(inputs).logitsTFFunnelForMaskedLM
class transformers.TFFunnelForMaskedLM
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
顶部带有 `语言建模` 头的 Funnel 模型。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy 数组或tf.Tensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor, 形状为(batch_size, sequence_length), optional) — 用于避免对填充词元索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：- 1 表示**未被屏蔽**的词元，
- 0 表示**被屏蔽**的词元。
- token_type_ids (
Numpy 数组或tf.Tensor, 形状为(batch_size, sequence_length), optional) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在 `[0, 1]` 中选择：- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (
tf.Tensor, 形状为(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型的内部嵌入查找矩阵更多地控制如何将 `input_ids` 索引转换为相关联的向量，这会很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可在 Eager 模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor, 形状为(batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在 `[-100, 0, ..., config.vocab_size]` 范围内（参见 `input_ids` 文档字符串）。索引设置为 `-100` 的词元将被忽略（屏蔽），损失仅对标签在 `[0, ..., config.vocab_size]` 范围内的词元进行计算。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 tf.Tensor 的元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），包含各种元素，具体取决于配置 (FunnelConfig) 和输入。
-
loss (
tf.Tensorof shape(n,), 可选, 其中 n 是非掩码标签的数量，当提供labels时返回) — 掩码语言模型 (MLM) 损失。 -
logits (
tf.Tensorof shape(batch_size, sequence_length, config.vocab_size)) — 语言模型头部的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) —tf.Tensor的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFunnelForMaskedLM 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelForMaskedLM.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # retrieve index of [MASK]
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)
>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)TFFunnelForSequenceClassification
class transformers.TFFunnelForSequenceClassification
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
顶部带有一个序列分类/回归头的 Funnel 模型转换器（池化输出之上是一个线性层），例如用于 GLUE 任务。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy 数组或tf.Tensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor, 形状为(batch_size, sequence_length), optional) — 用于避免对填充词元索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：- 1 表示**未被屏蔽**的词元，
- 0 表示**被屏蔽**的词元。
- token_type_ids (
Numpy 数组或tf.Tensor, 形状为(batch_size, sequence_length), optional) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在 `[0, 1]` 中选择：- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (
tf.Tensor, 形状为(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型的内部嵌入查找矩阵更多地控制如何将 `input_ids` 索引转换为相关联的向量，这会很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可在 Eager 模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor, 形状为(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 `[0, ..., config.num_labels - 1]` 范围内。如果 `config.num_labels == 1`，则计算回归损失（均方损失），如果 `config.num_labels > 1`，则计算分类损失（交叉熵）。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 的元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），包含各种元素，具体取决于配置 (FunnelConfig) 和输入。
-
loss (
tf.Tensor，形状为(batch_size, )，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (
tf.Tensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) —tf.Tensor的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFunnelForSequenceClassification 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = TFFunnelForSequenceClassification.from_pretrained("funnel-transformer/small-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])>>> # 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 = TFFunnelForSequenceClassification.from_pretrained("funnel-transformer/small-base", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFFunnelForMultipleChoice
class transformers.TFFunnelForMultipleChoice
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
顶部带有多项选择分类头的 Funnel 模型（池化输出之上是一个线性层和一个 softmax 层），例如用于 RocStories/SWAG 任务。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy 数组或tf.Tensor, 形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor, 形状为(batch_size, num_choices, sequence_length), optional) — 用于避免对填充词元索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：- 1 表示**未被屏蔽**的词元，
- 0 表示**被屏蔽**的词元。
- token_type_ids (
Numpy 数组或tf.Tensor, 形状为(batch_size, num_choices, sequence_length), optional) — 用于指示输入的第一部分和第二部分的片段词元索引。索引在 `[0, 1]` 中选择：- 0 对应于*句子 A* 的词元，
- 1 对应于*句子 B* 的词元。
- inputs_embeds (
tf.Tensor, 形状为(batch_size, num_choices, sequence_length, hidden_size), optional) — 可选地，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型的内部嵌入查找矩阵更多地控制如何将 `input_ids` 索引转换为相关联的向量，这会很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可在 Eager 模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor, 形状为(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在 `[0, ..., num_choices]` 范围内，其中 `num_choices` 是输入张量第二维的大小。（参见上面的 `input_ids`）
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个 tf.Tensor 的元组（如果传递了 `return_dict=False` 或当 `config.return_dict=False` 时），包含各种元素，具体取决于配置 (FunnelConfig) 和输入。
-
loss (
tf.Tensor，形状为 (batch_size, )，可选，当提供labels时返回) — 分类损失。 -
logits (
tf.Tensor，形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(tf.Tensor), optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) —tf.Tensor的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFunnelForMultipleChoice 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = TFFunnelForMultipleChoice.from_pretrained("funnel-transformer/small-base")
>>> 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."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFFunnelForTokenClassification
class transformers.TFFunnelForTokenClassification
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
顶部带有一个词元分类头的 Funnel 模型（隐藏状态输出之上是一个线性层），例如用于命名实体识别（NER）任务。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记已被遮盖。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引选自[0, 1]：- 0 对应于 *A 句子* 的标记，
- 1 对应于 *B 句子* 的标记。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 或者，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置（FunnelConfig）和输入。
-
loss (
tf.Tensor，形状为(n,)，可选，其中 n 是未被掩盖的标签数量，当提供labels时返回) — 分类损失。 -
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) —tf.Tensor的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFunnelForTokenClassification 的前向方法，重写了 __call__ 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelForTokenClassification.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-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] for t in predicted_token_class_ids[0].numpy().tolist()]TFFunnelForQuestionAnswering
class transformers.TFFunnelForQuestionAnswering
< 源 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Funnel 模型在顶部带有一个片段分类头，用于像 SQuAD 这样的抽取式问答任务（在隐藏状态输出的顶部有一个线性层，用于计算 span start logits 和 span end logits）。
Funnel Transformer 模型在论文 《Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing》 中由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 提出。
该模型继承自 `TFPreTrainedModel`。请查阅超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 `keras.Model` 子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与常规用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该会“正常工作”——只需以 `model.fit()` 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记已被遮盖。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引选自[0, 1]：- 0 对应于 *A 句子* 的标记，
- 1 对应于 *B 句子* 的标记。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 或者，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这会很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - start_positions (
tf.Tensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标注片段起始位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列之外的位置在计算损失时不予考虑。 - end_positions (
tf.Tensor，形状为(batch_size,)，可选) — 用于计算标记分类损失的标注片段结束位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列之外的位置在计算损失时不予考虑。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置（FunnelConfig）和输入。
-
loss (
tf.Tensor，形状为(batch_size, )，可选，在提供了start_positions和end_positions时返回) — 总片段抽取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度起始分数（SoftMax 之前）。 -
end_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度结束分数（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) —tf.Tensor的元组（一个用于嵌入层的输出，一个用于每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFFunnelForQuestionAnswering 的前向方法，重写了 __call__ 特殊方法。
虽然前向传递的逻辑需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFFunnelForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = TFFunnelForQuestionAnswering.from_pretrained("funnel-transformer/small")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]