Transformers文档

BERT

Hugging Face's logo
加入Hugging Face社区

享受增强型文档体验

开始使用

Models Spaces

论文摘要如下

我们介绍了一种新的语言表示模型,称为 BERT,代表“ bidirectional Encoder Representations from Transformers”。与近期语言表示模型不同,BERT 通过在所有层中对左右上下文进行联合条件训练,从未标记的文本中预训练深度双向表示。因此,预训练的 BERT 模型只需增加一个输出层即可微调,从而为广泛的任务创建最先进的模型,例如问答和语言推理,无需对特定架构进行重大修改。

BERT 概念简单,实证强大。在十一个自然语言处理任务上获得了新的最先进结果,包括将 GLUE 得分推高到 80.5%(提高了 7.7 个绝对点),MultiNLI 准确性达到 86.7%(提高了 4.6 个绝对点),SQuAD v1.1 问答测试 F1 分数达到 93.2(提高了 1.5 个绝对点),SQuAD v2.0 测试 F1 分数达到 83.1(提高了 5.1 个绝对点)。

此模型由 thomwolf 提供。原始代码可在此处找到。

使用说明

  • BERT 是一个具有绝对位置嵌入的模型,所以通常建议在右边而不是左边填充输入。

  • BERT 通过掩码语言建模(MLM)和下一句预测(NSP)目标进行训练。它在预测掩码标记和一般 NLU 方面效率很高,但不是文本生成的最佳选择。

  • 通过随机掩码破坏输入,更精确地说,在预训练期间,给定百分比的标记(通常是 15%)通过以下方式被掩码:

    • 以 0.8 的概率掩码一个特殊的掩码标记
    • 以 0.1 的概率随机掩码不同的标记
    • 以 0.1 的概率使用相同的标记
  • 模型必须预测原始句子,但有一个第二个目标:输入是两个句子 A 和 B(之间有一个分隔符标记)。以 50% 的概率,这些句子在语料库中连续,而在剩余的 50% 中,它们不相关。模型必须预测这两个句子是否连续。

使用缩放点积注意力(SDPA)

PyTorch 在 torch.nn.functional 中包含了一个本地的缩放点积注意力(SDPA)操作。此函数包括多个实现,可以根据输入和使用的硬件进行应用。请参阅官方文档GPU 推理页面获取更多信息。

当有实现可用时,从2.1.1版本开始,SDPA 成为默认使用的,但您也可以在from_pretrained()中设置attn_implementation="sdpa"以显式请求使用SDPA。

from transformers import BertModel

model = BertModel.from_pretrained("bert-base-uncased", torch_dtype=torch.float16, attn_implementation="sdpa")
...

为了获得最佳速度提升,我们建议以半精度(例如,torch.float16torch.bfloat16)加载模型。

在一个本地基准测试(A100-80GB,CPUx12,RAM 96.6GB,PyTorch 2.2.0,OS Ubuntu 22.04)中,我们使用float16看到了以下训练和推理的速度提升。

训练

批大小 序列长度 每批处理的时间(贪婪 - s) 每批处理的时间(SDPA - s) 速度提升(%) 贪婪峰值内存(MB) SDPA 峰值内存(MB) 内存节省(%)
4 256 0.023 0.017 35.472 939.213 764.834 22.800
4 512 0.023 0.018 23.687 1970.447 1227.162 60.569
8 256 0.023 0.018 23.491 1594.295 1226.114 30.028
8 512 0.035 0.025 43.058 3629.401 2134.262 70.054
16 256 0.030 0.024 25.583 2874.426 2134.262 34.680
16 512 0.064 0.044 46.223 6964.659 3961.013 75.830

推理

批大小 序列长度 每令牌延迟贪婪(ms) 每令牌延迟SDPA(ms) 速度提升(%) 贪婪内存(MB) 内存 BT(MB) 内存节省(%)
1 128 5.736 4.987 15.022 282.661 282.924 -0.093
1 256 5.689 4.945 15.055 298.686 298.948 -0.088
2 128 6.154 4.982 23.521 314.523 314.785 -0.083
2 256 6.201 4.949 25.303 347.546 347.033 0.148
4 128 6.049 4.987 21.305 378.895 379.301 -0.107
4 256 6.285 5.364 17.166 443.209 444.382 -0.264

资源

这是一份官方的Hugging Face和社区(由🌎表示)资源列表,帮助您开始使用BERT。如果您想提交资源被包含在此处,请随意提交Pull Request,我们将对此进行审查!资源最好能够展示一些新内容而不是重复现有资源。

文本分类
标记分类
填充掩码
问题回答

多项选择

⚡️ 推理

⚙️ 预训练

🚀 部署

BertConfig

transformers.BertConfig

< >

( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 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 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )

参数

  • vocab_size (int, 可选, 默认为 30522) — BERT 模型的词汇大小。定义了在调用 BertModelTFBertModel 时通过 inputs_ids 传入的可以表示的不同标记的数量。
  • hidden_sizeint可选,默认为768)— 编码器层和池化层维度。
  • num_hidden_layersint可选,默认为12)— Transformer编码器中的隐藏层数量。
  • num_attention_headsint可选,默认为12)— Transformer编码器中每层注意力层的注意力头数量。
  • intermediate_sizeint可选,默认为3072)— Transformer编码器中“中间”层(通常称为前馈层)的维度。
  • hidden_act (str or Callable, 可选,默认为 "gelu") — 编码器和池器中的非线性激活函数(函数或字符串)。如果为字符串,支持 "gelu""relu""silu""gelu_new"
  • hidden_dropout_prob (float, 可选,默认为 0.1) — 在嵌入、编码器和池器中所有全连接层的dropout概率。
  • attention_probs_dropout_prob (float, 可选,默认为 0.1) — 注意力概率的dropout比例。
  • 最大序列长度嵌入量(int,可选,默认为 512)— 此模型可能使用的最大序列长度。通常将其设置为某个大数值以防万一(例如,512、1024 或 2048)。
  • 类型词汇表大小(int,可选,默认为 2)— 在调用 BertModelTFBertModel 时传递的 token_type_ids 的词汇表大小。
  • 初始化范围(float,可选,默认为 0.02)— 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float, 可选,默认为 1e-12) — 层归一化中使用的 epsilon 值。
  • position_embedding_type (str, 可选,默认为 "absolute") — 位置嵌入的类型。可选 "absolute""relative_key""relative_query_key" 中的一个。用于位置嵌入时选择 "absolute"。关于 "relative_key" 的更多信息,请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。关于 "relative_query_key" 的更多信息,请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的第 4 个方法。
  • is_decoder (bool, 可选,默认为 False) — 模型是否用作解码器。如果为 False,模型用作编码器。
  • use_cache (bool, 可选, 默认值 True) — 模型是否应返回最后的key/values注意力(并非所有模型都使用)。只有当 config.is_decoder=True 才有效。
  • classifier_dropout (float, 可选) — 分类头部的dropout比例。

这是存储BERT模型或TFBert模型配置的配置类。它根据指定的参数实例化BERT模型,定义模型架构。使用默认值实例化配置将产生类似于BERT google-bert/bert-base-uncased 架构的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。更多详细信息,请参阅PretrainedConfig文档。

示例

>>> from transformers import BertConfig, BertModel

>>> # Initializing a BERT google-bert/bert-base-uncased style configuration
>>> configuration = BertConfig()

>>> # Initializing a model (with random weights) from the google-bert/bert-base-uncased style configuration
>>> model = BertModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

BertTokenizer

transformers.BertTokenizer

< >

( 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 **kwargs )

参数

  • vocab_file (str) — 包含词汇的文件。
  • do_lower_case (bool, 可选,默认为 True) — 分词时是否将输入转换为小写。
  • do_basic_tokenize (bool, 可选,默认为 True) — 在 WordPiece 之前是否执行基本分词。
  • never_split ( Iterable可选) — 分词时将不会被拆分的标记集合。只有当 do_basic_tokenize=True 时才有效。
  • unk_token (str可选,默认为 "[UNK]") — 未知标记。不在词汇表中的标记无法转换为 ID,将被设置为该标记。
  • sep_token (str, 可选, 默认为 "[SEP]") — 用来拼接着多段序列的分隔符,例如分类任务中的序列分类或问答任务中的文本和问题。它也被用作特殊标记构建的序列的最后一个标记。
  • pad_token (str, 可选, 默认为 "[PAD]") — 用来填充的标记,例如在处理不同长度的序列时使用。
  • cls_token (str, 可选, 默认为 "[CLS]") — 序列分类时使用的分类标记(整个序列的分类,而非逐标记分类)。当使用特殊标记构建序列时,它是序列的第一个标记。
  • mask_token (str, 可选, 默认为 "[MASK]") — 用于遮盖值的标记。训练此模型进行掩码语言模型时使用此标记。这是模型将尝试预测的标记。
  • tokenize_chinese_chars (bool, 可选, 默认为 True) — 是否对中文字符进行分词。

    对于日语,此功能可能应停用(见此 问题)。

  • strip_accents (bool, 可选) — 是否去除所有重音符号。如果不指定此选项,则将根据 lowercase 的值(如原始 BERT)确定。

构建一个 BERT 分词器。基于 WordPiece。

该分词器继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考这个超类以了解有关这些方法的更多信息。

build_inputs_with_special_tokens

< >

( token_ids_0: List token_ids_1: Optional = None ) List[int]

参数

  • token_ids_0 (List[int]) — 要添加特殊标记的ID列表。
  • token_ids_1 (List[int], optional) — 可选的第二个序列对ID的列表。

返回

List[int]

具有适当特殊标记的输入ID列表。

通过连接和添加特殊标记,从序列或序列对构建模型输入,以进行序列分类任务。BERT序列具有以下格式

  • 单个序列:[CLS] X [SEP]
  • 序列对:[CLS] A [SEP] B [SEP]

get_special_tokens_mask

< >

( token_ids_0: 列表 token_ids_1: 有可能 = None already_has_special_tokens: bool ) 列表[int]

参数

  • token_ids_0 (列表[int]) — ID 列表。
  • token_ids_1 (列表[int], 可选) — 用于序列对的第二个 ID 列表(可选)。
  • already_has_special_tokens (bool, optional, defaults to False) — 判断token列表是否已经用特殊标记格式化。

返回

List[int]

范围在[0, 1]的整数列表:1代表特殊标记,0代表序列标记。

从没有添加特殊标记的token列表中获取序列ID。该方法在添加特殊标记时使用tokenizer的《prepare_for_model》方法。

create_token_type_ids_from_sequences

< >

( token_ids_0: List token_ids_1: Optional = None ) List[int]

参数

  • token_ids_0 (List[int]) — 标识ID列表。
  • token_ids_1 (List[int], optional) — 可选的第二序列 ID 列表。

返回

List[int]

按照给定的序列(s)创建的标记类型 ID列表。

从传入的两个序列创建一个掩码,用于序列对分类任务。一个 BERT 序列

对掩码的格式如下:

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1None,则此方法只返回掩码的第一部分(0s)。

保存词汇表

< >

( save_directory: str filename_prefix: Optional = None )

Pytorch
隐藏 Pytorch 内容

BertTokenizerFast

transformers.BertTokenizerFast

<

