FNet
概述
FNet 模型由 James Lee-Thorp、Joshua Ainslie、Ilya Eckstein 和 Santiago Ontanon 在 FNet: 使用傅里叶变换混合 Token 中提出。该模型用傅里叶变换替换了 BERT 模型中的自注意力层，并且只返回变换的实部。该模型比 BERT 模型快得多，因为它具有更少的参数并且更节省内存。在 GLUE 基准测试中，该模型实现了 BERT 模型约 92-97% 的准确率，并且训练速度比 BERT 模型快得多。论文摘要如下：
我们表明，通过用简单的线性变换（“混合”输入 Token）替换自注意力子层，可以加快 Transformer 编码器架构的速度，同时仅产生有限的准确率损失。这些线性混合器与前馈层中的标准非线性一起，证明了在多个文本分类任务中建模语义关系的能力。最令人惊讶的是，我们发现，用标准的、未参数化的傅里叶变换替换 Transformer 编码器中的自注意力子层，在 GLUE 基准测试中实现了 BERT 模型 92-97% 的准确率，但在 GPU 上的训练速度提高了 80%，在 TPU 上的训练速度提高了 70%（标准 512 输入长度）。在较长的输入长度下，我们的 FNet 模型速度显著提高：与长程竞技场基准测试中的“高效”Transformer 相比，FNet 匹配了最精确模型的准确率，同时在所有序列长度的 GPU 上（以及 TPU 上的相对较短的长度）超越了最快的模型。最后，FNet 具有较小的内存占用，并且在较小的模型尺寸下特别高效；对于固定的速度和准确率预算，小型 FNet 模型优于 Transformer 模型。
该模型由 gchhablani 贡献。原始代码可以 在这里 找到。
使用技巧
由于该模型基于傅里叶变换，因此在训练时没有使用注意力掩码。模型的训练使用了最大序列长度 512，其中包括填充 Token。因此，强烈建议在微调和推理时使用相同的最大序列长度。
资源
FNetConfig
类 transformers.FNetConfig
< 源代码 >( vocab_size = 32000 hidden_size = 768 num_hidden_layers = 12 intermediate_size = 3072 hidden_act = 'gelu_new' hidden_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 4 initializer_range = 0.02 layer_norm_eps = 1e-12 use_tpu_fourier_optimizations = False tpu_short_seq_length = 512 pad_token_id = 3 bos_token_id = 1 eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选，默认为 32000) — FNet 模型的词汇量大小。定义了调用 FNetModel 或TFFNetModel时传递的inputs_ids可以表示的不同 Token 的数量。 - hidden_size (
int, 可选，默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选，默认为 12) — Transformer 编码器中隐藏层的数量。 - intermediate_size (
int，可选，默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function，可选，默认为"gelu_new") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float，可选，默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - max_position_embeddings (
int，可选，默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。 - type_vocab_size (
int，可选，默认为 4) — 调用 FNetModel 或TFFNetModel时传递的token_type_ids的词汇量大小。 - initializer_range (
float，可选，默认为 0.02) — 初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_eps (
float，可选，默认为 1e-12) — 层归一化层使用的 epsilon。 - use_tpu_fourier_optimizations (
bool，可选，默认为False) — 确定是否使用 TPU 优化的 FFT。如果为True，则模型将偏向于轴向 FFT 变换。对于 GPU/CPU 硬件，将其设置为False，在这种情况下将使用 n 维 FFT。 - tpu_short_seq_length (
int，可选，默认为 512) — 使用 TPU 时模型期望的序列长度。仅当 use_tpu_fourier_optimizations 设置为True并且输入序列短于或等于 4096 个 token 时，才会使用此值初始化 DFT 矩阵。
这是一个配置类，用于存储 FNetModel 的配置。它用于根据指定的参数实例化 FNet 模型，定义模型架构。使用默认值实例化配置将产生与 FNet google/fnet-base 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。
示例
>>> from transformers import FNetConfig, FNetModel
>>> # Initializing a FNet fnet-base style configuration
>>> configuration = FNetConfig()
>>> # Initializing a model (with random weights) from the fnet-base style configuration
>>> model = FNetModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configFNetTokenizer
构建 FNet 分词器。改编自 AlbertTokenizer。基于 SentencePiece。此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。有关这些方法的更多信息，用户应参考此超类。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记，为序列分类任务从序列或序列对构建模型输入。FNet 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< 源代码 >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
从未添加特殊标记的标记列表中检索序列 ID。当使用分词器 prepare_for_model 方法添加特殊标记时，会调用此方法。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
创建一个用于序列对分类任务的掩码，该掩码来自传递的两个序列。FNet 序列
如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分 (0)。
FNetTokenizerFast
类 transformers.FNetTokenizerFast
< 源代码 >( vocab_file = None tokenizer_file = None do_lower_case = False remove_space = True keep_accents = True unk_token = '<unk>' sep_token = '[SEP]' pad_token = '<pad>' cls_token = '[CLS]' mask_token = '[MASK]' **kwargs )
参数
- vocab_file (
str) — 包含实例化分词器所需的词汇表的SentencePiece 文件 (通常具有 .spm 扩展名)。 - do_lower_case (
bool, 可选, 默认为False) — 分词时是否将输入小写。 - remove_space (
bool, 可选, 默认为True) — 分词时是否去除文本中的空格 (在字符串前后去除多余空格)。 - unk_token (
str，可选，默认为"<unk>") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是设置为此标记。 - sep_token (
str，可选，默认为"[SEP]") — 分隔符标记，用于从多个序列构建序列，例如序列分类的两个序列或问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str，可选，默认为"<pad>") — 用于填充的标记，例如在批处理不同长度的序列时。 - cls_token (
str，可选，默认为"[CLS]") — 分类器标记，用于执行序列分类（整个序列的分类而不是每个标记的分类）。它是使用特殊标记构建的序列的第一个标记。 - mask_token (
str，可选，默认为"[MASK]") — 用于掩蔽值的标记。使用掩蔽语言建模训练此模型时使用的标记。模型将尝试预测此标记。
构建一个“快速”FNetTokenizer（由 HuggingFace 的 tokenizers 库支持）。改编自 AlbertTokenizerFast。基于 Unigram。此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记，为序列分类任务从序列或序列对构建模型输入。FNet 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
创建一个从两个传递的序列生成的掩码，用于序列对分类任务。FNet
如果 token_ids_1 为 None，则仅返回掩码的第一部分（0）。
FNetModel
类 transformers.FNetModel
< 源代码 >( config add_pooling_layer = True )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
基本的 FNet 模型转换器，输出原始隐藏状态，没有任何特定的头部。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
该模型可以充当编码器，遵循 James Lee-Thorp、Joshua Ainslie、Ilya Eckstein 和 Santiago Ontanon 在 FNet：使用傅里叶变换混合标记 中描述的架构。
前向传播
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: 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()。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个torch.FloatTensor的元组（如果传递了return_dict=False或当config.return_dict=False时），包含取决于配置(FNetConfig)和输入的各种元素。
-
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之后的注意力权重，用于计算自注意力头中的加权平均值。
FNetModel 的前向方法，覆盖了__call__特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FNetModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetModel.from_pretrained("google/fnet-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFNetForPreTraining
类 transformers.FNetForPreTraining
< 源代码 >( config )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
FNet 模型，在其顶部有两个头，如预训练期间所做的那样：一个掩码语言建模头和一个下一句预测（分类）头。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
前向传播
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None next_sentence_label: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.fnet.modeling_fnet.FNetForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列中每个标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制，而不是模型内部嵌入查找矩阵，这将非常有用。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。 - next_sentence_label (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算下一个序列预测（分类）损失的标签。输入应该是一个序列对（参见input_ids文档字符串）索引应在[0, 1]中：- 0 表示序列 B 是序列 A 的延续，
- 1 表示序列 B 是一个随机序列。
- kwargs (
Dict[str, any]，可选，默认为{}) — 用于隐藏已弃用的旧参数。
返回值
transformers.models.fnet.modeling_fnet.FNetForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.fnet.modeling_fnet.FNetForPreTrainingOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (FNetConfig) 和输入的不同元素。
- loss (可选，当提供
labels时返回，torch.FloatTensor形状为(1,)) — 作为掩码语言建模损失和下一个序列预测（分类）损失之和的总损失。 - prediction_logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 - seq_relationship_logits (
torch.FloatTensor形状为(batch_size, 2)) — 下一个序列预测（分类）头的预测分数（SoftMax 之前的真/假延续分数）。 - hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态加上初始嵌入输出。
FNetForPreTraining 的前向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FNetForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForPreTraining.from_pretrained("google/fnet-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logitsFNetForMaskedLM
类 transformers.FNetForMaskedLM
< 源代码 >( config )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
具有 语言建模 头的 FNet 模型。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。
前向传播
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: 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()。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更细致地控制如何将 input_ids 索引转换为关联向量，这将很有用。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-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 时），包含取决于配置 (FNetConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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之后的注意力权重，用于计算自注意力头中的加权平均值。
The FNetForMaskedLM 正向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FNetForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForMaskedLM.from_pretrained("google/fnet-base")
>>> 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)FNetForNextSentencePrediction
类 transformers.FNetForNextSentencePrediction
< 源代码 >( config )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 下一句预测（分类）头的 FNet 模型。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
前向传播
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_hidden_states: Optional = None return_dict: Optional = None **kwargs ) → transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]范围内选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将很有用。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算下一序列预测（分类）损失的标签。输入应为序列对（请参阅input_ids文档字符串）。索引应在[0, 1]内：- 0 表示序列 B 是序列 A 的延续，
- 1 表示序列 B 是随机序列。
返回值
transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一个transformers.modeling_outputs.NextSentencePredictorOutput 或一个torch.FloatTensor的元组（如果传递了return_dict=False或当config.return_dict=False时），包含取决于配置(FNetConfig)和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供next_sentence_label时返回) — 下一序列预测（分类）损失。 -
logits (
torch.FloatTensor形状为(batch_size, 2)) — 下一序列预测（分类）头的预测分数（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之后的注意力权重，用于计算自注意力头中的加权平均值。
FNetForNextSentencePrediction 的前向方法覆盖了__call__特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FNetForNextSentencePrediction
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForNextSentencePrediction.from_pretrained("google/fnet-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="pt")
>>> outputs = model(**encoding, labels=torch.LongTensor([1]))
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1] # next sentence was randomFNetForSequenceClassification
类 transformers.FNetForSequenceClassification
< 源代码 >( config )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看from_pretrained() 方法以加载模型权重。
具有序列分类/回归头的 FNet 模型转换器（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
前向传播
< 源代码 >( input_ids: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 输入序列中每个标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行比模型内部嵌入查找矩阵更多的控制，这将非常有用。 - 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 时），包含取决于配置 (FNetConfig) 和输入的各种元素。
-
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之后的注意力权重，用于计算自注意力头中的加权平均值。
FNetForSequenceClassification 正向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForSequenceClassification.from_pretrained("google/fnet-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 = FNetForSequenceClassification.from_pretrained("google/fnet-base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, FNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForSequenceClassification.from_pretrained("google/fnet-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 = FNetForSequenceClassification.from_pretrained(
... "google/fnet-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).lossFNetForMultipleChoice
类 transformers.FNetForMultipleChoice
< 源代码 >( config )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
FNet 模型，在其顶部添加了一个多项选择分类头部（池化输出顶部的线性层和 softmax），例如用于 RocStories/SWAG 任务。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
前向传播
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: 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()。
- token_type_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids 索引转换为关联向量，这将非常有用。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在[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 时），包含根据配置 (FNetConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为 (1,)，可选，在提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, num_choices)) — 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之后的注意力权重，用于计算自注意力头中的加权平均值。
The FNetForMultipleChoice 前向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FNetForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForMultipleChoice.from_pretrained("google/fnet-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.logitsFNetForTokenClassification
类 transformers.FNetForTokenClassification
< 源代码 >( config )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有令牌分类头的 FNet 模型（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
前向传播
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，代替传递input_ids，您可以选择直接传递嵌入表示。如果您希望对如何将input_ids索引转换为关联向量进行比模型内部嵌入查找矩阵更多的控制，这将非常有用。 - 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时），包含取决于配置(FNetConfig)和输入的各种元素。
-
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之后的注意力权重，用于计算自注意力头中的加权平均值。
FNetForTokenClassification 的前向方法，覆盖了__call__特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FNetForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForTokenClassification.from_pretrained("google/fnet-base")
>>> 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).lossFNetForQuestionAnswering
类 transformers.FNetForQuestionAnswering
< 源代码 >( config )
参数
- config (FNetConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看from_pretrained()方法以加载模型权重。
FNet模型，顶部带有一个跨度分类头，用于提取式问答任务，如SQuAD（在隐藏状态输出之上添加线性层以计算跨度开始logits和跨度结束logits）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
前向传播
< 源代码 >( input_ids: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None inputs_embeds: 可选 = None start_positions: 可选 = None end_positions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列中每个标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将非常有用。 - 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 时），包含取决于配置 (FNetConfig) 和输入的各种元素。
-
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之后的注意力权重，用于计算自注意力头中的加权平均值。
FNetForQuestionAnswering 的前向方法覆盖了 __call__ 特殊方法。
虽然前向传递的配方需要在此函数内定义，但之后应该调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FNetForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForQuestionAnswering.from_pretrained("google/fnet-base")
>>> 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.loss