Transformers 4.37 中文文档（四十六）（4）

Transformers 4.37 中文文档（四十六）（3）https://developer.aliyun.com/article/1565070

TFMPNetForTokenClassification

class transformers.TFMPNetForTokenClassification

<来源>

( config *inputs **kwargs )

参数

• config（MPNetConfig）- 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。

在顶部带有令牌分类头的 MPNet 模型（在隐藏状态输出的顶部有一个线性层），例如用于命名实体识别（NER）任务。

此模型继承自 TFPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存，调整输入嵌入，修剪头等）。

此模型还是一个tf.keras.Model子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以获取有关一般用法和行为的所有信息。

transformers中的 TensorFlow 模型和层接受两种格式的输入：

• 将所有输入作为关键字参数（类似于 PyTorch 模型），或
  
• 将所有输入作为列表、元组或字典的第一个位置参数。
  

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用model.fit()等方法时，应该“只需工作” - 只需以model.fit()支持的任何格式传递输入和标签！但是，如果您想在 Keras 方法之外使用第二种格式，例如在使用 KerasFunctional API 创建自己的层或模型时，有三种可能性可用于在第一个位置参数中收集所有输入张量：

• 只有input_ids的单个张量，没有其他内容：model(input_ids)
  
• 一个长度可变的列表，其中包含按照文档字符串中给定的顺序的一个或多个输入张量：model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids])
  
• 一个字典，其中包含与文档字符串中给定的输入名称相关联的一个或多个输入张量：model({"input_ids": input_ids, "token_type_ids": token_type_ids})
  

请注意，当使用子类化创建模型和层时，您无需担心任何这些，因为您可以像对待其他 Python 函数一样传递输入！

call

<来源>

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: tf.Tensor | None = None training: bool = False ) → export const metadata = 'undefined';transformers.modeling_tf_outputs.TFTokenClassifierOutput or tuple(tf.Tensor)

参数

• input_ids（形状为(batch_size, sequence_length)的Numpy数组或tf.Tensor）- 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call()和 PreTrainedTokenizer.encode()。
  什么是输入 ID？
  
• attention_mask（形状为(batch_size, sequence_length)的Numpy数组或tf.Tensor，可选）- 避免在填充标记索引上执行注意力的掩码。选择在[0, 1]中的掩码值：

• 1 用于未被“掩码”的标记，
  
• 0 用于被“掩码”的标记。
  

• 什么是注意力掩码？
  
• position_ids（形状为(batch_size, sequence_length)的Numpy 数组或tf.Tensor，可选）— 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。
  什么是位置 ID？
  
• head_mask（形状为(num_heads,)或(num_layers, num_heads)的Numpy 数组或tf.Tensor，可选）— 用于使自注意力模块的选定头部失效的掩码。在[0, 1]中选择的掩码值：

• 1 表示头部未被掩码，
  
• 0 表示头部被掩码。
  

• inputs_embeds（形状为(batch_size, sequence_length, hidden_size)的tf.Tensor，可选）— 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要更多控制权来将input_ids索引转换为相关向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
  
• output_attentions（bool，可选）— 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。此参数仅在急切模式下使用，在图模式下将使用配置中的值。
  
• output_hidden_states（bool，可选）— 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。此参数仅在急切模式下使用，在图模式下将使用配置中的值。
  
• return_dict（bool，可选）— 是否返回一个 ModelOutput 而不是一个普通元组。此参数可以在急切模式下使用，在图模式下该值将始终设置为 True。
  
• training（bool，可选，默认为False）— 是否在训练模式下使用模型（一些模块如 dropout 模块在训练和评估之间有不同的行为）。
  
• labels（形状为(batch_size, sequence_length)的tf.Tensor，可选）— 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]中。
  

返回

transformers.modeling_tf_outputs.TFTokenClassifierOutput 或tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或者一个tf.Tensor元组（如果传递了return_dict=False或者当config.return_dict=False时）包含各种元素，取决于配置（MPNetConfig）和输入。

• loss（形状为(n,)的tf.Tensor，可选，其中 n 是未掩码标签的数量，当提供labels时返回）— 分类损失。
  
• logits（形状为(batch_size, sequence_length, config.num_labels)的tf.Tensor）— 分类分数（SoftMax 之前）。
  
• hidden_states（tuple(tf.Tensor)，可选，当传递output_hidden_states=True或者当config.output_hidden_states=True时返回）— 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。
  模型在每一层输出的隐藏状态以及初始嵌入输出。
  
• attentions（tuple(tf.Tensor)，可选，当传递output_attentions=True或者当config.output_attentions=True时返回）— 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。
  在自注意力头中用于计算加权平均值的注意力 softmax 后的注意力权重。
  

TFMPNetForTokenClassification 的前向方法，覆盖了__call__特殊方法。

尽管前向传递的配方需要在此函数内定义，但应该在此之后调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, TFMPNetForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetForTokenClassification.from_pretrained("microsoft/mpnet-base")
>>> 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()]