( 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 (布尔值,可选,默认为 True)— 当分词时是否将输入转换为小写。
  • unk_token (字符串,可选,默认为 "[UNK]")— 未知标记。如果标记不在词汇表中,无法转换为ID,则设置为该标记。
  • sep_token (字符串,可选,默认为 "[SEP]")— 分隔符标记,当从多个序列构建序列时使用,例如,用于序列分类的序列或用于问答中的文本和问题。它还用作使用特殊标记构建的序列的最后一个标记。
  • pad_token (字符串,可选,默认为 "[PAD]")— 用于填充的标记,例如,当将不同长度的序列批处理时。
  • cls_token (str, 可选,默认为 "[CLS]") — 用于序列分类(整个序列的分类而不是按令牌分类)的分类器令牌。当使用特殊令牌构建时,它是序列的第一个令牌。
  • mask_token (str, 可选,默认为 "[MASK]") — 用于掩盖值的令牌。当使用掩盖语言建模训练此模型时,这是模型将要预测的令牌。
  • clean_text (bool, 可选,默认为 True) — 是否在令牌化之前清理文本,移除所有控制字符,并用经典的空格替换所有空格。
  • tokenize_chinese_chars (bool, 可选, 默认为 True) — 是否分词中文字符。对于日语,可能需要关闭此选项(见 此问题)。
  • strip_accents (bool, 可选) — 是否移除所有重音符号。如果没有指定此选项,则由 lowercase 的值决定(类似于原始 BERT)。
  • wordpieces_prefix (str, 可选, 默认为 "##") — 子词的前缀。

构建一个“快速”的 BERT 分词器(由 HuggingFace 的 tokenizers 库支持)。基于 WordPiece。

该分词器继承自 PreTrainedTokenizerFast,其中包含大部分主要方法。用户应参考这个超类以获取更多关于这些方法的信息。

build_inputs_with_special_tokens

< >

( token_ids_0 token_ids_1 = None ) List[int]

参数

  • token_ids_0 (List[int]) — 要添加特殊标记的ID列表。
  • token_ids_1 (List[int], 可选) — 可选的第二个ID列表,用于序列对。

返回

List[int]

具有适当特殊标记的输入ID列表。

通过连接和添加特殊标记,从序列或序列对构建模型输入,以进行序列分类任务。BERT序列具有以下格式

  • 单个序列:[CLS] X [SEP]
  • 序列对:[CLS] A [SEP] B [SEP]

create_token_type_ids_from_sequences

< >

( token_ids_0: List token_ids_1: Optional = None ) List[int]

参数

  • token_ids_0 (列表[int]) — ID列表。
  • token_ids_1 (列表[int], 可选) — 可选的ID列表,用于序列对。

返回

List[int]

按照给定的序列(s)创建的标记类型 ID列表。

从传入的两个序列创建一个掩码,用于序列对分类任务。一个 BERT 序列

对掩码的格式如下:

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1None,则此方法只返回掩码的第一部分(0s)。

TensorFlow
隐藏TensorFlow内容

TFBertTokenizer

transformers.TFBertTokenizer

< >

( vocab_list: 列表 do_lower_case: 布尔型 cls_token_id: 整数型 = None sep_token_id: 整数型 = None pad_token_id: 整数型 = None padding: 字符串型 = 'longest' truncation: 布尔型 = True max_length: 整数型 = 512 pad_to_multiple_of: 整数型 = None return_token_type_ids: 布尔型 = True return_attention_mask: 布尔型 = True use_fast_bert_tokenizer: 布尔型 = True **tokenizer_kwargs )(

参数

  • vocab_list (列表) — 包含词汇列表。
  • do_lower_case (bool, 可选, 默认为 True) — 在标记化输入时是否小写输入。
  • cls_token_id (str, 可选, 默认为 "[CLS]") — 序列分类时使用的分类器标记(对整个序列进行分类而不是按标记分类)。当与特殊标记一起构建时,它是序列的第一个标记。
  • sep_token_id (str, 可选, 默认为 "[SEP]") — 分隔符标记,用于从多个序列构建序列时(例如,用于序列分类或问答中的文本和问题),它也是用特殊标记构建的序列的最后一个标记。
  • pad_token_id (str, 可选,默认为 "[PAD]") —— 用于填充的标记,例如在填充不同长度的序列时。
  • padding (str,默认为 "longest") —— 要使用的填充类型。可以是 "longest",只填充到批中最长样本的长度,或者 "max_length",将所有输入填充到分词器支持的最大长度。
  • truncation (bool, 可选,默认为 True) —— 是否截断序列到最大长度。
  • max_length (int, 可选, 默认为 512) — 序列的最大长度,用于填充(如果 padding 是 "max_length")和/或截断(如果 truncationTrue)。
  • pad_to_multiple_of (int, 可选, 默认为 None) — 如果设置,则序列将被填充成此值的倍数。
  • return_token_type_ids (bool, 可选, 默认为 True) — 是否返回 token_type_ids。
  • return_attention_mask (bool, 可选, 默认为 True) — 是否返回 attention_mask。
  • use_fast_bert_tokenizer (bool, 可选, 默认为 True) — 如果为 True,将使用 TensorFlow Text 的 FastBertTokenizer 类。如果为 False,将使用 BertTokenizer 类。BertTokenizer 支持一些附加选项,但速度较慢,无法导出到 TFLite。

这是 BERT 的图内分词器。它应该类似于其他分词器使用 from_pretrained() 方法进行初始化。它也可以使用 from_tokenizer() 方法进行初始化,该方法从现有标准分词器对象导入设置。

与其他 Hugging Face 分词器不同,图内分词器实际上是 Keras 层,旨在在模型调用时运行,而不是在预处理时运行。因此,它们的选项相对有限。当您想要创建一个直接从 tf.string 输入到输出的端到端模型时,它们最为有用。

from_pretrained

< >

( pretrained_model_name_or_path: 联合 *init_inputs **kwargs )

参数

  • pretrained_model_name_or_path (stros.PathLike) — 预训练标记化器的名称或路径。

从预训练标记化器实例化一个 TFBertTokenizer

示例

from transformers import TFBertTokenizer

tf_tokenizer = TFBertTokenizer.from_pretrained("google-bert/bert-base-uncased")

from_tokenizer

< >

( tokenizer: PreTrainedTokenizerBase **kwargs )

参数

  • tokenizer (PreTrainedTokenizerBase) — 初始化 TFBertTokenizer 时使用的标记化器。

从现有的 Tokenizer 初始化一个 TFBertTokenizer

示例

from transformers import AutoTokenizer, TFBertTokenizer

tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
tf_tokenizer = TFBertTokenizer.from_tokenizer(tokenizer)

特定于Bert的输出

transformers.models.bert.modeling_bert.BertForPreTrainingOutput

< >

( 损耗: 可选 = None 预测对数: FloatTensor = None 序列关系对数: FloatTensor = None 隐藏状态: 可选 = None 注意力: 可选 = None )

参数

  • 损耗 (可选,当提供labels时返回,形状为(1,)torch.FloatTensor,表示掩码语言建模损耗和下一个序列预测(分类)损耗的总和。
  • prediction_logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头部的预测得分(SoftMax前的每个词汇分数)。
  • seq_relationship_logits (torch.FloatTensor 形状为 (batch_size, 2)) — 下一个序列预测(分类)头部的预测得分(SoftMax前的True/False继续分数)。
  • hidden_states (tuple(torch.FloatTensor)可选,当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — Tuple of torch.FloatTensor (one for the output of the embeddings + one for the output of each layer) of shape (batch_size, sequence_length, hidden_size)

    模型在每层输出的隐藏状态以及初始嵌入输出的隐藏状态。

  • attentions (tuple(torch.FloatTensor), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 包含 torch.FloatTensor 的元组(每个层一个)的形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力软最大化后的权重,用于计算自注意力头中的加权平均值。

BertForPreTraining 的输出类型。

transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput

< >

( loss: tf.Tensor | None = None prediction_logits: tf.Tensor = None seq_relationship_logits: tf.Tensor = None hidden_states: Optional[Union[Tuple[tf.Tensor], tf.Tensor]] = None attentions: Optional[Union[Tuple[tf.Tensor], tf.Tensor]] = None )

参数

  • prediction_logits (tf.Tensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数(SoftMax之前每个词汇的分数)。
  • seq_relationship_logits (tf.Tensor 形状为 (batch_size, 2)) — 下一个序列预测(分类)头的预测分数(SoftMax之前True/False继续的分数)。
  • hidden_states (tuple(tf.Tensor), 可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 tf.Tensor 的元组(一个用于嵌入层的输出,一个用于每层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及初始嵌入输出。
  • attentions (tuple(tf.Tensor), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 由形为 (batch_size, num_heads, sequence_length, sequence_length)tf.Tensor 组成的元组(每个层一个)。

TFBertForPreTraining 的输出类型。

transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput

< >

( prediction_logits: Array = None seq_relationship_logits: Array = None hidden_states: Optional = None attentions: Optional = None )

参数

  • prediction_logits (jnp.ndarray of shape (batch_size, sequence_length, config.vocab_size)) — 语言的预训练输出头部的预测分数(SoftMax 前的每个词汇的分数)。
  • seq_relationship_logits (jnp.ndarray of shape (batch_size, 2)) — 下一个序列预测(分类)头部的预测分数(SoftMax 前的 True/False 继续分数)。
  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回的 tuple,包含 jnp.ndarray。其形状为 (batch_size, sequence_length, hidden_size)。这代表模型在每个层的输出以及初始嵌入输出。
  • attentions (tuple(jnp.ndarray), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — 包含每个层的 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的权重,用于在自注意力头中计算加权的平均值。

BertForPreTraining 的输出类型。

替换

< >

( **更新 )

“返回一个新的对象,将与新值替换指定的字段。

Pytorch
隐藏 Pytorch 内容

BertModel

transformers.BertModel

< >

( config add_pooling_layer = True )

参数

  • config (Bert配置) — 包含模型所有参数的配置类。使用配置文件初始化时不加载模型相关的权重,只加载配置。检查from_pretrained()方法以加载模型权重。

仅输出原始隐藏状态而不添加任何特定头的裸Bert模型转换器。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

此模型可以 behaving as an encoder(仅自注意力)和decoder,在这种情况下,在自注意力层之间添加了一个交叉注意力层,遵循Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser和Illia Polosukhin在Attention is all you need中描述的体系结构。

要作为decoder,模型需要使用配置的is_decoder参数初始化为True。要在Seq2Seq模型中使用,模型需要初始化同时设置is_decoder参数和add_cross_attentionTrue;然后期望encoder_hidden_states作为正向传递的输入。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None past_key_values: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentionstorch.FloatTensor

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列标记的词库索引。

    索引可以通过 AutoTokenizer 获取。详细信息请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call().

    什么是输入ID?

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 避免对填充token索引执行注意力操作的掩码。掩码值选择在 [0, 1]

    • 1 代表 非掩码 token,
    • 0 代表 掩码 token。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于指示输入的两个部分的Segment token索引。索引选择在 [0, 1]

    • 0 代表 句子 A 标记,
    • 1 代表 句子 B 标记。

    什么是标记类型ID?

  • position_ids (torch.LongTensor 形状 (batch_size, sequence_length)可选) — 每个输入序列令牌在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置ID?

  • 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 索引到相关的向量。
  • output_attentions (bool, optional) — 是否返回所有注意力层张量的注意力。有关更多详细信息,请参见返回的张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回的张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回一个< nobr> ModelOutput 而不是普通的元组。
  • encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 编码器最后一层的隐藏状态序列。如果模型配置为解码器,用于交叉注意力。
  • encoder_attention_mask (形状为 (batch_size, sequence_length)torch.FloatTensor可选) — 用于避免对编码器输入中填充标记的索引执行注意力的掩码。如果模型配置为解码器,用于交叉注意力。掩码值选择在 [0, 1] 中:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。
  • past_key_values (长度为 config.n_layerstuple(tuple(torch.FloatTensor)),其中每个元组包含4个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。

    如果使用 past_key_values,用户可以选择只需输入 decoder_input_ids 的最后一部分(那些未向此模型提供过去键值状态的)形状为 (batch_size, 1),而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)

  • use_cache (bool, 可选) — 如果设置为 True,将返回 past_key_values 密钥值状态,可用于加快解码速度(见 past_key_values)。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentionstuple(torch.FloatTensor)

A transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个由各种元素组成的元组 torch.FloatTensor (如果传入参数 return_dict=False 或者 config.return_dict=False)依赖于配置(BertConfig)和输入。

  • last_hidden_state (模型最后一层的输出中的隐藏状态的 torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列。

  • pooler_output (形状为 (batch_size, hidden_size)torch.FloatTensor) — 经过辅助预训练任务中使用到的层数的进一步处理后的序列中第一个标记的最后一层隐藏状态(分类标记)。例如,对于 BERT 家族模型,在通过一个线性层和一个 tanh 激活函数处理之后,返回分类标记。在线性层权重是在预训练期间通过下一个句子的预测(分类)目标进行训练的。

  • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

  • cross_attentionstuple(torch.FloatTensor)可选,当 output_attentions=Trueconfig.add_cross_attention=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器交叉注意力层的注意力权重,经过注意力 softmax 后,在交叉注意力头部计算加权平均。

  • past_key_valuestuple(tuple(torch.FloatTensor))可选,当 use_cache=True 被传入或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 的元组,每个元组包含2个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,并可选择在 config.is_encoder_decoder=True 时再包含2个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的张量。

    包含预计算的隐藏状态(自注意力块中的键和值,以及在config.is_encoder_decoder=True(在交叉注意力块中时)的条件下)可以用作输入(请参阅past_key_values),以加速顺序解码。

BertModel前向方法,覆盖了__call__特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, BertModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertModel.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

BertForPreTraining

class transformers.BertForPreTraining

< >

( config )

参数

  • config (BertConfig) — Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the from_pretrained() method to load the model weights.

Bert模型,具有两个顶部的头部,如预训练期间所做的那样:一个掩码语言模型头部和一个下一句预测(分类)头部。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None next_sentence_label: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.models.bert.modeling_bert.BertForPreTrainingOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。

    索引可以通过使用 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • 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 标记。

    什么是标记类型ID?

  • position_ids (torch.LongTensor的形状为(batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]内选择。

    什么是位置ID?

  • head_mask (torch.FloatTensor的形状为(num_heads,)(num_layers, num_heads)可选) — 掩码以将注意模块中选定的头设置为null。掩码值选自[0, 1]

    • 1表示该头未被掩码
    • 0表示该头被掩码
  • inputs_embeds (torch.FloatTensor的形状为(batch_size, sequence_length, hidden_size)可选) — 可选地,可以直接传入嵌入表示,而不传递input_ids。这非常有用,如果您希望比模型内部的嵌入查找矩阵有更多的控制权来将input_ids索引转换为关联向量。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情请查看返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详情请查看返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是普通的元组。

返回

transformers.models.bert.modeling_bert.BertForPreTrainingOutputtuple(torch.FloatTensor)

一个 transformers.models.bert.modeling_bert.BertForPreTrainingOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(《BertConfig》)和输入决定的多个元素。

  • loss(可选,当提供 labels 时返回,形状为 (1,)torch.FloatTensor)—— 总损失,是掩码语言模型损失和下一个序列预测(分类)损失的加和。

  • prediction_logits(形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor)—— 语言建模头部的预测分数(在每个词汇之前 SoftMax 的分数)。

  • seq_relationship_logits(形状为 (batch_size, 2)torch.FloatTensor)—— 下一个序列预测(分类)头部的预测分数(True/False 连续性之前的分数)。

  • hidden_states(形状为 tuple(torch.FloatTensor) 的元组,可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时)—— 包含嵌入输出的每个层的输出(每个层的输出都是一个 torch.FloatTensor)以及形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

BertForPreTraining 前向方法,覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, BertForPreTraining
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForPreTraining.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logits

BertLMHeadModel

transformers.BertLMHeadModel

< >

( config )

参数

  • config (BertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型相关的权重,只会加载配置。请查看from_pretrained()方法来加载模型权重。

Bert模型,顶部带有用于CLM微调的语言建模头部。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None labels: 可选 = None past_key_values: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 词汇中的输入序列标记索引。

    索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), 可选) — 用于防止在填充标记索引上执行注意力的掩码。掩码值范围在 [0, 1]:

    • 1 对应于未掩码的标记,
    • 0 对应于已掩码的标记。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 段标记索引,用于指示输入的前后部分。索引范围在 [0, 1]:

    • 0 对应于句子 A 标记,
    • 1 对应于句子 B 标记。

    什么是标记类型 ID?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。范围在 [0, config.max_position_embeddings - 1]内。

    什么是位置 ID?

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于取消选定自注意力模块的头部选择的掩码。取值范围在 [0, 1]
    • 1 表示头部 没有被掩码
    • 0 表示头部 被掩码
    • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 也可选择直接传递嵌入式表示,而不传递 input_ids。这在您希望对将 input_ids 索引转换为相关向量进行更多控制时很有用,而不需使用模型的内部嵌入查找矩阵。
    • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张力下的 attentions
    • output_hidden_states (bool类型,可选) — 是否返回所有层的隐藏状态。详细信息请见返回张量下的hidden_states
    • return_dict (bool类型,可选) — 是否返回ModelOutput而不是普通的元组。
    • encoder_hidden_states (torch.FloatTensor类型,形状为(batch_size, sequence_length, hidden_size),可选) — 最后一个编码器层的输出隐藏状态序列。如果模型配置为解码器,则在交叉注意中使用。
    • encoder_attention_mask (torch.FloatTensor 的形状为 (batch_size, sequence_length)可选) — 避免对编码器输入的填充标记索引执行注意力操作的掩码。如果模型配置为解码器,则在交叉注意力中使用该掩码。掩码值选择的范围为 [0, 1]

      • 1 表示 未掩码 的标记,
      • 0 表示 掩码 的标记。
    • labels (torch.LongTensor 的形状为 (batch_size, sequence_length)可选) — 用于计算从左到右的语言模型损失(下一个词预测)。索引应该在 [-100, 0, ..., config khẩufromstim_size] (参见 input_ids 的文档字符串)设置为 -100 的索引是忽略的(掩码),只计算标签为 n [0, ..., config-khfromstim_size] 的标记。
    • past_key_values (tuple(tuple(torch.FloatTensor)) 的长度为 config.n_layers,每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含注意力块预计算的键、值隐藏状态。可用于加速解码。

      如果使用 past_key_values,则用户可以可选地仅输入最后 decoder_input_ids(未将过去关键值状态提供给此模型的)形状为 (batch_size, 1)decoder_input_ids,而不是所有形状为 (batch_size, sequence_length)decoder_input_ids

    • use_cache (bool, 可选) — 如果设置为True,将返回past_key_values键值状态,并且可以用于加速解码(请参阅past_key_values)。

    返回

    transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

    A transformers.modeling_outputs.CausalLMOutputWithCrossAttentions或一个包含各种元素的torch.FloatTensor元组(如果传递了return_dict=False,或者当config.return_dict=False时),这些元素取决于配置(BertConfig)和输入。

    • losstorch.FloatTensor,形状(1,),可选,当提供labels时返回)- 语言建模损失(用于下一标记预测)。

    • logitstorch.FloatTensor,形状(batch_size,sequence_length,config.vocab_size))- 语言建模头部的预测得分(在SoftMax之前的每个词汇表标记的得分)。

    • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

      模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

    • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

      通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

    • 交叉注意力tuple(torch.FloatTensor),可选,当传递output_attentions=True或当config.output_attentions=True时返回)- 一个用于每个层的torch.FloatTensor元组,其形状为(batch_size,num_heads,sequence_length,sequence_length)。

      交叉注意力软化后权重,用于计算交叉注意力头部中加权的平均。

    • past_key_valuestuple(tuple(torch.FloatTensor)),可选,当传递use_cache=True或当config.use_cache=True时返回)- 一个长度为config.n_layerstorch.FloatTensor元组的元组,每个元组包含缓存的自注意力和交叉注意力的键值状态(如果模型在编码器-解码器设置中使用)。只有当config.is_decoder = True时才相关。

      包含预计算的隐藏状态(注意力块中的键和值),可以使用(请参阅past_key_values输入)来加速顺序解码。

BertLMHeadModel的前向方法,覆盖了__call__特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> import torch
>>> from transformers import AutoTokenizer, BertLMHeadModel

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertLMHeadModel.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

BertForMaskedLM

class transformers.BertForMaskedLM

< >

( config )

参数

  • config (Bert配置) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型关联的权重,只加载配置。请查看from_pretrained() 方法以加载模型权重。

Bert模型顶部带有语言建模头部。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。

    索引可以通过 AutoTokenizer 获取。有关详情,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)可选) — 用于避免在填充token索引上执行注意力的掩码。掩码值选择在 [0, 1] 内:

    • 1 对应于 未掩码的token,
    • 0 对应于 已掩码的token。

    什么是注意掩码?

  • token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 段token索引,用于指示输入的第一和第二部分。索引选择在 [0, 1] 内:

    • 0 对应于 句子A的token,
    • 1 对应于 句子B的token。

    什么是token类型ID?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 输入序列token的位置嵌入中的索引。选取范围在 [0, config.max_position_embeddings - 1] 内。

    什么是位置ID?

  • HeadMask (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 索引转换为关联向量,这将非常有用。
  • 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.MaskedLMOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.MaskedLMOutput 或一个包含 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False)包含根据配置(BertConfig)和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选,当提供 labels 时返回) — 掩码语言建模 (MLM) 损失。

  • logitstorch.FloatTensor,形状(batch_size,sequence_length,config.vocab_size))- 语言建模头部的预测得分(在SoftMax之前的每个词汇表标记的得分)。

  • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

BertForMaskedLM 前向方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, BertForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")

>>> 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)
0.88

BertForNextSentencePrediction

类名 transformers.BertForNextSentencePrediction

< >

( config )

参数

  • 配置 (BertConfig) — Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the from_pretrained() method to load the model weights.

在 Bert 模型的顶部添加了 next sentence prediction (分类) 头部的 Bert 模型。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None **kwargs ) transformers.modeling_outputs.NextSentencePredictorOutputtuple(torch.FloatTensor)

参数

  • input_idstorch.LongTensor 的形狀 (batch_size, sequence_length))— 输入序列中詞彙的索引。

    可以使用 AutoTokenizer 獲取索引。詳見 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_masktorch.FloatTensor 的形狀 (batch_size, sequence_length)可選)— 避免在填充token索引上進行注意力的掩码。掩码值選擇在 [0, 1]

    • 1 表示未掩码的token,
    • 0 表示掩码的token。

    什么是注意力掩码?

  • token_type_idstorch.LongTensor 的形狀 (batch_size, sequence_length)可選)— 使用於標識輸入的两部分是句子 A 當前的token索引或句子 B。索引選擇在 [0, 1]

    • 0 對應於 句子 A token,
    • 1 對應於 句子 B token。

    什么是token类型ID?

  • position_ids (torch.LongTensor 形状 (batch_size, sequence_length)可选[0, config.max_position_embeddings - 1]。

    什么是位置ID?

  • 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 索引到相关向量时,这很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput(模型输出)而非普通元组。
  • labels (torch.LongTensor 形状 (batch_size,), 可选) — 用于计算下一个序列预测(分类)损失的标签。输入应为序列对(请参阅 input_ids 文档字符串)。索引应在 [0, 1] 范围内:

返回

transformers.modeling_outputs.NextSentencePredictorOutputtuple(torch.FloatTensor)

一个是 transformers.modeling_outputs.NextSentencePredictorOutput 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False)根据配置(BertConfig)和输入包括各种元素。

  • loss (可选,当提供 next_sentence_label 时返回,torch.FloatTensor 形状 (1,)) — 下一个序列预测(分类)损失。

  • logitstorch.FloatTensor 形状 (batch_size, 2)) — 下一个序列预测(分类)头的预测得分(SoftMax 之前的 True/False 延续得分)。

  • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

