Transformers 文档
ELECTRA
并获取增强的文档体验
即可开始
ELECTRA
概述
ELECTRA 模型在论文 ELECTRA: Pre-training Text Encoders as Discriminators Rather Than Generators 中被提出。ELECTRA 是一种新的预训练方法，它训练两个 transformer 模型：生成器和判别器。生成器的作用是替换序列中的 token，因此被训练为 masked language model（掩码语言模型）。判别器是我们感兴趣的模型，它尝试识别序列中哪些 token 被生成器替换了。
以下是论文的摘要
Masked language modeling (MLM) （掩码语言建模）预训练方法，如 BERT，通过用 [MASK] 替换一些 token 来破坏输入，然后训练模型以重建原始 token。虽然当转移到下游 NLP 任务时它们会产生良好的结果，但它们通常需要大量的计算才能有效。作为一种替代方案，我们提出了一种更具样本效率的预训练任务，称为替换 token 检测。我们的方法不是掩盖输入，而是通过用从小型生成器网络中采样的合理替代方案替换一些 token 来破坏输入。然后，我们不是训练一个预测被破坏 token 的原始身份的模型，而是训练一个判别模型，该模型预测被破坏输入中的每个 token 是否被生成器样本替换。彻底的实验表明，这种新的预训练任务比 MLM 更有效，因为该任务是在所有输入 token 而不是仅仅是被掩盖的小子集上定义的。因此，在给定相同的模型大小、数据和计算量的情况下，我们的方法学习到的上下文表示明显优于 BERT 学习到的上下文表示。对于小型模型而言，收益尤其明显；例如，我们在一个 GPU 上训练 4 天的模型在 GLUE 自然语言理解基准测试中优于 GPT（使用多 30 倍的计算量训练）。我们的方法在大规模上也运行良好，在使用不到其 1/4 的计算量的情况下，其性能与 RoBERTa 和 XLNet 相当，并且在使用相同计算量时优于它们。
此模型由 lysandre 贡献。 原始代码可以在 这里 找到。
使用提示
- ELECTRA 是一种预训练方法，因此对底层模型 BERT 几乎没有做任何更改。唯一的更改是 embedding size（嵌入大小）和 hidden size（隐藏大小）的分离：embedding size 通常较小，而 hidden size 较大。额外的 projection layer（投影层）（线性层）用于将 embedding 从其 embedding size 投影到 hidden size。如果 embedding size 与 hidden size 相同，则不使用投影层。
- ELECTRA 是一个 transformer 模型，它使用另一个（小型）masked language model 进行预训练。输入被该语言模型破坏，该语言模型接受随机掩码的输入文本，并输出 ELECTRA 必须预测哪个 token 是原始的，哪个 token 已被替换的文本。与 GAN 训练类似，小型语言模型训练几个步骤（但以原始文本为目标，而不是像传统 GAN 设置中那样欺骗 ELECTRA 模型），然后 ELECTRA 模型训练几个步骤。
- 使用 Google Research 的实现 保存的 ELECTRA checkpoint 同时包含生成器和判别器。转换脚本要求用户命名要导出到正确架构的模型。但是，一旦转换为 HuggingFace 格式，这些 checkpoint 就可以加载到所有可用的 ELECTRA 模型中。这意味着判别器可以加载到 ElectraForMaskedLM 模型中，生成器可以加载到 ElectraForPreTraining 模型中（分类头将被随机初始化，因为它在生成器中不存在）。
资源
ElectraConfig
class transformers.ElectraConfig
< source >( vocab_size = 30522 embedding_size = 128 hidden_size = 256 num_hidden_layers = 12 num_attention_heads = 4 intermediate_size = 1024 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 summary_type = 'first' summary_use_proj = True summary_activation = 'gelu' summary_last_dropout = 0.1 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30522) — ELECTRA 模型的词汇表大小。定义了在调用 ElectraModel 或 TFElectraModel 时，可以通过inputs_ids传递的不同 token 的数量。 - embedding_size (
int, 可选, 默认为 128) — 编码器层和池化层的维度。 - hidden_size (
int, 可选, 默认为 256) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 12) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int, 可选, 默认为 4) — Transformer 编码器中每个 attention 层的 attention head 数量。 - intermediate_size (
int, 可选, 默认为 1024) — Transformer 编码器中“intermediate”（即，前馈）层的维度。 - hidden_act (
str或Callable, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.1) — embedding、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.1) — attention 概率的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。 - type_vocab_size (
int, 可选, 默认为 2) — 调用 ElectraModel 或 TFElectraModel 时，可以通过token_type_ids传递的词汇表大小。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — layer normalization 层使用的 epsilon 值。 - summary_type (
str, 可选, 默认为"first") — 在进行序列摘要时使用的参数。用于序列分类和多项选择模型。必须是以下选项之一：
"last"：获取最后一个 token 的隐藏状态（如 XLNet）。"first"：获取第一个 token 的隐藏状态（如 BERT）。"mean"：获取所有 token 隐藏状态的平均值。"cls_index"：提供分类 token 位置的 Tensor（如 GPT/GPT-2）。"attn"：目前未实现，请使用 multi-head attention。
- summary_use_proj (
bool, 可选, 默认为True) — 在进行序列摘要时使用的参数。用于序列分类和多项选择模型。是否在向量提取后添加投影。
- summary_activation (
str, 可选) — 在进行序列摘要时使用的参数。用于序列分类和多项选择模型。传递
"gelu"以将 gelu 激活应用于输出，任何其他值将导致不激活。 - summary_last_dropout (
float, 可选, 默认为 0.0) — 在进行序列摘要时使用的参数。用于序列分类和多项选择模型。在投影和激活后使用的 dropout 比率。
- position_embedding_type (
str, optional, defaults to"absolute") — 位置嵌入类型。 从"absolute","relative_key","relative_key_query"中选择一个。 对于位置嵌入，请使用"absolute"。 有关"relative_key"的更多信息，请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。 有关"relative_key_query"的更多信息，请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 *Method 4*。 - use_cache (
bool, optional, defaults toTrue) — 是否模型应返回上次的键/值注意力（并非所有模型都使用）。 仅当config.is_decoder=True时相关。 - classifier_dropout (
float, optional) — 分类头的 dropout 比率。
这是用于存储 ElectraModel 或 TFElectraModel 配置的配置类。 它用于根据指定的参数实例化 ELECTRA 模型，定义模型架构。 使用默认值实例化配置将产生与 ELECTRA google/electra-small-discriminator 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。 有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import ElectraConfig, ElectraModel
>>> # Initializing a ELECTRA electra-base-uncased style configuration
>>> configuration = ElectraConfig()
>>> # Initializing a model (with random weights) from the electra-base-uncased style configuration
>>> model = ElectraModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configElectraTokenizer
class transformers.ElectraTokenizer
< source >( 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]' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, optional, defaults toTrue) — 是否在分词时将输入转换为小写。 - do_basic_tokenize (
bool, optional, defaults toTrue) — 是否在 WordPiece 分词之前进行基本分词。 - never_split (
Iterable, optional) — 在分词期间永远不会被拆分的 token 集合。 仅当do_basic_tokenize=True时有效 - unk_token (
str, optional, defaults to"[UNK]") — 未知 token。 词汇表中不存在的 token 无法转换为 ID，而是设置为此 token。 - sep_token (
str, optional, defaults to"[SEP]") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或者用于问答的文本和问题。 它也用作使用特殊 token 构建的序列的最后一个 token。 - pad_token (
str, optional, defaults to"[PAD]") — 用于填充的 token，例如在对不同长度的序列进行批处理时。 - cls_token (
str, optional, defaults to"[CLS]") — 分类器 token，用于进行序列分类（对整个序列而不是每个 token 进行分类）。 当使用特殊 token 构建时，它是序列的第一个 token。 - mask_token (
str, optional, defaults to"[MASK]") — 用于掩码值的 token。 这是使用掩码语言建模训练此模型时使用的 token。 这是模型将尝试预测的 token。 - tokenize_chinese_chars (
bool, optional, defaults toTrue) — 是否对中文字符进行分词。对于日语，这可能应该被禁用（请参阅此 issue）。
- strip_accents (
bool, optional) — 是否去除所有重音符号。 如果未指定此选项，则将由lowercase的值确定（与原始 Electra 中一样）。 - clean_up_tokenization_spaces (
bool, optional, defaults toTrue) — 是否在解码后清理空格，清理包括删除潜在的伪像，例如多余的空格。
构建 Electra 分词器。 基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。 用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
参数
- token_ids_0 (
List[int]) — 将要添加特殊 token 的 ID 列表。 - token_ids_1 (
List[int], optional) — 序列对的可选的第二个 ID 列表。
返回
List[int]
包含适当特殊 token 的 输入 ID 列表。
通过连接和添加特殊 token，从序列或序列对构建模型输入，以用于序列分类任务。 Electra 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
将 token (字符串) 序列转换为单个字符串。
create_token_type_ids_from_sequences
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
从传递的两个序列创建一个掩码，用于序列对分类任务。 Electra 序列
如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分 (0)。
get_special_tokens_mask
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None already_has_special_tokens: bool = False ) → List[int]
从token列表中检索未添加特殊token的序列ID。当使用tokenizer prepare_for_model 方法添加特殊token时，将调用此方法。
ElectraTokenizerFast
class transformers.ElectraTokenizerFast
< source >( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 在 tokenizing 时是否将输入转换为小写。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知 token。词汇表中不存在的 token 无法转换为 ID，并将被设置为此 token。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或者用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于 padding 的 token，例如在批量处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类器 token，用于进行序列分类（对整个序列而不是每个 token 进行分类）。当使用特殊 token 构建序列时，它是序列的第一个 token。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于 mask 值的 token。这是使用 masked language modeling 训练此模型时使用的 token。这是模型将尝试预测的 token。 - clean_text (
bool, 可选, 默认为True) — 在 tokenization 之前是否清理文本，方法是删除任何控制字符并将所有空格替换为经典空格。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否 token 化中文字符。对于日语，可能应该停用此功能（参见 此 issue）。 - strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值确定（与原始 ELECTRA 中一样）。 - wordpieces_prefix (
str, 可选, 默认为"##") — 子词的前缀。
构建一个“快速” ELECTRA tokenizer（由 HuggingFace 的 tokenizers 库支持）。基于 WordPiece。
此 tokenizer 继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0 token_ids_1 = None ) → List[int]
通过连接和添加特殊 token，从序列或序列对构建用于序列分类任务的模型输入。ELECTRA 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
create_token_type_ids_from_sequences
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
从传递的两个序列创建 mask，用于序列对分类任务。ELECTRA 序列
如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分 (0)。
Electra specific outputs
class transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None logits: FloatTensor = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None )
参数
- loss (可选, 当提供
labels时返回,torch.FloatTensor，形状为(1,)) — ELECTRA 目标的总 loss。 - logits (
torch.FloatTensor，形状为(batch_size, sequence_length)) — head 的预测分数（SoftMax 之前每个 token 的分数）。 - hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（embeddings 输出一个，每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的 hidden state 以及初始 embedding 输出。
- attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 attention 权重，用于计算 self-attention head 中的加权平均值。
ElectraForPreTraining 的输出类型。
class transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput
< source >( logits: tf.Tensor = None hidden_states: Tuple[tf.Tensor] | None = None attentions: Tuple[tf.Tensor] | None = None )
参数
- loss (可选, 当提供
labels时返回,tf.Tensor，形状为(1,)) — ELECTRA 目标的总 loss。 - logits (
tf.Tensor，形状为(batch_size, sequence_length)) — head 的预测分数（SoftMax 之前每个 token 的分数）。 - hidden_states (
tuple(tf.Tensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组 (每个embedding输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上初始embedding输出。
- attentions (
tuple(tf.Tensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
TFElectraForPreTraining 的输出类型。
ElectraModel
class transformers.ElectraModel
< source >( config )
参数
- config (ElectraConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
裸 Electra 模型，输出原始隐藏状态，顶部没有任何特定的头部。与 BERT 模型相同，只是如果隐藏层大小和 embedding 大小不同，它会在 embedding 层和编码器之间使用额外的线性层。生成器和判别器检查点都可以加载到此模型中。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获得索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — Segment token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 位置 embedding 中每个输入序列 tokens 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选) — 用于 nullify self-attention 模块的选定头的掩码。 掩码值在[0, 1]中选择：- 1 表示头部 未被掩盖，
- 0 表示头部 已被掩盖。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — (可选) 可以选择直接传递 embedding 表示，而不是传递input_ids。 如果您希望比模型的内部 embedding 查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 编码器最后一层输出端的隐藏状态序列。 如果模型配置为解码器，则在 cross-attention 中使用。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 避免对编码器输入的 padding token 索引执行 attention 的掩码。 如果模型配置为解码器，则此掩码在 cross-attention 中使用。 掩码值在[0, 1]中选择：- 1 表示头部 未被掩盖，
- 0 表示头部 已被掩盖。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.BaseModelOutputWithCrossAttentions or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithCrossAttentions 或 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层输出端的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型有 embedding 层，则为 embedding 输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True且config.add_cross_attention=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。解码器 cross-attention 层的 attention 权重，在 attention softmax 之后，用于计算 cross-attention 头部的加权平均值。
ElectraModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ElectraModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraModel.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateElectraForPreTraining
class transformers.ElectraForPreTraining
< source >( config )
参数
- config (ElectraConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有二元分类头的 Electra 模型，置于顶部，在预训练期间用于识别生成的 tokens。
建议将判别器检查点加载到该模型中。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获得索引。 参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于 nullify 自注意力模块的选定 head 的掩码。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的 hidden-states 序列。如果模型配置为 decoder，则在 cross-attention 中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), 可选) — 用于避免在编码器输入的 padding token 索引上执行 attention 的掩码。如果模型配置为 decoder，则此掩码在 cross-attention 中使用。掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算 ELECTRA 损失的标签。输入应为 token 序列（参见input_ids文档字符串）。索引应在[0, 1]中：- 0 表示 token 是原始 token，
- 1 表示 token 已被替换。
返回
transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.electra.modeling_electra.ElectraForPreTrainingOutput 或一个 torch.FloatTensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含取决于配置 (ElectraConfig) 和输入的各种元素。
-
loss (可选, 当提供
labels时返回,torch.FloatTensor，形状为(1,)) — ELECTRA 目标的总损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length)) — head 的预测得分（SoftMax 之前每个 token 的得分）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的 Tuple（embeddings 的输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
ElectraForPreTraining 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import ElectraForPreTraining, AutoTokenizer
>>> import torch
>>> discriminator = ElectraForPreTraining.from_pretrained("google/electra-base-discriminator")
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-base-discriminator")
>>> sentence = "The quick brown fox jumps over the lazy dog"
>>> fake_sentence = "The quick brown fox fake over the lazy dog"
>>> fake_tokens = tokenizer.tokenize(fake_sentence, add_special_tokens=True)
>>> fake_inputs = tokenizer.encode(fake_sentence, return_tensors="pt")
>>> discriminator_outputs = discriminator(fake_inputs)
>>> predictions = torch.round((torch.sign(discriminator_outputs[0]) + 1) / 2)
>>> fake_tokens
['[CLS]', 'the', 'quick', 'brown', 'fox', 'fake', 'over', 'the', 'lazy', 'dog', '[SEP]']
>>> predictions.squeeze().tolist()
[0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0]ElectraForCausalLM
class transformers.ElectraForCausalLM
< source >( config )
参数
- config (ElectraConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
ELECTRA 模型，顶部带有 language modeling head，用于 CLM 微调。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.List[torch.Tensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获得索引。 参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在 padding 标记索引上执行注意力机制。掩码值在[0, 1]中选择：1表示标记未被掩码，0表示标记已被掩码。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token indices（片段标记索引），用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：0对应于 sentence A 标记，1对应于 sentence B 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于 nullify (置零) 自注意力模块中选定的 head (头)。掩码值在[0, 1]中选择：1表示 head 未被掩码，0表示 head 已被掩码。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层的输出端的隐藏状态序列。如果模型配置为解码器，则在交叉注意力机制中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在编码器输入的 padding 标记索引上执行注意力机制。如果模型配置为解码器，则此掩码在交叉注意力机制中使用。掩码值在[0, 1]中选择：1表示 head 未被掩码，0表示 head 已被掩码。
- output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的 tuple。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层的输出端的隐藏状态序列。如果模型配置为解码器，则在交叉注意力机制中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在编码器输入的 padding 标记索引上执行注意力机制。如果模型配置为解码器，则此掩码在交叉注意力机制中使用。掩码值在[0, 1]中选择：1表示标记未被掩码，0表示标记已被掩码。
- labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算从左到右语言建模损失的标签（下一个单词预测）。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。 - past_key_values (
tuple(tuple(torch.FloatTensor))，长度为config.n_layers，每个 tuple 包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含注意力模块的预先计算的 key 和 value 隐藏状态。可用于加速解码。如果使用
past_key_values，用户可以选择仅输入最后的decoder_input_ids（那些没有将其过去的 key value 状态提供给此模型的输入 ID），其形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测得分（SoftMax 之前每个词汇表标记的得分）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型有 embedding 层，则为 embedding 输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，当传递了output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的 tuple（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的交叉注意力权重，用于计算交叉注意力 head 中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递了use_cache=True或当config.use_cache=True时返回) —torch.FloatTensortuple 的 tuple，长度为config.n_layers，每个 tuple 包含自注意力模块和交叉注意力模块的缓存 key，value 状态（如果模型用于编码器-解码器设置）。仅当config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力模块中的 key 和 value），可以用于（参见
past_key_values输入）加速顺序解码。
ElectraForCausalLM forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ElectraForCausalLM, ElectraConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-base-generator")
>>> config = ElectraConfig.from_pretrained("google/electra-base-generator")
>>> config.is_decoder = True
>>> model = ElectraForCausalLM.from_pretrained("google/electra-base-generator", config=config)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsElectraForMaskedLM
class transformers.ElectraForMaskedLM
< source >( config )
参数
- config (ElectraConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有语言建模 head 的 Electra 模型。
即使判别器和生成器都可以加载到此模型中，但生成器是两个模型中唯一一个经过掩码语言建模任务训练的模型。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在 padding 标记索引上执行注意力机制。掩码值在[0, 1]中选择：1表示标记未被掩码，0表示标记已被掩码。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token indices（片段标记索引），用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：0对应于 sentence A 标记，1对应于 sentence B 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头是未被掩蔽的，
- 0 表示头是被掩蔽的。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在编码器输入的填充标记索引上执行注意力的掩码。如果模型配置为解码器，则此掩码在交叉注意力中使用。掩码值在[0, 1]中选择：- 1 表示头是未被掩蔽的，
- 0 表示头是被掩蔽的。
- output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - 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 时），包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测得分（SoftMax 之前每个词汇表标记的得分）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型有 embedding 层，则为 embedding 输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
ElectraForMaskedLM forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ElectraForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-generator")
>>> model = ElectraForMaskedLM.from_pretrained("google/electra-small-generator")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of [MASK]
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
'paris'
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
1.22ElectraForSequenceClassification
class transformers.ElectraForSequenceClassification
< source >( config )
参数
- config (ElectraConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
ELECTRA 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.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 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头是未被掩蔽的，
- 0 表示头是被掩蔽的。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在编码器输入的填充标记索引上执行注意力的掩码。如果模型配置为解码器，则此掩码在交叉注意力中使用。掩码值在[0, 1]中选择：- 1 表示头是未被掩蔽的，
- 0 表示头是被掩蔽的。
- output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组 (plain tuple)。 - labels (
torch.LongTensor, 形状为(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[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 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,), optional, 当提供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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型有 embedding 层，则为 embedding 输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
ElectraForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, ElectraForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-emotion")
>>> model = ElectraForSequenceClassification.from_pretrained("bhadresh-savani/electra-base-emotion")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
'joy'
>>> # 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 = ElectraForSequenceClassification.from_pretrained("bhadresh-savani/electra-base-emotion", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.06多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, ElectraForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-emotion")
>>> model = ElectraForSequenceClassification.from_pretrained("bhadresh-savani/electra-base-emotion", 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 = ElectraForSequenceClassification.from_pretrained(
... "bhadresh-savani/electra-base-emotion", 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).lossElectraForMultipleChoice
class transformers.ElectraForMultipleChoice
< source >( config )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
ELECTRA 模型，顶部带有一个多项选择分类头 (pooled 输出顶部的一个线性层和一个 softmax)，例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获得索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length), optional) — 用于避免在 padding 标记索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩蔽，
- 0 表示标记被掩蔽。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length), optional) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A 标记，
- 1 对应于 sentence B 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), optional) — 用于 nullify 自注意力模块的选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩蔽，
- 0 表示头被掩蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, hidden_size), optional) — 编码器最后一层的输出端的隐藏状态序列。如果在模型配置为解码器时，则在 cross-attention 中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length), optional) — 用于避免对编码器输入的 padding 标记索引执行 attention 的掩码。如果模型配置为解码器，则此掩码在 cross-attention 中使用。掩码值在[0, 1]中选择：- 1 表示头未被掩蔽，
- 0 表示头被掩蔽。
- output_attentions (
bool, optional) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参见返回的张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回的张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组 (plain tuple)。 - labels (
torch.LongTensor，形状为(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在[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 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
torch.FloatTensor，形状为 (1,), optional, 当提供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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型有 embedding 层，则为 embedding 输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
ElectraForMultipleChoice forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ElectraForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = ElectraForMultipleChoice.from_pretrained("google/electra-small-discriminator")
>>> 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.logitsElectraForTokenClassification
class transformers.ElectraForTokenClassification
< source >( config )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
Electra 模型，顶部带有一个标记分类头。
鉴别器 (discriminator) 和生成器 (generator) 都可以加载到此模型中。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 详见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 tokens 不被 masked，
- 0 表示 tokens 被 masked。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置 embeddings 中每个输入序列 tokens 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 heads 的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 head 不被 masked，
- 0 表示 head 被 masked。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。 如果您希望比模型的内部 embedding lookup matrix 更好地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的 hidden-states 序列。 如果模型配置为解码器，则在 cross-attention 中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在编码器输入的 padding token 索引上执行 attention 的 Mask。 如果模型配置为解码器，则此 mask 在 cross-attention 中使用。 Mask 值在[0, 1]中选择：- 1 表示 head 不被 masked，
- 0 表示 head 被 masked。
- output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参见返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算 token 分类损失的标签。 索引应在[0, ..., config.num_labels - 1]中。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型有 embedding 层，则为 embedding 输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
ElectraForTokenClassification 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ElectraForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-discriminator-finetuned-conll03-english")
>>> model = ElectraForTokenClassification.from_pretrained("bhadresh-savani/electra-base-discriminator-finetuned-conll03-english")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
['B-LOC', 'B-ORG', 'O', 'O', 'O', 'O', 'O', 'B-LOC', 'O', 'B-LOC', 'I-LOC']
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.11ElectraForQuestionAnswering
class transformers.ElectraForQuestionAnswering
< source >( config )
参数
- config (ElectraConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
ELECTRA 模型，顶部带有跨度分类头，用于抽取式问答任务，如 SQuAD（hidden-states 输出顶部的一个线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embedding 大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 详见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 tokens 不被 masked，
- 0 表示 tokens 被 masked。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置 embeddings 中每个输入序列 tokens 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 heads 的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 head 不被 masked，
- 0 表示 head 被 masked。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — (可选) 您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层的输出端的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码在交叉注意力中使用。掩码值在[0, 1]中选择：- 1 表示头部未被掩蔽，
- 0 表示头部被掩蔽。
- 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 时），包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型有 embedding 层，则为 embedding 输出层 + 每个层输出层各一个)。模型在每一层输出端的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
ElectraForQuestionAnswering 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ElectraForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-squad2")
>>> model = ElectraForQuestionAnswering.from_pretrained("bhadresh-savani/electra-base-squad2")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
'a nice puppet'
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([11])
>>> target_end_index = torch.tensor([12])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
2.64TFElectraModel
class transformers.TFElectraModel
< source >( config *inputs **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
裸 Electra 模型，输出原始隐藏状态，顶部没有任何特定的头部。与 BERT 模型相同，只是如果隐藏层大小和 embedding 大小不同，它会在 embedding 层和编码器之间使用额外的线性层。生成器和判别器检查点都可以加载到此模型中。
此模型继承自 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 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor，可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示标记未被掩蔽，
- 0 表示标记被掩蔽。
- position_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor，可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]中选择：- 1 表示头部未被掩蔽，
- 0 表示头部被掩蔽。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor，可选) — (可选) 您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。 - encoder_hidden_states (
tf.Tensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层的输出处的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
tf.Tensor, 形状为(batch_size, sequence_length), 可选) — 避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则在交叉注意力中使用此掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- past_key_values (
Tuple[Tuple[tf.Tensor]], 长度为config.n_layers) — 包含注意力块的预计算的键和值隐藏状态。可用于加速解码。如果使用past_key_values，则用户可以选择仅输入最后一次的decoder_input_ids(那些没有将其过去的键值状态提供给此模型的)，形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, optional, 默认为True) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。训练期间设置为False，生成期间设置为True。
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tf.Tensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包括各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
last_hidden_state (
tf.Tensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
List[tf.Tensor], 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含预先计算的隐藏状态（注意力模块中的 key 和 value），可以用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
-
cross_attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器 cross-attention 层的 attention 权重，在 attention softmax 之后，用于计算 cross-attention 头部的加权平均值。
TFElectraModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFElectraModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = TFElectraModel.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFElectraForPreTraining
class transformers.TFElectraForPreTraining
< 源代码 >( config **kwargs )
参数
- config (ElectraConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有二元分类头的 Electra 模型，置于顶部，在预训练期间用于识别生成的 tokens。
即使鉴别器和生成器都可以加载到此模型中，但鉴别器是两个模型中唯一具有正确分类头的模型，可以用于此模型。
此模型继承自 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 函数一样传递输入！
call
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: 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: Optional[bool] = False ) → transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput 或 tuple(tf.Tensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- position_ids (形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor, 可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的Numpy array或tf.Tensor, 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩盖，
- 0 表示头被掩盖。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的tf.Tensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回的张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回的张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。
返回
transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput 或 tuple(tf.Tensor)
一个 transformers.models.electra.modeling_tf_electra.TFElectraForPreTrainingOutput 或 tf.Tensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包括各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (可选, 当提供
labels时返回, 形状为(1,)的tf.Tensor) — ELECTRA 目标的总损失。 -
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)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
TFElectraForPreTraining 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFElectraForPreTraining
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = TFElectraForPreTraining.from_pretrained("google/electra-small-discriminator")
>>> input_ids = tf.constant(tokenizer.encode("Hello, my dog is cute"))[None, :] # Batch size 1
>>> outputs = model(input_ids)
>>> scores = outputs[0]TFElectraForMaskedLM
class transformers.TFElectraForMaskedLM
< 源代码 >( config **kwargs )
参数
- config (ElectraConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模 head 的 Electra 模型。
即使判别器和生成器都可以加载到此模型中，但生成器是两个模型中唯一一个经过掩码语言建模任务训练的模型。
此模型继承自 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 函数一样传递输入！
call
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: 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: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以通过 AutoTokenizer 获得。 参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 以了解详情。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于 nullify 自注意力模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参见返回的 tensors 下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。 此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于计算 masked language modeling loss 的标签。 索引应在[-100, 0, ..., config.vocab_size]中（请参阅input_ids文档字符串）。 索引设置为-100的 tokens 将被忽略（masked），loss 仅针对标签在[0, ..., config.vocab_size]中的 tokens 计算。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 tf.Tensor 的 tuple（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含取决于配置 (ElectraConfig) 和输入的各种元素。
-
loss (
tf.Tensor，形状为(n,), 可选, 其中 n 是非 masked 标签的数量，当提供labels时返回) — Masked language modeling (MLM) 损失。 -
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
hidden_states (
tuple(tf.Tensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
TFElectraForMaskedLM forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFElectraForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-generator")
>>> model = TFElectraForMaskedLM.from_pretrained("google/electra-small-generator")
>>> 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)
>>> tokenizer.decode(predicted_token_id)
'paris'TFElectraForSequenceClassification
class transformers.TFElectraForSequenceClassification
< source >( config *inputs **kwargs )
参数
- config (ElectraConfig) — 模型配置类，其中包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，而只会加载配置。 查看 from_pretrained() 方法以加载模型权重。
ELECTRA 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 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 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: 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: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以通过 AutoTokenizer 获得。 参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 以了解详情。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于 nullify 自注意力模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参见返回的 tensors 下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组。此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（一些模块，如 dropout 模块，在训练和评估之间有不同的行为）。 - labels (
tf.Tensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失）；如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput or tuple(tf.Tensor)
A transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tf.Tensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
tf.Tensorof shape(batch_size, ), optional, returned whenlabelsis provided) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
tf.Tensorof shape(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)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
The TFElectraForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFElectraForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-emotion")
>>> model = TFElectraForSequenceClassification.from_pretrained("bhadresh-savani/electra-base-emotion")
>>> 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])
>>> model.config.id2label[predicted_class_id]
'joy'>>> # 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 = TFElectraForSequenceClassification.from_pretrained("bhadresh-savani/electra-base-emotion", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.06TFElectraForMultipleChoice
class transformers.TFElectraForMultipleChoice
< source >( config *inputs **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
ELECTRA 模型，顶部带有一个多项选择分类头 (pooled 输出顶部的一个线性层和一个 softmax)，例如用于 RocStories/SWAG 任务。
此模型继承自 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 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: 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: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length)) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length), optional) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 已被 Mask。
- position_ids (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length), optional) — 每个输入序列 tokens 在位置 embeddings 中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
Numpy arrayortf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用于 nullify self-attention 模块的选定 heads 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
- inputs_embeds (
tf.Tensorof shape(batch_size, num_choices, sequence_length, hidden_size), optional) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参见返回的 tensors 下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下，将使用 config 中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的 hidden states。 有关更多详细信息，请参见返回的 tensors 下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下，将使用 config 中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组。此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（一些模块，如 dropout 模块，在训练和评估之间有不同的行为）。 - labels (
tf.Tensorof shape(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices]中，其中num_choices是输入 tensors 的第二个维度的大小。（请参见上面的input_ids）
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput or tuple(tf.Tensor)
A transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tf.Tensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
tf.Tensorof shape (batch_size, ), optional, returned whenlabelsis provided) — 分类损失。 -
logits (
tf.Tensorof shape(batch_size, num_choices)) — num_choices 是输入 tensors 的第二个维度。（请参见上面的 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)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
The TFElectraForMultipleChoice forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFElectraForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = TFElectraForMultipleChoice.from_pretrained("google/electra-small-discriminator")
>>> 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.logitsTFElectraForTokenClassification
class transformers.TFElectraForTokenClassification
< source >( config **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
Electra 模型，顶部带有一个标记分类头。
鉴别器 (discriminator) 和生成器 (generator) 都可以加载到此模型中。
此模型继承自 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 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: 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: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 详见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 以了解详情。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 被掩盖。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 tokens 在 position embeddings 中的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。 此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于计算 token 分类损失的标签。 索引应在[0, ..., config.num_labels - 1]中。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个 tf.Tensor 的 tuple （如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
tf.Tensor，形状为(n,)，可选，当提供labels时返回，其中 n 是未掩盖标签的数量) — 分类损失。 -
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)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
TFElectraForTokenClassification 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFElectraForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-discriminator-finetuned-conll03-english")
>>> model = TFElectraForTokenClassification.from_pretrained("bhadresh-savani/electra-base-discriminator-finetuned-conll03-english")
>>> 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()]
>>> predicted_tokens_classes
['B-LOC', 'B-ORG', 'O', 'O', 'O', 'O', 'O', 'B-LOC', 'O', 'B-LOC', 'I-LOC']TFElectraForQuestionAnswering
class transformers.TFElectraForQuestionAnswering
< source >( config *inputs **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有跨度分类头的 Electra 模型，用于抽取式问答任务，如 SQuAD（在 hidden-states 输出之上使用线性层来计算 span start logits 和 span end logits）。
此模型继承自 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 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: 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: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。 详见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 以了解详情。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 被掩盖。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 tokens 在 position embeddings 中的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组。此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - start_positions (
tf.Tensorof shape(batch_size,), optional) — 用于计算 token 分类损失的标签跨度开始位置（索引）。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不计入损失计算。 - end_positions (
tf.Tensorof shape(batch_size,), optional) — 用于计算 token 分类损失的标签跨度结束位置（索引）。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不计入损失计算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
loss (
tf.Tensorof shape(batch_size, ), optional, 当提供start_positions和end_positions时返回) — 总跨度提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
tf.Tensorof shape(batch_size, sequence_length)) — 跨度起始得分（在 SoftMax 之前）。 -
end_logits (
tf.Tensorof shape(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)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
TFElectraForQuestionAnswering 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFElectraForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("bhadresh-savani/electra-base-squad2")
>>> model = TFElectraForQuestionAnswering.from_pretrained("bhadresh-savani/electra-base-squad2")
>>> 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]
>>> tokenizer.decode(predict_answer_tokens)
'a nice puppet'FlaxElectraModel
class transformers.FlaxElectraModel
< source >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 Electra 模型 Transformer 输出原始隐藏状态，顶部没有任何特定的 head。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarrayof shape(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 掩码，以避免在 padding token 索引上执行 attention。在[0, 1]中选择的掩码值：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
- token_type_ids (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 分段 token 索引，以指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 每个输入序列 tokens 在位置 embeddings 中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarrayof shape(batch_size, sequence_length),optional) -- 用于 nullify attention 模块的选定 head 的掩码。在[0, 1]` 中选择的掩码值：- 1 表示 head 未被掩盖，
- 0 表示 head 已被掩盖。
- return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组。
返回
transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
last_hidden_state (
jnp.ndarrayof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraModel
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraModel.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxElectraForPreTraining
class transformers.FlaxElectraForPreTraining
< source >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有二元分类头的 Electra 模型，置于顶部，在预训练期间用于识别生成的 tokens。
建议将判别器检查点加载到该模型中。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.models.electra.modeling_flax_electra.FlaxElectraForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarrayof shape(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 掩码，以避免在 padding token 索引上执行 attention。在[0, 1]中选择的掩码值：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 已被掩盖。
- token_type_ids (
numpy.ndarrayof shape(batch_size, sequence_length), optional) — 分段 token 索引，以指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 用于置空的注意力模块中选定头的掩码。在[0, 1]中选择掩码值：- 1 表示头未被掩蔽，
- 0 表示头被掩蔽。
- return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。
返回
transformers.models.electra.modeling_flax_electra.FlaxElectraForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.electra.modeling_flax_electra.FlaxElectraForPreTrainingOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (ElectraConfig) 和输入的各种元素。
-
logits (
jnp.ndarray，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraForPreTraining
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForPreTraining.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsFlaxElectraForCausalLM
class transformers.FlaxElectraForCausalLM
< 源码 >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
Electra 模型，顶部带有一个语言建模头（隐藏状态输出之上的线性层），例如用于自回归任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 源码 >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力的掩码。 在[0, 1]中选择掩码值：- 1 代表未被掩蔽的标记，
- 0 代表被掩蔽的标记。
- token_type_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一部分和第二部分。 在[0, 1]中选择索引：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 用于置空的注意力模块中选定头的掩码。在[0, 1]中选择掩码值：- 1 表示头未被掩蔽，
- 0 表示头被掩蔽。
- return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。
返回
transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (ElectraConfig) 和输入的各种元素。
-
logits (
jnp.ndarray，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。注意力 softmax 之后的交叉注意力权重，用于计算交叉注意力 head 中的加权平均值。
-
past_key_values (
tuple(tuple(jnp.ndarray))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的jnp.ndarray元组的元组，如果模型用于编码器-解码器设置，则每个元组包含自注意力层和交叉注意力层的缓存键、值状态。 仅当config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力模块中的 key 和 value），可以用于（参见
past_key_values输入）加速顺序解码。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForCausalLM.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]FlaxElectraForMaskedLM
class transformers.FlaxElectraForMaskedLM
< 源码 >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
Electra 模型，顶部带有一个 language modeling 头。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 源码 >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力的掩码。 在[0, 1]中选择掩码值：- 1 代表未被掩蔽的标记，
- 0 代表被掩蔽的标记。
- token_type_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一部分和第二部分。 在[0, 1]中选择索引：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，optional) -- 用于置空注意力模块中选定 head 的掩码。掩码值在[0, 1]` 中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
logits (
jnp.ndarray，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraForMaskedLM
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForMaskedLM.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxElectraForSequenceClassification
class transformers.FlaxElectraForSequenceClassification
< source >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
Electra 模型转换器，顶部带有序列分类/回归 head（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding 标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩蔽，
- 0 表示标记被掩蔽。
- token_type_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A 标记，
- 1 对应于 sentence B 标记。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，optional) -- 用于置空注意力模块中选定 head 的掩码。掩码值在[0, 1]` 中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
logits (
jnp.ndarray，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForSequenceClassification.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxElectraForMultipleChoice
class transformers.FlaxElectraForMultipleChoice
< source >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
ELECTRA 模型，顶部带有一个多项选择分类头 (pooled 输出顶部的一个线性层和一个 softmax)，例如用于 RocStories/SWAG 任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, num_choices, sequence_length)，可选) — 用于避免在 padding 标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩蔽，
- 0 表示标记被掩蔽。
- token_type_ids (
numpy.ndarray，形状为(batch_size, num_choices, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A 标记，
- 1 对应于 sentence B 标记。
- position_ids (
numpy.ndarray，形状为(batch_size, num_choices, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarray，形状为(batch_size, num_choices, sequence_length)，optional) -- 用于置空注意力模块中选定 head 的掩码。掩码值在[0, 1]` 中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
logits (
jnp.ndarray，形状为(batch_size, num_choices)) — num_choices 是输入张量的第二个维度。（参见上面的input_ids）。分类分数（在 SoftMax 之前）。
-
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraForMultipleChoice
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForMultipleChoice.from_pretrained("google/electra-small-discriminator")
>>> 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="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})
>>> logits = outputs.logitsFlaxElectraForTokenClassification
class transformers.FlaxElectraForTokenClassification
< source >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
Electra 模型，顶部带有一个标记分类头。
鉴别器 (discriminator) 和生成器 (generator) 都可以加载到此模型中。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获取。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- token_type_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) -- 用于置空 attention 模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
logits (
jnp.ndarray，形状为(batch_size, sequence_length, config.num_labels)) — 分类得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraForTokenClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForTokenClassification.from_pretrained("google/electra-small-discriminator")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxElectraForQuestionAnswering
class transformers.FlaxElectraForQuestionAnswering
< source >( config: ElectraConfig input_shape: typing.Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (ElectraConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
ELECTRA 模型，顶部带有跨度分类头，用于抽取式问答任务，如 SQuAD（hidden-states 输出顶部的一个线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如，从 PyTorch 模型下载、保存和转换权重）
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参阅 Flax 文档，了解与常规用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: dict = None ) → transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获取。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
- token_type_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
numpy.ndarray，形状为(batch_size, sequence_length)，可选) -- 用于置空 attention 模块中选定 head 的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (ElectraConfig) 和输入。
-
start_logits (
jnp.ndarray，形状为(batch_size, sequence_length)) — Span-start 得分（SoftMax 之前）。 -
end_logits (
jnp.ndarray，形状为(batch_size, sequence_length)) — Span-end 得分（SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出的 Hidden-states 加上初始 embedding 输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的权重，用于计算自注意力头部的加权平均值。
FlaxElectraPreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxElectraForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("google/electra-small-discriminator")
>>> model = FlaxElectraForQuestionAnswering.from_pretrained("google/electra-small-discriminator")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")
>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits