漏斗Transformer
概述
漏斗Transformer模型在论文 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。它是一个双向Transformer模型，类似于BERT，但在每层块之后都有一个池化操作，有点像计算机视觉中传统的卷积神经网络（CNN）。
论文的摘要是如下
随着语言预训练的成功，人们迫切希望开发出具有良好可扩展性的更高效的架构，以便以更低的成本利用丰富的未标记数据。为了提高效率，我们研究了在维护全长标记级表示中被严重忽视的冗余，特别是对于只需要序列的单向量表示的任务。基于这种直觉，我们提出了漏斗Transformer，它逐渐将隐藏状态序列压缩为更短的序列，从而降低了计算成本。更重要的是，通过将长度缩减节省下来的FLOPs重新投入到构建更深或更广的模型中，我们进一步提高了模型容量。此外，为了执行常见预训练目标所需的标记级预测，漏斗Transformer能够通过解码器从缩减的隐藏序列中恢复每个标记的深度表示。根据经验，在可比或更少的FLOPs情况下，漏斗Transformer在各种序列级预测任务（包括文本分类、语言理解和阅读理解）上的表现优于标准Transformer。
该模型由 sgugger 贡献。原始代码可以在这里找到 这里。
使用技巧
- 由于漏斗Transformer使用池化，因此隐藏状态的序列长度在每层块之后都会发生变化。这样，它们的长度除以 2，从而加快了下一个隐藏状态的计算速度。因此，基本模型的最终序列长度是原始序列长度的四分之一。此模型可以直接用于只需要句子摘要的任务（例如序列分类或多项选择）。对于其他任务，则使用完整模型；此完整模型具有一个解码器，可将最终隐藏状态上采样到与输入相同的序列长度。
- 对于诸如分类之类的任务，这不是问题，但对于诸如掩码语言建模或标记分类之类的任务，我们需要一个与原始输入具有相同序列长度的隐藏状态。在这些情况下，最终的隐藏状态将被上采样到输入序列长度，并通过两个附加层。这就是为什么每个检查点都有两个版本的原因。后缀为“-base”的版本仅包含三个块，而没有该后缀的版本包含三个块和带有附加层的上采样头。
- 漏斗Transformer检查点都提供完整版本和基本版本。第一个版本应与 FunnelModel、FunnelForPreTraining、FunnelForMaskedLM、FunnelForTokenClassification 和 FunnelForQuestionAnswering 一起使用。第二个版本应与 FunnelBaseModel、FunnelForSequenceClassification 和 FunnelForMultipleChoice 一起使用。
资源
FunnelConfig
类 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) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 概率。 - activation_dropout (
float, 可选, 默认为 0.0) — 前馈块的两层之间使用的 dropout 概率。 - 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) — 是否仅将池化应用于查询，还是应用于注意力层的查询、键和值。
这是用于存储 FunnelModel 或 TFBertModel 配置的配置类。它用于根据指定的参数实例化 Funnel Transformer 模型，定义模型架构。使用默认值实例化配置将产生与 Funnel Transformer funnel-transformer/small 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。
FunnelTokenizer
类 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, 可选, 默认为True) — 分词时是否将输入转换为小写。 - do_basic_tokenize (
bool, 可选, 默认为True) — 是否在 WordPiece 之前进行基本分词。 - never_split (
Iterable, 可选) — 分词期间永远不会被拆分的标记集合。 仅在do_basic_tokenize=True时生效 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。 词汇表中不存在的标记无法转换为 ID，并被设置为该标记。 - sep_token (
str, 可选, 默认为"<sep>") — 分隔标记，用于从多个序列构建序列时，例如用于序列分类的两个序列或用于文本和问题的问答。 它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如对不同长度的序列进行批处理时。 - cls_token (
str, 可选, 默认为"<cls>") — 分类标记，用于执行序列分类（对整个序列进行分类，而不是对每个标记进行分类）时。 使用特殊标记构建序列时，它是序列的第一个标记。 - mask_token (
str, 可选, 默认为"<mask>") — 用于掩盖值的标记。这是在使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - bos_token (
str, 可选, 默认为"<s>") — 句首标记。 - eos_token (
str, 可选, 默认为"</s>") — 句尾标记。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对汉字进行分词。这很可能应该对日语停用（参见此 问题）。
- strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值确定（与原始 BERT 中一样）。 - clean_up_tokenization_spaces (
bool, 可选, 默认为True) — 解码后是否清理空格，清理包括删除诸如额外空格之类的潜在伪像。
构建一个 Funnel Transformer 分词器。基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: 列表 token_ids_1: 可选 = 无 ) → 列表[int]
通过连接和添加特殊标记，从用于序列分类任务的序列或序列对构建模型输入。BERT 序列具有以下格式
- 单序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< 源代码 >( token_ids_0: 列表 token_ids_1: 可选 = 无 already_has_special_tokens: 布尔值 = 假 ) → 列表[int]
从没有添加特殊标记的标记列表中检索序列 ID。当使用分词器 prepare_for_model 方法添加特殊标记时，将调用此方法。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: 列表 token_ids_1: 可选 = 无 ) → 列表[int]
根据传递的两个序列创建一个掩码，用于序列对分类任务。漏斗
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，则此方法仅返回掩码的第一部分（0）。
FunnelTokenizerFast
类 transformers.FunnelTokenizerFast
< 源代码 >( 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, 可选, 默认为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) — 是否对汉字进行分词。对于日语，这可能应该停用（请参阅 此问题）。 - bos_token (
str，可选，默认为"<s>") — 句首标记。 - eos_token (
str，可选，默认为"</s>") — 句末标记。 - strip_accents (
bool，可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值确定（如在原始 BERT 中）。 - wordpieces_prefix (
str，可选，默认为"##") — 子词的前缀。
构造一个“快速”漏斗 Transformer 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 WordPiece。
此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0 token_ids_1 = None ) → List[int]
通过连接和添加特殊标记，从序列或序列对构建用于序列分类任务的模型输入。Funnel 序列具有以下格式
- 单序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
Funnel 特定输出
类 transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput
< 源代码 >( loss: Optional = None logits: FloatTensor = None hidden_states: Optional = None attentions: Optional = None )
参数
- loss (可选, 当提供
labels时返回, 形状为(1,)的torch.FloatTensor) — ELECTRA 式目标的总损失。 - logits (形状为
(batch_size, sequence_length)的torch.FloatTensor) — 头部的预测分数（SoftMax 之前的每个标记的分数）。 - hidden_states (
tuple(torch.FloatTensor), 可选, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（嵌入的输出一个 + 每层输出一个）。模型在每个层输出处的隐藏状态以及初始嵌入输出。
- attentions (
tuple(torch.FloatTensor), 可选, 当传入output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。注意力 Softmax 之后的注意力权重，用于计算自注意力头部中的加权平均值。
FunnelForPreTraining 的输出类型。
类 transformers.models.funnel.modeling_tf_funnel.TFFunnelForPreTrainingOutput
< 源代码 >( logits: 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
类 transformers.FunnelBaseModel
< 源代码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
基本的 Funnel Transformer 模型 transformer，输出原始隐藏状态，没有上采样头（也称为解码器）或任何特定任务的头。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以通过 AutoTokenizer 获取。 更多详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 未屏蔽标记为 1，
- 屏蔽标记为 0。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- inputs_embeds (
torch.FloatTensor形状为(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-base")
>>> model = FunnelBaseModel.from_pretrained("funnel-transformer/small-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFunnelModel
类 transformers.FunnelModel
< 源代码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
基本的漏斗 Transformer 模型，输出原始隐藏状态，顶部没有任何特定的头部。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以通过 AutoTokenizer 获取。 更多细节请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码避免在填充标记索引上执行注意力。掩码值在[0, 1]中选择：- 未被掩码的标记为 1，
- 被掩码的标记为 0。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 片段标记索引，指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- inputs_embeds (
torch.FloatTensor形状为(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 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传递的步骤需要在此函数中定义，但之后应该调用 Module 实例而不是此实例，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small")
>>> model = FunnelModel.from_pretrained("funnel-transformer/small")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFunnelModelForPreTraining
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.funnel.modeling_funnel.FunnelForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。索引可以通过 AutoTokenizer 获取。 更多详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充词元索引执行注意力机制。掩码值在[0, 1]中选择：- 未被掩码 的词元为 1，
- 被掩码 的词元为 0。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 词元，
- 1 对应于 句子 B 词元。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)， 可选) — 用于计算 ELECTRA 样式损失的标签。输入应为标记序列（请参阅input_ids文档字符串）索引应在[0, 1]中：- 0 表示标记是原始标记，
- 1 表示标记已被替换。
返回值
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 的前向方法，覆盖了 __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() 方法来加载模型权重。
顶部带有“语言建模”头的漏斗 Transformer 模型。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以通过 AutoTokenizer 获取。更多详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 未掩码标记为 1，
- 已掩码标记为 0。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想更好地控制如何将input_ids索引转换为关联向量，而不是模型的内部嵌入查找矩阵，那么这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应该在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算
返回值
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 的前向方法，覆盖了 __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)
>>> 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)FunnelForSequenceClassification
类 transformers.FunnelForSequenceClassification
< 源代码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
具有序列分类/回归头的漏斗 Transformer 模型（在最后一个隐藏状态的第一个时间步之上有两个线性层），例如用于 GLUE 任务。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以通过 AutoTokenizer 获取。 更多细节请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 避免在填充标记索引上执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩码,
- 0 表示标记已被掩码。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记,
- 1 对应于句子 B 标记。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) —或者，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想更好地控制如何将input_ids索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，则此选项非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方误差），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）包含各种元素，具体取决于配置 (FunnelConfig) 和输入。
-
loss (
torch.FloatTensor形状为(1,), 可选，当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或回归，如果 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-base")
>>> model = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # 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-base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FunnelForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = FunnelForSequenceClassification.from_pretrained("funnel-transformer/small-base", 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-base", 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() 方法来加载模型权重。
漏斗Transformer模型，顶部有一个多项选择分类头（在最后一个隐藏状态的第一个时间步长之上有两个线性层，以及一个softmax），例如用于RocStories/SWAG任务。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, num_choices, sequence_length), 可选) — 掩码，避免对填充标记索引执行注意力。掩码值在[0, 1]中选择:- 未被掩码的标记为 1，
- 被掩码的标记为 0。
- token_type_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择:- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- inputs_embeds （形状为
(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor，可选）— 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions （
bool，可选）— 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states （
bool，可选）— 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict （
bool，可选）— 是否返回 ModelOutput 而不是普通的元组。 - labels （形状为
(batch_size,)的torch.LongTensor，可选）— 用于计算多项选择分类损失的标签。 索引应在[0, ..., num_choices-1]中，其中num_choices是输入张量的第二个维度的大小。 （请参见上面的input_ids）
返回值
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 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传递的步骤需要在此函数中定义，但之后应该调用 Module 实例而不是此实例，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FunnelForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("funnel-transformer/small-base")
>>> model = FunnelForMultipleChoice.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."
>>> 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
类 transformers.FunnelForTokenClassification
< 源代码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Funnel Transformer 模型，顶部带有标记分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), 可选) — 掩码，避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示已屏蔽的标记。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 区分输入第一部分和第二部分的片段标记索引。索引在[0, 1]中选择：- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望更好地控制如何将input_ids索引转换为关联向量，而不是模型的内部嵌入查找矩阵，则此方法很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]中。
返回值
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置 (FunnelConfig) 和输入包含各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选，当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（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 正向方法，覆盖 __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]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).lossFunnelForQuestionAnswering
类 transformers.FunnelForQuestionAnswering
< 源代码 >( config: FunnelConfig )
参数
- config (FunnelConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Funnel Transformer 模型，顶部有一个用于提取式问答任务（例如 SQuAD）的跨度分类头（在隐藏状态输出的顶部有一个线性层，用于计算 span start logits 和 span end logits）。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有内容。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记,
- 0 表示已被掩码的标记.
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记,
- 1 对应于句子 B 标记.
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - start_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记范围起始位置（索引）的标签。位置会被限制在序列长度 (sequence_length) 内。序列之外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记范围结束位置（索引）的标签。位置会被限制在序列长度 (sequence_length) 内。序列之外的位置不会被考虑用于计算损失。
返回值
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组（如果传入 return_dict=False 或当 config.return_dict=False 时）包含根据配置 (FunnelConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 完整的范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。 -
end_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 之后的注意力权重，用于计算自注意力头中的加权平均值。
FunnelForQuestionAnswering 的前向方法，重写了 __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]
>>> # 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.lossTFFunnelBaseModel
类 transformers.TFFunnelBaseModel
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
基本的 Funnel Transformer 模型 transformer，输出原始隐藏状态，没有上采样头（也称为解码器）或任何特定任务的头。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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 (形状为
(batch_size, sequence_length)的Numpy 数组或tf.Tensor) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的Numpy 数组或tf.Tensor，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 未屏蔽标记为 1，
- 已屏蔽标记为 0。
- token_type_ids (形状为
(batch_size, sequence_length)的Numpy 数组或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。此参数仅可在 eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。此参数仅可在 eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在 eager 模式下使用，在图模式下，该值将始终设置为 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 (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor) — 模型最后一层输出的隐藏状态序列。 -
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 的前向方法，重写了 __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
类 transformers.TFFunnelModel
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
基本的漏斗 Transformer 模型，输出原始隐藏状态，顶部没有任何特定的头部。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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 数组或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
- token_type_ids (
Numpy 数组或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 模块）在训练和评估之间具有不同的行为）。
返回值
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 (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor) — 模型最后一层输出的隐藏状态序列。 -
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 的前向方法，覆盖了 __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 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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 函数一样传递输入！
调用
< source >( 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 or 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 (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想更好地控制如何将input_ids索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的元组。此参数可以在 eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool，可选，默认为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)，可选，当传递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 forward 方法，覆盖 __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
类 transformers.TFFunnelForMaskedLM
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有 language modeling 头的漏斗模型。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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 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)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-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.Tensor，形状为(n,)，可选，其中 n 是未掩码标签的数量，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 之后的注意力权重，用于计算自注意力头中的加权平均值。
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
类 transformers.TFFunnelForSequenceClassification
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
Funnel 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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)，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 未屏蔽标记为 1，
- 已屏蔽标记为 0。
- token_type_ids (
Numpy 数组或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。此参数仅可在 eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。此参数仅可在 eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。此参数可在 eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[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)，可选，当传递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
类 transformers.TFFunnelForMultipleChoice
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Funnel 模型，顶部有多选分类头（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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 array或tf.Tensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 段落标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- inputs_embeds (
tf.Tensor，形状为(batch_size, num_choices, 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 模块）在训练和评估之间具有不同的行为）。 - 标签 (
tf.Tensor形状为(batch_size,)，可选) — 用于计算多选分类损失的标签。索引应在[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) 和输入的不同元素。
-
损失 (
tf.Tensor形状为 (batch_size, )，可选，在提供labels时返回) — 分类损失。 -
logits (
tf.Tensor形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见上面的 input_ids）。分类分数（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
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
类 transformers.TFFunnelForTokenClassification
< 源代码 >( config: FunnelConfig *inputs **kwargs )
参数
- 配置 (
XxxConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
具有标记分类头的漏斗模型（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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。此参数只能在 Eager 模式下使用，在 Graph 模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 Eager 模式下使用，在 Graph 模式下，将使用配置中的值。 - 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)，可选，当传递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
类 transformers.TFFunnelForQuestionAnswering
< source >( config: FunnelConfig *inputs **kwargs )
参数
- config (
XxxConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
Funnel 模型，顶部带有用于提取式问答任务（如 SQuAD）的范围分类头（隐藏状态输出顶部的线性层，用于计算“范围开始 logits”和“范围结束 logits”）。
Funnel Transformer 模型由 Zihang Dai、Guokun Lai、Yiming Yang、Quoc V. Le 在 Funnel-Transformer: Filtering out Sequential Redundancy for Efficient Language Processing 中提出。
此模型继承自 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 数组或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。索引可以通过 AutoTokenizer 获取。更多详情，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 。
- attention_mask (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 掩码，以避免对填充词元索引执行注意力。掩码值在[0, 1]中选择：- 未掩码的词元对应 1，
- 已掩码的词元对应 0。
- token_type_ids (
Numpy 数组或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 (形状为
(batch_size,)的tf.Tensor, 可选) — 用于计算标记分类损失的标记跨度开始位置（索引）的标签。位置被限制为序列的长度 (sequence_length)。序列之外的位置不计入损失计算。 - end_positions (形状为
(batch_size,)的tf.Tensor, 可选) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制为序列的长度 (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 (形状为
(batch_size, )的tf.Tensor, 可选, 当提供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)，可选，当传递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]