BertForNextSentencePrediction 前向方法,覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, BertForNextSentencePrediction
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="pt")

>>> outputs = model(**encoding, labels=torch.LongTensor([1]))
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1]  # next sentence was random

BertForSequenceClassification

transformers.BertForSequenceClassification

< >

( config )

参数

  • configBertConfig) — 包含模型所有参数的模型配置类。通过配置文件初始化不加载模型相关的权重,只加载配置。查看 from_pretrained() 方法以加载模型权重。

Bert 模型变压器,顶部有一个用于序列分类/回归的头(在池化输出之上的一层线性层),例如用于 GLUE 任务。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.SequenceClassifierOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列的词汇索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), 可选) — 避免在padding标记的索引上执行注意力的掩码。选择的掩码值在[0, 1]

    • 1 表示 未掩码 的标记,
    • 0 表示 掩码 的标记。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 段标记索引,用于指示输入的第一个和第二部分。索引在[0, 1]中选取:

    • 0 对应于 句子 A 标记,
    • 1 对应于 句子 B 标记。

    什么是token类型ID?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的索引。选取范围在[0, config.max_position_embeddings - 1]

    什么是位置ID?

  • 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 indices 转换成相关向量有更多控制时,这很有用,比模型内部嵌入查找矩阵更灵活。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选)——是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的hidden_states
  • return_dict (bool, 可选)——是否返回一个ModelOutput而不是一个普通元组。
  • labels (torch.LongTensor 的形状为 (batch_size,), 可选)——用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵损失)。