>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)

TFMPNetForQuestionAnswering

class transformers.TFMPNetForQuestionAnswering

<来源>

( config *inputs **kwargs )

参数

• config（MPNetConfig](/docs/transformers/v4.37.2/en/main_classes/model#transformers.PreTrainedModel.from_pretrained)方法以加载模型权重。

MPNet 模型在顶部具有跨度分类头，用于提取式问答任务，如 SQuAD（在隐藏状态输出的顶部进行线性层计算span start logits和span end logits）。

此模型继承自 TFPreTrainedModel。检查超类文档以获取库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入、修剪头等）。

此模型还是一个tf.keras.Model子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以获取与一般用法和行为相关的所有内容。

transformers中的 TensorFlow 模型和层接受两种格式的输入：

• 所有输入都作为关键字参数（类似于 PyTorch 模型），或者
  
• 所有输入都作为列表、元组或字典的第一个位置参数。
  

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用model.fit()等方法时，应该“只需传递”您的输入和标签，以任何model.fit()支持的格式！但是，如果您想在 Keras 方法之外使用第二种格式，例如在使用 KerasFunctional API 创建自己的层或模型时，有三种可能性可用于收集第一个位置参数中的所有输入张量：

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

请注意，当使用子类化创建模型和层时，您无需担心任何这些，因为您可以像将输入传递给任何其他 Python 函数一样传递输入！

call

<来源>

( input_ids: TFModelInputType | None = None attention_mask: Optional[Union[np.array, tf.Tensor]] = None position_ids: Optional[Union[np.array, tf.Tensor]] = None head_mask: Optional[Union[np.array, tf.Tensor]] = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: tf.Tensor | None = None end_positions: tf.Tensor | None = None training: bool = False **kwargs ) → export const metadata = 'undefined';transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput or tuple(tf.Tensor)

参数

• input_ids（形状为(batch_size, sequence_length)的Numpy数组或tf.Tensor）-词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call()和 PreTrainedTokenizer.encode()。
  什么是输入 ID？
  
• attention_mask (Numpy array 或 tf.Tensor，形状为 (batch_size, sequence_length)，可选) — 遮罩，避免在填充标记索引上执行注意力。遮罩值选定在 [0, 1]：

• 1 表示未被 masked 的标记，
  
• 0 表示被 masked 的标记。
  

• 什么是注意力遮罩？
  
• position_ids (Numpy array 或 tf.Tensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选定范围为 [0, config.max_position_embeddings - 1]。
  什么是位置 ID？
  
• head_mask (Numpy array 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块中选择的头部失效的遮罩。遮罩值选定在 [0, 1]：

• 1 表示头部未被 masked。
  
• 0 表示头部被 masked。
  

• inputs_embeds (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，可以直接传递嵌入表示而不是传递 input_ids。如果您想要更多控制如何将 input_ids 索引转换为相关向量，而不是使用模型的内部嵌入查找矩阵，这很有用。
  
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。此参数仅在急切模式下使用，在图模式下将使用配置中的值。
  
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。此参数仅在急切模式下使用，在图模式下将使用配置中的值。
  
• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通元组。此参数可在急切模式下使用，在图模式下该值将始终设置为 True。
  
• training (bool，可选，默认为 False) — 是否在训练模式下使用模型（一些模块如 dropout 模块在训练和评估之间有不同的行为）。
  
• start_positions (tf.Tensor，形状为 (batch_size,)，可选) — 用于计算标记跨度起始位置（索引）的标签，用于计算标记分类损失。位置被夹紧到序列的长度 (sequence_length)。序列外的位置不会被考虑在内计算损失。
  
• end_positions (tf.Tensor，形状为 (batch_size,)，可选) — 用于计算标记跨度结束位置（索引）的标签，用于计算标记分类损失。位置被夹紧到序列的长度 (sequence_length)。序列外的位置不会被考虑在内计算损失。
  

返回

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）包含根据配置（MPNetConfig）和输入的不同元素。

• loss (tf.Tensor，形状为 (batch_size, )，可选，当提供了 start_positions 和 end_positions 时返回) — 总跨度提取损失是起始位置和结束位置的交叉熵之和。
  
• start_logits (tf.Tensor，形状为 (batch_size, sequence_length)) — 跨度起始分数（SoftMax 之前）。
  
• end_logits（形状为(batch_size, sequence_length)的tf.Tensor）- 跨度结束得分（SoftMax 之前）。
  
• hidden_states（tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入的输出 + 一个用于每个层的输出）。
  模型在每个层的输出处的隐藏状态加上初始嵌入输出。
  
• attentions（tuple(tf.Tensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。
  在注意力 SoftMax 之后的注意力权重，用于计算自注意力头中的加权平均值。
  

TFMPNetForQuestionAnswering 的前向方法，覆盖了__call__特殊方法。

尽管前向传递的配方需要在此函数内定义，但应该在此之后调用Module实例，而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, TFMPNetForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetForQuestionAnswering.from_pretrained("microsoft/mpnet-base")
>>> 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]

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

MPT

原始文本: huggingface.co/docs/transformers/v4.37.2/en/model_doc/mpt

概述

MPT 模型由 MosaicML 团队提出，并发布了多种大小和微调变体。MPT 模型是一系列在 1T 令牌上预训练的开源和商业可用的 LLM。

MPT 模型是类似于 GPT 的仅解码器变压器，具有几项改进：性能优化的层实现、提供更大训练稳定性的架构更改，以及通过用 ALiBi 替换位置嵌入来消除上下文长度限制。

• MPT 基础: MPT 基础预训练模型用于下一个令牌预测
  
• MPT 指导: MPT 基础模型在基于指令的任务上进行了微调
  
• MPT 故事创作者: MPT 基础模型在 books3 语料库中的 65k 令牌摘录上进行了 2500 步的微调，这使得模型能够处理非常长的序列
  

原始代码可在 llm-foundry 存储库中找到。

了解更多 在发布博客文章中

使用提示

• 了解模型训练背后的一些技术 在 llm-foundry 存储库的这一部分
  
• 如果要使用模型的高级版本（triton kernels、直接闪存注意力集成），仍然可以通过在调用 from_pretrained 时添加 trust_remote_code=True 来使用原始模型实现。
  

资源

• 微调笔记本 关于如何在免费的 Google Colab 实例上微调 MPT-7B 以将模型转换为聊天机器人。

MptConfig

class transformers.MptConfig

<来源>

( d_model: int = 2048 n_heads: int = 16 n_layers: int = 24 expansion_ratio: int = 4 max_seq_len: int = 2048 vocab_size: int = 50368 resid_pdrop: float = 0.0 layer_norm_epsilon: float = 1e-05 emb_pdrop: float = 0.0 learned_pos_emb: bool = True attn_config: MptAttentionConfig = None init_device: str = 'cpu' logit_scale: Union = None no_bias: bool = True verbose: int = 0 embedding_fraction: float = 1.0 norm_type: str = 'low_precision_layernorm' use_cache: bool = False initializer_range = 0.02 **kwargs )

参数

• d_model (int, 可选, 默认为 2048) — 嵌入和隐藏状态的维度。
  
• n_heads (int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数。
  
• n_layers (int, 可选, 默认为 24) — Transformer 编码器中的隐藏层数量。
  
• expansion_ratio (int, 可选, 默认为 4) — MLP 中上/下缩放比率。
  
• max_seq_len (int, 可选, 默认为 2048) — 模型的最大序列长度。
  
• vocab_size (int, 可选, 默认为 50368) — Mpt 模型的词汇量。定义了在调用 MptModel 时可以表示的不同令牌的最大数量。查看关于如何定义 vocab_size 的 此讨论。
  
• resid_pdrop (float, 可选, 默认为 0.0) — 在与残差结合之前应用于注意力输出的丢弃概率。
  
• layer_norm_epsilon (float, 可选, 默认为 1e-05) — 在层归一化层中使用的 epsilon。
  
• emb_pdrop (float, 可选, 默认为 0.0) — 嵌入层的丢弃概率。
  
• learned_pos_emb (bool, 可选, 默认为 True) — 是否使用学习的位置嵌入。
  
• attn_config (dict, 可选) — 用于配置模型注意力模块的字典。
  
• init_device (str, 可选, 默认为 "cpu") — 用于参数初始化的设备。为了向后兼容性而定义
  
• logit_scale (float, 可选) — 如果不为 None，则通过此值缩放对数。
  
• no_bias (bool, 可选, 默认为 True) — 是否在所有线性层中使用偏置。
  
• verbose (int, 可选, 默认为 0) — 用于日志记录的详细级别。在先前版本的 MPT 模型中用于日志记录。此参数已弃用。
  
• embedding_fraction (float, optional, defaults to 1.0) — 通过的嵌入层梯度的比例。
  
• norm_type (str, optional, defaults to "low_precision_layernorm") — 要使用的层归一化类型。所有 MPT 模型使用相同的层归一化实现。为了向后兼容性而定义。
  
• use_cache (bool, optional, defaults to False) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。
  
• initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  

这是用于存储 MptModel 配置的配置类。它用于根据指定的参数实例化一个 Mpt 模型，定义模型架构。使用默认值实例化配置将产生类似于 Mpt-7b 架构 mosaicml/mpt-7b 的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读来自 PretrainedConfig 的文档以获取更多信息。

示例：

>>> from transformers import MptConfig, MptModel
>>> # Initializing a Mpt configuration
>>> configuration = MptConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = MptModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

Transformers 4.37 中文文档（四十六）（5）https://developer.aliyun.com/article/1565079