返回

transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置(BertConfig)和输入包含各种元素。

  • loss (torch.FloatTensor 的形状为 (1,), 可选,当提供 labels 时返回)——分类损失(如果配置 num_labels == 1 则为回归损失)。

  • logits (形状为 (batch_size, config.num_labels)torch.FloatTensor)- 分类(如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。

  • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

BertForSequenceClassification 的 forward 方法覆盖了特殊的 __call__ 方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, BertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("textattack/bert-base-uncased-yelp-polarity")
>>> model = BertForSequenceClassification.from_pretrained("textattack/bert-base-uncased-yelp-polarity")

>>> 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]
'LABEL_1'

>>> # 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 = BertForSequenceClassification.from_pretrained("textattack/bert-base-uncased-yelp-polarity", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.01

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, BertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("textattack/bert-base-uncased-yelp-polarity")
>>> model = BertForSequenceClassification.from_pretrained("textattack/bert-base-uncased-yelp-polarity", 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 = BertForSequenceClassification.from_pretrained(
...     "textattack/bert-base-uncased-yelp-polarity", 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).loss

BertForMultipleChoice

class transformers.BertForMultipleChoice

< >

( config )

参数

  • configBertConfig)- 包含所有模型参数的模型配置类。通过配置文件初始化不会加载与模型关联的权重,只有配置。请查看 from_pretrained() 方法来加载模型权重。

在顶部有多个选择分类头(在池化输出上方的一个线性层和 softmax)的 Bert 模型,例如用于 RocStories/SWAG 任务。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.MultipleChoiceModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length)) — 输入序列单词在词汇表中的索引。

    索引可以通过使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.FloatTensor 形状为 (batch_size, num_choices, sequence_length), 可选) — 避免在填充 token 索引上执行 attention 的掩码。掩码值选择在 [0, 1]:

    • 1 为未 掩码 的 token,
    • 0 为 掩码 的 token.

    什么是 attention 掩码?

  • token_type_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length), 可选) — 分段 token 索引以指示输入的第一部分和第二部分。索引在 [0, 1] 中选择:

    • 0 对应于 句子 A token,
    • 1 对应于 句子 B token.

    什么是 token 类型 ID?

  • position_ids(torch.LongTensor形式,形状为(batch_size, num_choices, sequence_length),可选)— 每个输入序列令牌在位置嵌入中的位置索引。选中范围在[0, config.max_position_embeddings - 1]内。

  • head_mask(torch.FloatTensor形式,形状为(num_heads,)(num_layers, num_heads),可选)— 用于屏蔽自注意力模块所选头部的掩码。掩码值选择在[0, 1]之间:

  • inputs_embeds(torch.FloatTensor形式,形状为(batch_size, num_choices, sequence_length, hidden_size),可选)— 可选地,直接传递嵌入表示,而不是传递。如果你想在索引到相关向量上进行更多控制,而不是使用模型内嵌查找矩阵,此操作非常实用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。详细信息请参阅返回张量中的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。详细信息请参阅返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回 模型输出 而不是普通的元组。
  • labels (torch.LongTensor of shape (batch_size,), optional) — 多选题分类损失的标签。索引应位于[0, ..., num_choices-1],其中num_choices是输入张量第二维的大小。(参见上方的input_ids

返回

transformers.modeling_outputs.MultipleChoiceModelOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.MultipleChoiceModelOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),它包含各种依赖于配置(BertConfig)和输入的元素。

  • losstorch.FloatTensor of shape (1,),可选,当提供 labels 时返回) — 分类损失。

  • logitstorch.FloatTensor of shape (batch_size, num_choices)) — num_choices 是输入张量的第二维。(参见上方的 input_ids

    分类得分(在 SoftMax 之前)。

  • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

BertForMultipleChoice 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, BertForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = BertForMultipleChoice.from_pretrained("google-bert/bert-base-uncased")

>>> 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.logits

BertForTokenClassification

class transformers.BertForTokenClassification

< >

( config )

参数

  • config(《BertConfig》BertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不加载模型关联的权重,仅加载配置。请查看from_pretrained()方法以加载模型权重。

Bert模型在顶部添加了一个标记分类头(隐藏状态输出之上的一层线性层),例如用于命名实体识别(NER)任务。

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

< >

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.TokenClassifierOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列单词在词汇表中的索引。

    索引可以通过使用 AutoTokenizer 获取。详细信息请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (形状为 (batch_size, sequence_length)torch.FloatTensor可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值选择在 [0, 1] 范围内:

    • 1 表示 未掩码 的 token,
    • 0 表示 掩码 的 token。

    什么是 attention掩码?

  • token_type_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 段落 token 索引,用于指示输入的第一部分和第二部分。索引范围在 [0, 1] 中:

    • 0 对应于 句子 A token,
    • 1 对应于 句子 B token。

    什么是 token type ID?

  • position_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 每个输入序列 token 在位置 embedding 中的位置索引。索引范围在 [0, config.max_position_embeddings - 1] 中。

    什么是 position ID?

  • head_mask (可选,形状为(num_heads,) 或 (num_layers, num_heads)torch.FloatTensor)—— 用于取消self-attention模块中选择的头部的mask。Mask的取值范围在[0, 1]
    • 1表示头部未被mask;
    • 0表示头部被mask.
  • inputs_embeds(可选,形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor)—— 可选地,除了传递之外,还可以直接传递嵌入表示。这在您想更多地控制如何将input_ids索引转换为相关向量时比模型内部的嵌入查找矩阵更有用。
  • output_attentions(可选,布尔型)—— 是否返回所有注意力层的张量。有关返回张量的详细信息,请参见返回对象下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。关于返回张量中的 hidden_states 的更多详情,请参见。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 用于计算标签分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 之间。

返回

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.TokenClassifierOutput 或一个包含 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),包含的各种元素取决于配置(BertConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) — 分类损失。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.num_labels)) — 分类得分(在 SoftMax 之前)。

  • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

BertForTokenClassification 前向方法,覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, BertForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("dbmdz/bert-large-cased-finetuned-conll03-english")
>>> model = BertForTokenClassification.from_pretrained("dbmdz/bert-large-cased-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
['O', 'I-ORG', 'I-ORG', 'I-ORG', 'O', 'O', 'O', 'O', 'O', 'I-LOC', 'O', 'I-LOC', 'I-LOC'] 

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.01

BertForQuestionAnswering

transformers.BertForQuestionAnswering

< >

( config )

参数

  • 配置 (BertConfig) — 包含模型所有参数的模型配置类。用配置文件初始化不加载模型相关联的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。

Bert模型,带有跨度分类头,用于SQuAD(等问题解答任务)的提取,在隐藏状态输出之上添加线性层来计算跨度开始 logits跨度结束 logits

此模型继承自PreTrainedModel。检查超类文档,了解库对所有模型的通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是PyTorchtorch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档,了解与通用使用和行为相关的所有问题。

forward

参数

  • input_ids (torch.LongTensor 的形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    索引可以通过使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 以及 PreTrainedTokenizer.call()

    输入 ID 是什么?

  • 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 标记。

    标记类型 ID 是什么?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选)— 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 的范围内选择。

    什么是位置ID?

  • 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 索引转换为相关向量的方式,则此选项很有用。
  • 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.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=Falseconfig.return_dict=False 时),包含根据配置(BertConfig)和输入的多个元素。

  • losstorch.FloatTensor 形状为 (1,)可选,当提供了 labels 时返回) — 总跨度提取损失是开始和结束位置交叉熵的总和。

  • start_logitstorch.FloatTensor 形状为 (batch_size, sequence_length)) — 跨度开始得分(在 SoftMax 之前)。

  • end_logitstorch.FloatTensor 形状为 (batch_size, sequence_length)) — 跨度结束得分(在 SoftMax 之前)。

  • hidden_statestuple(torch.FloatTensor)可选,当 output_hidden_states=True 被传入或当 config.output_hidden_states=True 时返回) — 给定层的输出(如果模型有一个嵌入层,就包括嵌入层的输出 + 因为每个层都有一个)的 torch.FloatTensor 元组,形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态以及可选的初始嵌入输出。

  • attentionstuple(torch.FloatTensor)可选,当 output_attentions=True 被传入或当 config.output_attentions=True 时返回) — 对每层都有一个的 torch.FloatTensor 元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

BertForQuestionAnswering 的前向方法,覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, BertForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("deepset/bert-base-cased-squad2")
>>> model = BertForQuestionAnswering.from_pretrained("deepset/bert-base-cased-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([14])
>>> target_end_index = torch.tensor([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
7.41
TensorFlow
隐藏TensorFlow内容

TFBertModel

transformers.TFBertModel

< >

( config: BertConfig add_pooling_layer: bool = True *inputs **kwargs )

参数

  • config (BertConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载模型对应的权重,只有配置。请检查from_pretrained() 方法以加载模型权重。

仅输出原始隐藏状态而不添加任何特定头的裸Bert模型转换器。

此模型继承自 TFPreTrainedModel。请查看超类文档以获取库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档中的所有相关使用和行为。

transformers 中,TensorFlow 模型和层接受两种输入格式:

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或者
  • 将所有输入作为一个在第一个位置参数中的列表、元组或字典。

支持第二种格式的理由是 Keras 方法在向模型和层传递输入数据时更喜欢这种格式。由于这种支持,当您使用 model.fit() 等方法时,一切应该都能“无缝”运行——只需以任何 model.fit() 支持的格式传递您的输入和标签即可!不过,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在创建自己的层或模型时使用 Keras Functional API,您可以使用以下三种方法来收集所有第一个位置参数中的输入张量

  • 仅包含 input_ids 的单个张量:model(input_ids)
  • 一个长度可变的列表,其中包含一个或多个按文档字符串中给定的顺序排列的输入张量:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

注意,在通过 子类化 创建模型和层时,您不必担心这些问题,因为您可以直接传递输入,就像传递给任何其他 Python 函数一样!

调用

< >

input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None 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.TFBaseModelOutputWithPoolingAndCrossAttentions or tuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入ID?

  • attention_mask (np.ndarraytf.Tensor 维度 (batch_size, sequence_length)可选) — 避免在填充标记索引上执行注意力的掩码。在 [0, 1] 范围内选择的掩码值:

    • 1 对应于 未掩码 的标记,
    • 0 对应于 掩码 的标记。

    什么是注意掩码?

  • token_type_ids (np.ndarraytf.Tensor 维度 (batch_size, sequence_length)可选) — 标记段索引,用于指示输入的第一部分和第二部分。索引在 [0, 1] 范围内选择:

    • 0 对应于 句子 A 标记,
    • 1 对应于 句子 B 标记。

    什么是标记类型 ID?

  • position_ids (np.ndarraytf.Tensor 维度 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 用于使自我注意力模块中的选定头失效的掩码。掩码值选自 [0, 1]

    • 1 表示头未被 掩码
    • 0 表示头被 掩码
  • inputs_embeds (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可以直接传递嵌入表示,而不是传递 input_ids。如果您想比模型内部嵌入查找矩阵有更多控制权地将 input_ids 索引转换为关联向量,这很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • encoder_hidden_statestf.Tensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 编码器最后一层的隐藏状态序列。如果模型配置为解码器,则用于交叉注意力。
  • encoder_attention_masktf.Tensor 形状为 (batch_size, sequence_length)可选) — 避免对编码器输入中填充标记索引执行注意力的掩码。如果模型配置为解码器,则用于交叉注意力。掩码值选择在 [0, 1] 之间:
    • 1 代表 未掩码 的标记,
    • 0 代表 掩码 的标记。
  • past_key_values (长度为 config.n_layersTuple[Tuple[tf.Tensor]]) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,则用户可以输入最后一个 decoder_input_ids(那些没有给这个模型提供过去键值状态的)的形状为 (batch_size, 1),而不是所有 decoder_input_ids 的形状为 (batch_size, sequence_length)
  • use_cache (bool, 可选, 默认为 True) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(参看 past_key_values)。训练期间设置为 False,生成期间设置为 True

返回

transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentionstuple(tf.Tensor)

A transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一个包含 tf.Tensor 元组的元组(如果传入 return_dict=Falseconfig.return_dict=False 时),这些元素根据配置(BertConfig)和输入而变化。

  • last_hidden_state (tf.Tensor,形状为 (batch_size, sequence_length, hidden_size)) — 模型最后层输出的隐藏状态序列。

  • pooler_output (tf.Tensor,形状为 (batch_size, hidden_size)) — 序列中第一个标记(分类标记)的最后一层隐藏状态进一步通过线性层和 Tanh 激活函数处理后得到的输出。线性层的权重在预训练时是从下一个句子预测(分类)目标训练得出的。

    此输出通常 不一定 是输入语义内容的良好总结;通常胜过整个输入序列隐藏状态的平均值或池化。

  • past_key_values (List[tf.Tensor]可选,当传递 use_cache=True 时返回或当 config.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预计算的隐藏状态(注意力块中的键和值),可以使用(请参阅past_key_values输入)来加速顺序解码。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

  • cross_attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器交叉注意力层的注意力权重,经过注意力 softmax 后,在交叉注意力头部计算加权平均。

TFBertModel 前向方法重写了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, TFBertModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertModel.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)

>>> last_hidden_states = outputs.last_hidden_state

TFBertForPreTraining

transformers.TFBertForPreTraining

< >

( config: BertConfig *inputs **kwargs )

参数

  • config (BertConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

Bert模型,具有两个顶部的头部,如预训练期间所做的那样:一个掩码语言模型头部和一个下一句预测(分类)头部。

此模型继承自 TFPreTrainedModel。请查看超类文档以获取库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档中的所有相关使用和行为。

transformers 中,TensorFlow 模型和层接受两种输入格式:

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或者
  • 将所有输入作为一个在第一个位置参数中的列表、元组或字典。

支持第二种格式的理由是 Keras 方法在向模型和层传递输入数据时更喜欢这种格式。由于这种支持,当您使用 model.fit() 等方法时,一切应该都能“无缝”运行——只需以任何 model.fit() 支持的格式传递您的输入和标签即可!不过,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在创建自己的层或模型时使用 Keras Functional API,您可以使用以下三种方法来收集所有第一个位置参数中的输入张量

  • 仅包含 input_ids 的单个张量:model(input_ids)
  • 一个长度可变的列表,其中包含一个或多个按文档字符串中给定的顺序排列的输入张量:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

注意,在通过 子类化 创建模型和层时,您不必担心这些问题,因为您可以直接传递输入,就像传递给任何其他 Python 函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None 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 next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutput or tuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。详见PreTrainedTokenizer.call()PreTrainedTokenizer.encode() 的详细信息。

    什么是输入ID?

  • attention_mask (np.ndarraytf.Tensor 的形状为 (batch_size, sequence_length)可选项) — 用于避免对填充标记索引执行注意力的掩码。选择的掩码值在 [0, 1] 范围内:

    • 1 代表未被掩码的标记,
    • 0 代表被掩码的标记。

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor 的形状为 (batch_size, sequence_length)可选项) — 段标记索引用于指示输入的第一部分和第二部分。索引选择为 [0, 1]

    • 0 对应于 段落 A 标记,
    • 1 对应于 段落 B 标记。

    什么是标记类型ID?

  • position_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择的范围在 [0, config.max_position_embeddings - 1] 之间。

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于禁用自注意力模块中选择头部的掩码。掩码值选择在 [0, 1]

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可以选择直接传递嵌入表示,而不是传递 input_ids。这对于您希望在将 input_ids 索引转换为相关向量时比模型内部的嵌入查找矩阵有更多控制时很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。详见返回的张量中的 attentions,了解更多细节。此参数只能在 Eager 模式下使用,在 Graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。详见返回的张量中的 hidden_states,了解更多细节。此参数只能在 Eager 模式下使用,在 Graph 模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是普通的元组。此参数可以在 Eager 模式下使用,在 Graph 模式下默认为 True。
  • training (bool, 可选, 默认为 `False`) — 是否使用模型进行训练模式(一些模块如dropout模块在不同的训练和评估模式下的行为不同)。
  • labels (tf.Tensor 形状 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应位于 [-100, 0, ..., config.vocab_size](参见 input_ids 的文档字符串),设置为 -100 的索引将被忽略(掩码),损失仅针对 [0, ..., config.vocab_size] 中的标签的令牌计算
  • next_sentence_label (tf.Tensor 形状 (batch_size,), 可选) — 用于计算下一个序列预测(分类)损失的标签。输入应为序列对(参见 input_ids 的文档字符串):索引应在 [0, 1]

    • 0 表示序列 B 是序列 A 的延续,
    • 1 表示序列 B 是随机序列。
  • kwargs (Dict[str, any], 可选, 默认为 {}) — 用于隐藏已弃用的旧参数。

返回

transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutputtuple(tf.Tensor)

一个 transformers.models.bert.modeling_tf_bert.TFBertForPreTrainingOutputtf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),它包含各种元素,具体取决于配置(BertConfig)和输入。

  • 预测对数 (tf.Tensor,形状为 (batch_size, sequence_length, config.vocab_size)) — 语言模型头的预测分数(SoftMax之前的每个词汇的分数)。

  • 序列关系对数 (tf.Tensor,形状为 (batch_size, 2)) — 下一个序列预测(分类)头的预测分数(SoftMax之前的 True/False 继承的分数)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

TFBertForPreTraining 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFBertForPreTraining

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForPreTraining.from_pretrained("google-bert/bert-base-uncased")
>>> input_ids = tokenizer("Hello, my dog is cute", add_special_tokens=True, return_tensors="tf")
>>> # Batch size 1

>>> outputs = model(input_ids)
>>> prediction_logits, seq_relationship_logits = outputs[:2]

TFBertLMHeadModel

transformers.TFBertLMHeadModel

< >

( config: BertConfig *inputs **kwargs )

调用

< >

( 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 labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False **kwargs ) transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

返回

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstf.Tensor 的元组(如果传递 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置(BertConfig)和输入。

  • losstf.Tensor 形状为 (n,)可选,其中 n 是非掩码标签的数量,当提供 labels 时返回)—— 语言建模损失(用于预测下一个标记)。

  • logitstf.Tensor 形状为 (batch_size, sequence_length, config.vocab_size))—— 语言建模头的预测得分(SoftMax 之前的每个词汇的得分)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

  • cross_attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器交叉注意力层的注意力权重,经过注意力 softmax 后,在交叉注意力头部计算加权平均。

  • past_key_values (List[tf.Tensor]可选,当传递 use_cache=True 时返回或当 config.use_cache=True 时返回) — 长度为 config.n_layerstf.Tensor 列表,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预计算的隐藏状态(注意力块中的键和值),可以使用(请参阅past_key_values输入)来加速顺序解码。

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),而不是所有 decoder_input_ids 形状为 (batch_size, sequence_length)。use_cache (bool可选,默认为 True):如果设置为 True,将返回 past_key_values 键值状态,并可加速解码(见 past_key_values)。在训练期间设置为 False,在生成标签(tf.Tensornp.ndarray 形状为 (batch_size, sequence_length)可选):交叉熵分类损失的标签。索引应该在 [0, ..., config.vocab_size - 1] 之间。

示例

>>> from transformers import AutoTokenizer, TFBertLMHeadModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertLMHeadModel.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logits

TFBertForMaskedLM

transformers.TFBertForMaskedLM

< >

( config: BertConfig *inputs **kwargs )

参数

  • config (BertConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只加载配置。请查看 from_pretrained() 方法以加载模型权重。

Bert模型顶部带有语言建模头部。

此模型继承自 TFPreTrainedModel。请查看超类文档以获取库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档中的所有相关使用和行为。

transformers 中,TensorFlow 模型和层接受两种输入格式:

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或者
  • 将所有输入作为一个在第一个位置参数中的列表、元组或字典。

支持第二种格式的理由是 Keras 方法在向模型和层传递输入数据时更喜欢这种格式。由于这种支持,当您使用 model.fit() 等方法时,一切应该都能“无缝”运行——只需以任何 model.fit() 支持的格式传递您的输入和标签即可!不过,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在创建自己的层或模型时使用 Keras Functional API,您可以使用以下三种方法来收集所有第一个位置参数中的输入张量

  • 仅包含 input_ids 的单个张量:model(input_ids)
  • 一个长度可变的列表,其中包含一个或多个按文档字符串中给定的顺序排列的输入张量:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

注意,在通过 子类化 创建模型和层时,您不必担心这些问题,因为您可以直接传递输入,就像传递给任何其他 Python 函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None 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.TFMaskedLMOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 输入序列标记的词汇表中索引。

    索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入 ID?

  • attention_mask (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选)— 用于防止对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1]

    • 1 用于未掩码的标记,
    • 0 用于掩码标记。

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选)— 标记段索引以指示输入的第一段和第二段。索引选择在 [0, 1]

    • 0 对应于 句子 A 标记,
    • 1 对应于 句子 B 标记。

    什么是标记类型 ID?

  • position_ids (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选)— 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID?

  • head_masknp.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于取消自我注意力模块中选定的头部的掩码。在 [0, 1] 选中掩码值:

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • inputs_embedsnp.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可以选择直接传入嵌入表示,而不是传递 input_ids。当你想要比模型的内部嵌入查找矩阵有更多控制时,这很有用。
  • output_attentionsbool可选) — 是否返回所有注意力层的注意力张量。详细信息请参阅返回的张量中的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。关于返回张量下的hidden_states,请参阅更多详情。此参数仅在急切模式中使用,在图模式中,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个ModelOutput,而不是一个普通的元组。此参数可在急切模式中使用,在图模式中,值将始终设置为True。
  • training (bool, 可选,默认为`False`) — 是否以训练模式使用模型(一些模块,如dropout模块,在训练和评估之间的行为不同)。
  • labels (tf.Tensornp.ndarray 形状 (batch_size, sequence_length)可选 ) — 用于计算掩码语言模型损失的标签。索引应在 [-100, 0, ..., config.vocab_size](见 input_ids 的文档字符串)范围内,使用索引为 -100 的标记将被忽略(掩码),损失仅对具有 [0, ..., config.vocab_size] 范围内标签的标记进行计算

返回

transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

A transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 tf.Tensor 的元组(如果传入了 return_dict=False 或当 config.return_dict=False),包含根据配置(BertConfig)和输入的各种元素。

  • losstf.Tensor,形状 (n,)可选,其中 n 是非掩码标签的数量,当提供 labels 时返回) — 掩码语言模型 (MLM) 损失。

  • logitstf.Tensor 形状为 (batch_size, sequence_length, config.vocab_size))—— 语言建模头的预测得分(SoftMax 之前的每个词汇的得分)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

TFBertForMaskedLM 类的前向方法,覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, TFBertForMaskedLM
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")

>>> 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'
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="tf")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = tf.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

>>> outputs = model(**inputs, labels=labels)
>>> round(float(outputs.loss), 2)
0.88

TFBertForNextSentencePrediction

transformers.TFBertForNextSentencePrediction

< >

( config: BertConfig *inputs **kwargs )

参数

  • config(《BertConfig》)— 包含模型所有参数的配置类。初始化时使用配置文件不会加载模型相关的权重,只加载配置。请查看from_pretrained() 方法以加载模型权重。

在 Bert 模型的顶部添加了 next sentence prediction (分类) 头部的 Bert 模型。

此模型继承自 TFPreTrainedModel。请查看超类文档以获取库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档中的所有相关使用和行为。

transformers 中,TensorFlow 模型和层接受两种输入格式:

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或者
  • 将所有输入作为一个在第一个位置参数中的列表、元组或字典。

支持第二种格式的理由是 Keras 方法在向模型和层传递输入数据时更喜欢这种格式。由于这种支持,当您使用 model.fit() 等方法时,一切应该都能“无缝”运行——只需以任何 model.fit() 支持的格式传递您的输入和标签即可!不过,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在创建自己的层或模型时使用 Keras Functional API,您可以使用以下三种方法来收集所有第一个位置参数中的输入张量

  • 仅包含 input_ids 的单个张量:model(input_ids)
  • 一个长度可变的列表,其中包含一个或多个按文档字符串中给定的顺序排列的输入张量:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

注意,在通过 子类化 创建模型和层时,您不必担心这些问题,因为您可以直接传递输入,就像传递给任何其他 Python 函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None 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 next_sentence_label: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFNextSentencePredictorOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 输入序列标记语料库中的索引。

    索引可以通过使用 AutoTokenizer 来获得。请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode() 获取详细信息。

    输入ID是什么?

  • attention_mask (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 避免对填充token索引执行注意力操作的掩码。掩码值选自 [0, 1]

    • 1 对应未掩码的token,
    • 0 对应掩码的token。

    什么是attention mask?

  • token_type_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 用于指示输入的前后部分的段token索引。索引选择在 [0, 1]

    • 0 对应于 句子A 标记,
    • 1 对应于 句子B 标记。

    什么是token type ID?

  • position_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 每个输入序列token在位置嵌入中的索引。选择区间为 [0, config.max_position_embeddings - 1]

    什么是position ID?

  • head_mask(《numpy数组》(np.ndarray)或tf.Tensor类型,形状为(num_heads,)(num_layers, num_heads)可选)——用于取消自我注意力模块中选定头部的掩码。掩码值在[0, 1]中选取:

    • 1 表示头部 未被掩码
    • 0 表示头部 被掩码
  • inputs_embeds(《numpy数组》或`tf.Tensor`类型,形状为(batch_size, sequence_length, hidden_size)可选)——如果要直接传递嵌入表示而非`input_ids`,可选择此选项。当您希望比模型的内部嵌入查找矩阵有更多控制权,将`input_ids`索引转换为相关向量时很有用。
  • output_attentionsbool类型,可选)——是否返回所有注意力层的张量。有关详细信息,请参阅返回张量中的attentions。此参数只能在eager模式下使用,在graph模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而非普通元组。此参数可以在 eager 模式下使用,在 graph 模式下此值将总是设置为 True。
  • training (bool, 可选,默认为 `False`“) — 是否以训练模式使用模型(某些模块,如 dropout 模块,在训练和评估之间有不同的行为)。

返回

transformers.modeling_tf_outputs.TFNextSentencePredictorOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFNextSentencePredictorOutput 或一个包含多个元素的 tf.Tensor 元组(如果传递了 `return_dict=False` 或 `config.return_dict=False`),具体取决于配置(BertConfig)和输入。

  • 损失(《tf.Tensor》,形状为《(n,)》,可选,当提供《code>next_sentence_label时返回),表示下一句预测损失。

  • logits(《tf.Tensor》,形状为《(batch_size, 2)》)——下一序列预测(分类)头的预测得分(在SoftMax之前的True/False后续链接的分数)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

《code>TFBertForNextSentencePrediction的前向方法重写了`__call__`特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFBertForNextSentencePrediction

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="tf")

>>> logits = model(encoding["input_ids"], token_type_ids=encoding["token_type_ids"])[0]
>>> assert logits[0][0] < logits[0][1]  # the next sentence was random

TFBertForSequenceClassification

transformers.TFBertForSequenceClassification

< >

( config: BertConfig *inputs **kwargs )

参数

  • config(《code>BertConfig)——包含模型所有参数的模型配置类。使用配置文件初始化不加载与模型关联的权重,只加载配置。请查看《code>from_pretrained()方法来加载模型权重。

Bert 模型变压器,顶部有一个用于序列分类/回归的头(在池化输出之上的一层线性层),例如用于 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 函数一样!

调用

< >

( 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 or tuple(tf.Tensor)

参数

  • input_ids (NumPy数组,tf.Tensor,List[tf.Tensor]Dict[str, tf.Tensor] 以及 Dict[str, np.ndarray],每个样本必须具有形状 (批次大小,序列长度)) — 词汇表中的输入序列标记的索引。

    索引可以通过使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入ID?

  • attention_mask (NumPy数组或tf.Tensor,形状为(批次大小,序列长度)可选) — 避免在填充令牌索引上执行注意力的掩码。选用[0, 1]中的掩码值:

    • 1 表示未掩码的令牌,
    • 0 表示已掩码的令牌。

    什么是注意力掩码?

  • token_type_ids (NumPy数组或tf.Tensor,形状为(批次大小,序列长度)可选) — 段落令牌索引以指示输入的第一和第二部分。选用的索引在[0, 1]中:

    • 0 对应于 句子A 令牌,
    • 1 对应于 句子B 令牌。

    什么是令牌类型ID?

  • position_ids (np.ndarraytf.Tensor 的形状为 (batch_size, sequence_length)可选) — 每个输入序列标记在位置编码中的位置索引。选择范围 [0, config.max_position_embeddings - 1]

    什么是位置ID?

  • head_mask (np.ndarraytf.Tensor 的形状为 (num_heads,)(num_layers, num_heads)可选) — 用于取消选定头部的自注意力模块的掩码。掩码值选择范围 [0, 1]

    • 1 表示头部未掩码(未掩码),
    • 0 表示头部已掩码(掩码)。
  • inputs_embeds (np.ndarraytf.Tensor 的形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不仅仅是传递 input_ids。这在您想比模型内部嵌入查找矩阵有更多控制权于如何将 input_ids 索引转换为相关向量时非常有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关返回张量下的更多详细信息,请参阅 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关返回张量下的更多详细信息,请参阅 hidden_states。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用,在 graph 模式下此值总是设置为 True。
  • training (bool, 可选, 默认为 `False`) — 是否使用模型进行训练模式(一些模块如dropout模块在训练和评估时表现不同)。
  • labels (tf.Tensornp.ndarray,形状为 (batch_size,)可选) — 用于计算序列分类/回归损失的标签。索引应位于 [0, ..., config.num_labels - 1]。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

A transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个包含 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置和输入包含不同的元素(BertConfig)。

  • loss (tf.Tensor 的形状为 (batch_size, )可选,在提供 labels 时返回) — 分类损失(或如果 config.num_labels==1 则为回归损失)。

  • logits (tf.Tensor 的形状为 (batch_size, config.num_labels)) — 分类分数(在 SoftMax 之前)(或如果 config.num_labels==1 则为回归分数)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

TFBertForSequenceClassification 的 forward 方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, TFBertForSequenceClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity")
>>> model = TFBertForSequenceClassification.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity")

>>> 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]
'LABEL_1'
>>> # 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 = TFBertForSequenceClassification.from_pretrained("ydshieh/bert-base-uncased-yelp-polarity", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.01

TFBertForMultipleChoice

class transformers.TFBertForMultipleChoice

< >

( config: BertConfig *inputs **kwargs )

参数

  • config (BertConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载模型相关的权重,只加载配置。检查 from_pretrained() 方法以加载模型权重。

在顶部有多个选择分类头(在池化输出上方的一个线性层和 softmax)的 Bert 模型,例如用于 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 函数一样!

调用

< >

( input_ids: TF模型输入类型 | 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: 可选[bool] = None output_hidden_states: 可选[bool] = None return_dict: 可选[bool] = None labels: np.ndarray | tf.Tensor | None = None training: 可选[bool] = False ) transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, num_choices, sequence_length)) — 根据词汇表标记输入序列的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入ID?

  • attention_masknp.ndarraytf.Tensor,形状为 (batch_size, num_choices, sequence_length),可省略)— 用于避免在填充词索引上进行注意力的掩码。掩码值选择范围在 [0, 1]

    • 1 表示 未掩码 的词;
    • 0 表示 掩码 的词。

    什么是注意力掩码?

  • token_type_idsnp.ndarraytf.Tensor,形状为 (batch_size, num_choices, sequence_length),可省略)— 段落标记索引,用于指示输入的第一部分和第二部分。选择范围在 [0, 1]

    • 0 表示 句子 A 标记;
    • 1 表示 句子 B 标记。

    什么是标记类型 ID?

  • position_idsnp.ndarraytf.Tensor,形状为 (batch_size, num_choices, sequence_length),可省略)— 每个输入序列标记在位置嵌入中的位置索引。选择范围在 [0, config.max_position_embeddings - 1]

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形状 (num_heads,)(num_layers, num_heads)可选) — 取消选择的自我注意力模块的头部的遮罩。遮罩值在 [0, 1] 中选择:

    • 1 表示头部未被 遮罩
    • 0 表示头部被 遮罩
  • inputs_embeds (np.ndarraytf.Tensor 形状 (batch_size, num_choices, sequence_length, hidden_size)可选) — 可以选择直接传递嵌入表示而不是 input_ids。如果想要比模型的内部嵌入查找矩阵有更细粒度的控制如何将 input_ids 索引转换为相关向量,本参数很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。更多详情请参阅返回张量中的 attentions。此参数只能用于 eager 模式,在 graph 模式中将使用配置中的值。
  • labels (tf.Tensornp.ndarray, 形状 (batch_size, 可选) — 用于计算多选题分类损失的标签。索引应在 [0, ..., num_choices] 范围内,其中 num_choices 是输入张量的第二维大小。 (参见上面 input_ids)

返回

transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtuple(tf.Tensor)

transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),包含的元素取决于配置 (BertConfig) 和输入。

  • loss (tf.Tensor,形状 (batch_size, )可选,当提供 labels 时返回) — 分类损失。

  • logits (tf.Tensor,形状 (batch_size, num_choices)) — num_choices 是输入张量的第二维大小。(参见上面的 input_ids

    分类得分(在 SoftMax 之前)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

TFBertForMultipleChoice 的 forward 方法重写了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, TFBertForMultipleChoice
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = TFBertForMultipleChoice.from_pretrained("google-bert/bert-base-uncased")

>>> 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.logits

TFBertForTokenClassification

transformers.TFBertForTokenClassification

< >

( config: BertConfig *inputs **kwargs )

参数

  • configBertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化时,不会加载模型相关的权重,只加载配置。查看from_pretrained() 方法以加载模型权重。

Bert模型在顶部添加了一个标记分类头(隐藏状态输出之上的一层线性层),例如用于命名实体识别(NER)任务。

此模型继承自 TFPreTrainedModel。请查看超类文档以获取库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、剪枝头部等)。

此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档中的所有相关使用和行为。

transformers 中,TensorFlow 模型和层接受两种输入格式:

  • 将所有输入作为关键字参数(类似 PyTorch 模型),或者
  • 将所有输入作为一个在第一个位置参数中的列表、元组或字典。

支持第二种格式的理由是 Keras 方法在向模型和层传递输入数据时更喜欢这种格式。由于这种支持,当您使用 model.fit() 等方法时,一切应该都能“无缝”运行——只需以任何 model.fit() 支持的格式传递您的输入和标签即可!不过,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在创建自己的层或模型时使用 Keras Functional API,您可以使用以下三种方法来收集所有第一个位置参数中的输入张量

  • 仅包含 input_ids 的单个张量:model(input_ids)
  • 一个长度可变的列表,其中包含一个或多个按文档字符串中给定的顺序排列的输入张量:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

注意,在通过 子类化 创建模型和层时,您不必担心这些问题,因为您可以直接传递输入,就像传递给任何其他 Python 函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_maskspan class="opacity-60">: 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 (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 输入序列标记的词汇索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入ID?

  • attention_mask (np.ndarraytf.Tensor,形状 (batch_size, sequence_length)可选) — 用于避免在填充标记索引上执行注意力的掩码。选择的掩码值在 [0, 1] 之间:
    • 1 表示未标记的标记,
    • 0 表示已标记的标记。

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor,形状 (batch_size, sequence_length)可选) — 指示输入的第一部分和第二部分的标记索引段。索引在 [0, 1] 中选择:
    • 0 对应于 A 句 标记,
    • 1 对应于 B 句 标记。

    什么是标记类型 ID?

  • position_ids (np.ndarraytf.Tensor,形状 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的索引。选择范围在 [0, config.max_position_embeddings - 1] 之间。

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于使自注意力模块选定的头无效的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部 未掩码;
    • 0 表示头部 已掩码
  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可以选择直接传递嵌入表示来替代传递 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, 可选,默认为 `False`) — 是否在训练模式下使用模型(某些模块,如 dropout 模块,在训练和评估之间有不同的行为)。
  • labels (tf.Tensornp.ndarray 尺寸为 (batch_size, sequence_length)可选) — 计算token分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。

返回

transformers.modeling_tf_outputs.TFTokenClassifierOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个包含 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),包含各种元素,具体取决于配置(BertConfig)和输入。

  • loss (tf.Tensor 尺寸为 (n, 可选,其中 n 是未掩码标签的数量;当提供了 labels 时返回) — 分类损失。

  • logits (tf.Tensor 尺寸为 (batch_size, sequence_length, config.num_labels)) — 分类得分(在 SoftMax 之前)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

TFBertForTokenClassification 前向方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, TFBertForTokenClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("dbmdz/bert-large-cased-finetuned-conll03-english")
>>> model = TFBertForTokenClassification.from_pretrained("dbmdz/bert-large-cased-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
['O', 'I-ORG', 'I-ORG', 'I-ORG', 'O', 'O', 'O', 'O', 'O', 'I-LOC', 'O', 'I-LOC', 'I-LOC'] 
>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)
>>> round(float(loss), 2)
0.01

TFBertForQuestionAnswering

transformers.TFBertForQuestionAnswering

< >

( config: BertConfig *inputs **kwargs )

参数

  • config (BertConfig) — 模型配置类,包含所有模型参数。使用配置文件初始化时不会加载模型相关的权重,只加载配置。请检查from_pretrained()方法以加载模型权重。

Bert模型在顶部有一个用于抽题回答任务的span分类头,例如SQuAD(在隐藏状态输出之上的线性层,用于计算span标签开始logitsspan标签结束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 函数一样!

调用

< >

( 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.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 输入序列标记的词库索引。

    索引可以通过使用 AutoTokenizer 来获得。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入 ID?

  • attention_mask (np.ndarrayw.Texture 的形状 (batch_size, sequence_length)可选) — 避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示 未掩码 的标记,
    • 0 表示 掩码 的标记。

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor 的形状 (batch_size, sequence_length)可选) — 段落标记索引以指示输入的第一个和第二个部分。索引选择在 [0, 1]
    • 0 对应于 句子 A 标记,
    • 1 对应于 句子 B 标记。

    什么是标记类型 ID?

  • position_ids (np.ndarraytf.Tensor 的形状 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。选择在范围 [0, config.max_position_embeddings - 1] 中。

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形如 (num_heads,)(num_layers, num_heads)可选) — 使选定的自注意力模块的头无效化的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示该头 未被掩码
    • 0 表示该头被 掩码
  • inputs_embeds (np.ndarraytf.Tensor,形如 (batch_size, sequence_length, hidden_size)可选) — 可选地,直接传递嵌入表示,而不是传递 input_ids。这在你想要比模型的内部嵌入查找矩阵有更多控制权地将 input_ids 索引转换为相关向量时很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下使用配置文件中的值。
  • output_hidden_states (bool,可选)— 是否返回所有层的隐藏状态。有关详细信息,请参阅返回的张量下的 hidden_states。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool,可选)— 是否返回ModelOutput而不是纯元组。此参数可以在 eager 模式下使用,在 graph 模式下,值始终设置为 True。
  • training (bool,可选,默认为 `False`)— 是否在训练模式下使用模型(一些模块如 dropout 模块在训练和评估期间具有不同的行为)。
  • start_positions (tf.Tensornp.ndarray 形状 (batch_size,)可选)— 标记片段开始位置的标签。位置被限制到序列长度(sequence_length)。序列外的位置在计算损失时不会被考虑。
  • end_positions (tf.Tensornp.ndarray 形状 (batch_size,)可选)— 标记片段结束位置的标签。位置被限制到序列长度(sequence_length)。序列外的位置在计算损失时不会被考虑。

返回

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个包含 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),具体取决于配置(BertConfig)和输入。

  • loss (tf.Tensor 形状 (batch_size, )可选,当提供 start_positionsend_positions 时返回) — 总片段提取损失是起始和结束位置交叉熵的总和。

  • start_logits (tf.Tensor 形状 (batch_size, sequence_length))— 段起始分数(SoftMax之前)。

  • end_logits (tf.Tensor 形状 (batch_size, sequence_length))— 段结束分数(SoftMax之前)。

  • hidden_states (tuple(tf.Tensor)可选,当传递 output_hidden_states=True 时返回或当 config.output_hidden_states=True 时返回) — 包含 tf.Tensor 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(tf.Tensor)可选,当传递 output_attentions=True 时返回或当 config.output_attentions=True 时返回) — 元组 tf.Tensor (每层一个) 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

TFBertForQuestionAnswering 前向方法将覆盖 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, TFBertForQuestionAnswering
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/bert-base-cased-squad2")
>>> model = TFBertForQuestionAnswering.from_pretrained("ydshieh/bert-base-cased-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'
>>> # target is "nice puppet"
>>> target_start_index = tf.constant([14])
>>> target_end_index = tf.constant([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = tf.math.reduce_mean(outputs.loss)
>>> round(float(loss), 2)
7.41
JAX
隐藏 JAX 内容

FlaxBertModel

transformers.FlaxBertModel

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • configBertConfig) — 包含模型所有参数的配置类。使用配置文件初始化不加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法以加载模型权重。
  • dtypejax.numpy.dtype可选,默认为 jax.numpy.float32) — 计算的数据类型。可以是以下之一:jax.numpy.float32jax.numpy.float16 (在GPU上)和 jax.numpy.bfloat16 (在TPU上)。

    这可以用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 执行。

    注意,这仅指定了计算的数据类型,并不影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

  • dtypejax.numpy.dtype可选,默认为 jax.numpy.float32) — 计算的数据类型。可以是以下之一:jax.numpy.float32jax.numpy.float16 (在GPU上)和 jax.numpy.bfloat16 (在TPU上)。

    这可以用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 执行。

    注意,这仅指定了计算的数据类型,并不影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

仅输出原始隐藏状态而不添加任何特定头的裸Bert模型转换器。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray 的形状 (batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。

    索引可以通过 AutoTokenizer 获取。请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 了解详细信息。

    什么是输入 ID?

  • 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 标记。

    什么是标记类型 ID?

  • position_ids (numpy.ndarray of shape (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围在 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), 可选) -- 用于取消选中注意力模块的选头。选择的掩码值在 [0, 1] 范围内:
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是纯元组。

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个包含多个元素的元组 torch.FloatTensor(如果传递 return_dict=False 或当 config.return_dict=False 时),这些元素取决于配置(BertConfig)和输入。

  • last_hidden_state (jnp.ndarray of shape (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出隐藏状态序列。

  • pooler_output (jnp.ndarray 形状为 (batch_size, hidden_size)) — 序列中第一个标记(分类标记)的最后一层隐藏状态的补充,通过线性层和 Tanh 激活函数进一步处理。线性层的权重在预训练期间从下一个句子预测(分类)目标中进行训练。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertModel

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertModel.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

FlaxBertForPreTraining

class transformers.FlaxBertForPreTraining

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • config (BertConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载模型相关的权重,只加载配置。请检查 from_pretrained() 方法来加载模型权重。
  • dtype(《jax.numpy.dtype》,可选,默认为 jax.numpy.float32)—— 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)。
  • dtype(《jax.numpy.dtype》,可选,默认为 jax.numpy.float32)—— 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)。

Bert模型,具有两个顶部的头部,如预训练期间所做的那样:一个掩码语言模型头部和一个下一句预测(分类)头部。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput or tuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray of shape (batch_size, sequence_length)) — 输入序列词元的词汇中的索引。

    索引可以通过 AutoTokenizer 获取。详细信息请见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入索引?

  • attention_mask (numpy.ndarray 形状 (batch_size, sequence_length)可选) — 避免对填充token的索引执行注意力操作的掩码。掩码值选择在 [0, 1] 之间:

    • 1 表示未掩码的token,
    • 0 表示掩码的token。

    什么是注意力掩码?

  • token_type_ids (numpy.ndarray 形状 (batch_size, sequence_length)可选) — 段token索引,指示输入的第一部分和第二部分。索引选择在 [0, 1] 之间:

    • 0 对应于 句子 A token,
    • 1 对应于 句子 B token。

    什么是token类型ID?

  • position_ids (numpy.ndarray 形状 (batch_size, sequence_length)可选) — 在位置嵌入中的每个输入序列token的位置索引。选择于范围 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) -- 将注意力模块选中头置为null的掩码。在[0, 1]`中选择的掩码值:
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutputtuple(torch.FloatTensor)

A transformers.models.bert.modeling_flax_bert.FlaxBertForPreTrainingOutput 或一个包含元素(取决于配置(BertConfig)和输入)的 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False)。

  • prediction_logits (jnp.ndarray of shape (batch_size, sequence_length, config.vocab_size)) — 语言建模头部的预测得分(SoftMax前的每个词汇的得分)。

  • seq_relationship_logits (jnp.ndarray of shape (batch_size, 2)) — 下一个序列预测(分类)头部的预测得分(SoftMax前的True/False延续得分)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForPreTraining

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForPreTraining.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)

>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logits

FlaxBertForCausalLM

class transformers.FlaxBertForCausalLM

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • config (BertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 进行。

    注意,这仅指定计算的数据类型,不会影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 进行。

    注意,这仅指定计算的数据类型,不会影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

Bert 模型在顶部添加了语言建模头(隐藏状态输出上的线性层),例如用于自回归任务。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length)numpy.ndarray) — 输入序列token在词汇表中的索引。

    可以通过使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (形状为 (batch_size, sequence_length), 可选的 numpy.ndarray) — 用于避免在填充token索引上执行注意力的掩码。掩码值选择在 [0, 1]:

    • 1 表示 未掩码 的token,
    • 0 表示 掩码 的token。

    什么是注意力掩码?

  • token_type_ids (形状为 (batch_size, sequence_length), 可选的 numpy.ndarray) — 用于指示输入输入的第一部分和第二部分的段token索引。索引选择在 [0, 1]:

    • 0 对应于 句子A token,
    • 1 对应于 句子B token。

    什么是token类型ID?

  • position_idsnumpy.ndarray 形状为 (batch_size, sequence_length),可选)—包含每个输入序列标记位置在位置嵌入中的索引。选择在范围 [0, config.max_position_embeddings - 1] 内。
  • head_masknumpy.ndarray 形状为 (batch_size, sequence_length),可选)—用于禁用注意力模块选中头部的掩码。掩码值在 [0, 1] 范围内选择:

    • 1 表示头部没有被 掩码
    • 0 表示头部被 掩码
  • return_dictbool,可选)—是否返回 ModelOutput 而不是平凡元组。

返回

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 torch.FloatTensor 的元组(如果传递 return_dict=False 或当 config.return_dict=False 时),包含配置(BertConfig)和输入的各种元素。

  • logits (jnp.ndarray,形状为 (batch_size, sequence_length, config.vocab_size))— 语言模型头的预测得分(在 SoftMax 之前每个词汇的得分)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

  • cross_attentionstuple(jnp.ndarray)可选,当传递或当 output_attentions=True 时返回)— 一个 jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    交叉注意力软化后权重,用于计算交叉注意力头部中加权的平均。

  • past_key_valuestuple(tuple(jnp.ndarray))可选,当传递或当 use_cache=True 时返回)— 一个元组的元组,长度为 config.n_layers,其中每个元组包含在编码器-解码器设置中使用的自注意力和交叉注意力层的缓存的键、值状态。只有当 config.is_decoder = True 时才相关。

    包含预计算的隐藏状态(注意力块中的键和值),可以使用(请参阅past_key_values输入)来加速顺序解码。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForCausalLM.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]

FlaxBertForMaskedLM

transformers.FlaxBertForMaskedLM

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • configBertConfig)— 带有所有模型参数的模型配置类。用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, 可选,默认为 jax.numpy.float32) — 计算的数据类型。可以是以下之一:jax.numpy.float32jax.numpy.float16(在GPU上)和jax.numpy.bfloat16(在TPU上)。

    这可以用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 进行。

    注意,这仅指定了计算的数据类型,不会影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可选,默认为 jax.numpy.float32) — 计算的数据类型。可以是以下之一:jax.numpy.float32jax.numpy.float16(在GPU上)和jax.numpy.bfloat16(在TPU上)。

    这可以用于在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 进行。

    注意,这仅指定了计算的数据类型,不会影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

Bert模型顶部带有语言建模头部。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxMaskedLMOutput or tuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray of shape (batch_size, sequence_length)) — 在词汇表中的输入序列标记的索引。

    索引可以通过使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 用于避免对填充token索引执行注意力的掩码。掩码值在 [0, 1] 之间选择:

    • 1 表示未被 掩码 的token;
    • 0 表示被 掩码 的token。

    什么是注意力掩码?

  • token_type_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 标记段token索引,用以指示输入的第一部分和第二部分。索引在 [0, 1] 之间选择:

    • 0 对应于 句子 A token;
    • 1 对应于 句子 B token。

    什么是token类型ID?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 每个输入序列token在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 内选择。
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) -- 用于取消选定的注意力层的头部的掩码。在[0, 1]`:

    • 1 表示头部未被 掩码
    • 0 表示头部被 掩码
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxMaskedLMOutputtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个包含多个元素的元组,这些元素取决于配置(BertConfig)和输入,如果 return_dict=Falseconfig.return_dict=False 时传递或返回。

  • logits (jnp.ndarray,形状为 (batch_size, sequence_length, config.vocab_size))— 语言模型头的预测得分(在 SoftMax 之前每个词汇的得分)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForMaskedLM.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")

>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxBertForNextSentencePrediction

class transformers.FlaxBertForNextSentencePrediction

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • config (BertConfig) —— 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看from_pretrained()方法加载模型权重。
  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) —— 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax(numpy.bfloat16(在TPU上)。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 完成。

    注意,这仅指定计算的数据类型,并不影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请查看to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) —— 计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax(numpy.bfloat16(在TPU上)。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定,所有计算都将使用给定的 dtype 完成。

    注意,这仅指定计算的数据类型,并不影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请查看to_fp16()to_bf16()

在 Bert 模型的顶部添加了 next sentence prediction (分类) 头部的 Bert 模型。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutput or tuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray 形状 (batch_size, sequence_length)) — 词表中的输入序列标记的索引。

    可以在AutoTokenizer中使用方法获取这些索引。详见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • 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 令牌。

    什么是令牌类型ID?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) —输入序列token在位置嵌入中的位置索引。范围在 [0, config.max_position_embeddings - 1] 内选择。
  • head_mask (numpy.ndarray 形状为 (batch_size, sequence_length)可选) —用于将注意力模块选择的头部设为零的掩码。掩码值在 `[0, 1]` 范围内选择:
  • return_dict (bool可选) —是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutputtuple(torch.FloatTensor)

transformers.modeling_flax_outputs.FlaxNextSentencePredictorOutput 或是当 return_dict=False 传入或配置文件中的 return_dict=False 时为 torchynchronous.TranrenchardFloatTensor 的元组,包含的元素依赖于配置(如 BertConfig)和输入。

  • 对数几率 (jnp.ndarray 形状为 (batch_size, 2)) — 下一个序列预测(分类)头的预测得分(SoftMax前的True/False延续得分)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForNextSentencePrediction

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForNextSentencePrediction.from_pretrained("google-bert/bert-base-uncased")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="jax")

>>> outputs = model(**encoding)
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1]  # next sentence was random

FlaxBertForSequenceClassification

transformers.FlaxBertForSequenceClassification

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • config (BertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只有配置。查看 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, 可选,默认为 jax.numpy.float32) —— 计算的数据类型。可以是以下类型之一: jax.numpy.float32jax.numpy.float16(在GPU上)以及 jax.numpy.bfloat16(在TPU上)。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推断。如果指定了所有计算都将使用给定的 dtype 完成。

    请注意,这仅指定了计算的数据类型,不会影响模型参数的数据类型。

    如果需要更改模型参数的数据类型,请查看 to_fp16()to_bf16()

  • dtype (jax.numpy.dtype, 可选,默认为 jax.numpy.float32) —— 计算的数据类型。可以是以下类型之一: jax.numpy.float32jax.numpy.float16(在GPU上)以及 jax.numpy.bfloat16(在TPU上)。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推断。如果指定了所有计算都将使用给定的 dtype 完成。

    请注意,这仅指定了计算的数据类型,不会影响模型参数的数据类型。

    如果需要更改模型参数的数据类型,请查看 to_fp16()to_bf16()

Bert 模型变压器,顶部有一个用于序列分类/回归的头(在池化输出之上的一层线性层),例如用于 GLUE 任务。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxSequenceClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray 的形状为 (批大小, 序列长度)) — 单词表中的输入序列标记的索引。

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • 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 句标记。

    什么是标记类型 ID?

  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 输入序列标记在位置嵌入中的位置索引。选择在范围 [0, config.max_position_embeddings - 1]
  • head_mask (形状为(batch_size, sequence_length)numpy.ndarray,可选)-- 用于取消选择注意力模块选定的头的掩码。在`[0, 1]`中选择的掩码值:

    • 1 表示头没有被 屏蔽
    • 0 表示头被 屏蔽
  • return_dict (可选的bool)— 是否返回一个 ModelOutput 而不是普通的元组。

返回

transformers.modeling_flax_outputs.FlaxSequenceClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个元组,包含各种元素取决于配置(BertConfig)和输入(如果return_dict=False被传递或当config.return_dict=False)。

  • logits (形状为(batch_size, config.num_labels)jnp.ndarray)— 分类(或如果config.num_labels==1时为回归)的分数(在SoftMax之前)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForSequenceClassification.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")

>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxBertForMultipleChoice

transformers.FlaxBertForMultipleChoice

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • configBertConfig)—— 包含模型所有参数的模型配置类。使用配置文件初始化时,不会加载与模型关联的权重,只加载配置。查看 from_pretrained() 方法来加载模型权重。
  • dtypejax.numpy.dtype,可选,默认为jax.numpy.float32)—— 计算的数据类型。可以是jax.numpy.float32jax.numpy.float16(在GPU上)和jax.numpy.bfloat16(在TPU上)。

  • dtypejax.numpy.dtype,可选,默认为jax.numpy.float32)—— 计算的数据类型。可以是jax.numpy.float32jax.numpy.float16(在GPU上)和jax.numpy.bfloat16(在TPU上)。

在顶部有多个选择分类头(在池化输出上方的一个线性层和 softmax)的 Bert 模型,例如用于 RocStories/SWAG 任务。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray of shape (batch_size, num_choices, sequence_length)) — 输入序列的词汇索引。

    索引可以通过 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入索引?

  • attention_mask (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) — 避免在填充令牌索引上执行注意力操作。遮罩值选择在 [0, 1]:

    • 1 对应于 未遮罩 的令牌,
    • 0 对应于 遮罩 的令牌。

    什么是注意力遮罩?

  • token_type_ids (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) — 用作指示输入的第一部分和第二部分的段令牌索引。索引选择在 [0, 1]:

    • 0 对应于 句子 A 令牌,
    • 1 对应于 句子 B 令牌。

    什么是令牌类型索引?

  • position_ids (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) — 每个输入序列令牌在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。
  • head_mask (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) -- 用于使注意力模块中选定的头无效的掩码。掩码值在 [0, 1] 范围内选择:
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。

返回

transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutputtuple(torch.FloatTensor)

transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutputtorch.FloatTensor 的元组(如果传入 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置(BertConfig)和输入。

  • logits (jnp.ndarray of shape (batch_size, num_choices)) — num_choices 是输入张量的第二个维度。(参见上面的 input_ids)。

    分类得分(在 SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForMultipleChoice

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForMultipleChoice.from_pretrained("google-bert/bert-base-uncased")

>>> 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.logits

FlaxBertForTokenClassification

transformers.FlaxBertForTokenClassification

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • config (Bert配置) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是以下之一:jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)。
  • dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是以下之一:jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)。

Bert模型在顶部添加了一个标记分类头(隐藏状态输出之上的一层线性层),例如用于命名实体识别(NER)任务。

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxTokenClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray of shape (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 句标记。

    什么是标记类型 ID?

  • position_ids (numpy.ndarray 形状 (batch_size, sequence_length),可选) — 每个输入序列标记在位置嵌入中的索引。在 [0, config.max_position_embeddings - 1] 范围内选择。
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) -- 用于禁用部分注意力模块所选头的掩码。掩码值选择在 [0, 1]`:

    • 1 表示该头 未被掩码
    • 0 表示该头 被掩码
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是纯元组。

返回

transformers.modeling_flax_outputs.FlaxTokenClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一个包含各种元素的 torch.FloatTensor 的元组(如果 return_dict=False 被传递,或者当 config.return_dict=False 时),这取决于配置(BertConfig)和输入。

  • logits (jnp.ndarray of shape (batch_size, sequence_length, config.num_labels)) — 分类得分(在 SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForTokenClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForTokenClassification.from_pretrained("google-bert/bert-base-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")

>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxBertForQuestionAnswering

class transformers.FlaxBertForQuestionAnswering

< >

( config: BertConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • configBert模型配置类)—包含模型所有参数的模型配置类。使用配置文件初始化时,并不加载模型的权重,只加载配置。查看 from_pretrained() 方法来加载模型权重。
  • dtypejax.numpy.dtype,可选,默认为 jax.numpy.float32)—计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)之一。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定了所有计算都将使用给定的 dtype 进行。

    注意,这仅指定了计算的数据类型,并不影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

  • dtypejax.numpy.dtype,可选,默认为 jax.numpy.float32)—计算的数据类型。可以是 jax.numpy.float32jax.numpy.float16(在GPU上)和 jax.numpy.bfloat16(在TPU上)之一。

    这可以用来在GPU或TPU上启用混合精度训练或半精度推理。如果指定了所有计算都将使用给定的 dtype 进行。

    注意,这仅指定了计算的数据类型,并不影响模型参数的数据类型。

    如果您想更改模型参数的数据类型,请参阅 to_fp16()to_bf16()

Bert模型,带有跨度分类头,用于SQuAD(等问题解答任务)的提取,在隐藏状态输出之上添加线性层来计算跨度开始 logits跨度结束 logits

此模型继承自 FlaxPreTrainedModel。请查看超类文档,了解库为所有模型实现的基本方法(例如下载、保存和从PyTorch模型转换权重)。

此模型也是 flax.linen.Module 子类。将其作为常规 Flax linen 模块使用,并参阅 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: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length)numpy.ndarray) — 词汇表中的输入序列标记的索引。

    可使用 AutoTokenizer 获取索引。详细信息请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (形状为 (batch_size, sequence_length)numpy.ndarray,可选) — 避免在填充令牌索引上执行注意力操作的掩码。掩码值使用 [0, 1] 选择:

    • 1 表示 未掩码 的令牌,
    • 0 表示 已掩码 的令牌。

    什么是注意力掩码?

  • token_type_ids (形状为 (batch_size, sequence_length)numpy.ndarray,可选) — 用于指示输入的第一个和第二个部分的分段标记索引。索引选择在 [0, 1] 中:

    • 0对应于 句子 A 标记,
    • 1对应于 句子 B 标记。

    什么是标记类型 ID?

  • position_ids (numpy.ndarray of shape (batch_size, sequence_length), 可选) — 每个输入序列标记的位置嵌入中的索引。在范围 [0, config.max_position_embeddings - 1] 中选择。
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), 可选) — 空白化注意力模块选中头的掩码。掩码值在 [0, 1] 中选中:
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutputtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一个包含 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),包含各种元素,具体取决于配置(BertConfig)和输入。

  • start_logits (jnp.ndarray of shape (batch_size, sequence_length)) — Span-start scores (before SoftMax).

  • end_logits (jnp.ndarray 形状为 (batch_size, sequence_length)) — Span-end 分数(SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 一个 jnp.ndarray 的元组(一个用于嵌入层的输出 + 每个层级的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型的隐藏状态在每个层输出来加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 每个层级的一个 jnp.ndarray 的元组,形状为 (batch_size, num_heads, sequence_length, sequence_length)

    通过注意力 softmax 的注意力权重,在自注意力头部计算加权平均。

FlaxBertPreTrainedModel 前向方法覆盖了 __call__ 特殊方法。

尽管前向传递的配方需要在该函数内部定义,但应该在调用该函数之后调用Module实例,因为前者负责执行前处理和后处理步骤,而后者则静默忽略这些步骤。

示例

>>> from transformers import AutoTokenizer, FlaxBertForQuestionAnswering

>>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
>>> model = FlaxBertForQuestionAnswering.from_pretrained("google-bert/bert-base-uncased")

>>> 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
< > 在GitHub上更新