AI 助理
备案控制台
开发者社区 人工智能 文章 正文

Transformers 4.37 中文文档（五十五）（7）

2024-07-11 21
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Transformers 4.37 中文文档（五十五）

Transformers 4.37 中文文档（五十五）（6）https://developer.aliyun.com/article/1565394


TFRobertaForQuestionAnswering

class transformers.TFRobertaForQuestionAnswering

< source >

( config *inputs **kwargs )

参数

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

RoBERTa 模型，顶部带有一个用于提取式问答任务（如 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: 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 ) → 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（形状为(batch_size, sequence_length)的Numpy数组或tf.Tensor，可选）- 避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：
  • 对于未被masked的标记为 1，
  • 对于被masked的标记为 0。
  • 什么是注意力掩码？
  • token_type_ids（形状为(batch_size, sequence_length)的Numpy数组或tf.Tensor，可选）- 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：
  • 0 对应于句子 A的标记，
  • 1 对应于句子 B的标记。
  • 什么是标记类型 ID？
  • 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 模块在训练和评估之间有不同的行为）。
  • start_positions（形状为(batch_size,)的tf.Tensor，可选）- 用于计算标记跨度起始位置的标签（索引）。位置被夹紧到序列的长度（sequence_length）。序列外的位置不会被考虑在内以计算损失。
  • end_positions（形状为(batch_size,)的tf.Tensor，可选）- 用于计算标记分类损失的标签（索引）的跨度结束位置。位置被夹紧到序列的长度（sequence_length）。序列外的位置不会被考虑在内以计算损失。

返回

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

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

  • loss（形状为(batch_size,)的tf.Tensor，可选，当提供start_positions和end_positions时返回）- 总跨度提取损失是起始和结束位置的交叉熵之和。
  • start_logits（形状为(batch_size, sequence_length)的tf.Tensor）- 跨度起始分数（SoftMax 之前）。
  • end_logits（形状为(batch_size, sequence_length)的tf.Tensor）- 跨度结束分数（SoftMax 之前）。
  • hidden_states（tuple(tf.Tensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）— 形状为(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 之后的注意力权重。

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

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

示例：

>>> from transformers import AutoTokenizer, TFRobertaForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-base-squad2")
>>> model = TFRobertaForQuestionAnswering.from_pretrained("ydshieh/roberta-base-squad2")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens)
' 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)
0.86

JAX 隐藏 JAX 内容

FlaxRobertaModel

class transformers.FlaxRobertaModel

<来源>

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

参数

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

裸 RoBERTa 模型变压器输出原始隐藏状态，没有特定的头部。

此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。

此模型还是flax.linen.Module的子类。将其用作常规的 Flax 亚麻模块，并参考 Flax 文档以获取与一般用法和行为相关的所有内容。

最后，此模型支持内置的 JAX 功能，例如：

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 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（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 每个输入序列标记在位置嵌入中的位置索引。在范围[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.FlaxBaseModelOutputWithPooling 或tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个torch.FloatTensor元组（如果传递了return_dict=False或config.return_dict=False时）包含根据配置（RobertaConfig）和输入的不同元素。

  • last_hidden_state（形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray）— 模型最后一层的隐藏状态的序列。
  • pooler_output（形状为(batch_size, hidden_size)的jnp.ndarray）— 序列的最后一层隐藏状态（分类标记）进一步由线性层和 Tanh 激活函数处理。线性层的权重是从预训练期间的下一个句子预测（分类）目标中训练的。
  • hidden_states（tuple(jnp.ndarray)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）— 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出）。
    模型在每一层输出的隐藏状态加上初始嵌入输出。
  • attentions（tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回）— 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
    在注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。

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

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

示例：

>>> from transformers import AutoTokenizer, FlaxRobertaModel
>>> tokenizer = AutoTokenizer.from_pretrained("roberta-base")
>>> model = FlaxRobertaModel.from_pretrained("roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state

FlaxRobertaForCausalLM

class transformers.FlaxRobertaForCausalLM

<来源>

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

参数

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

在顶部带有语言建模头的 Roberta 模型（隐藏状态输出的线性层），例如用于自回归任务。

此模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。

这个模型也是一个flax.linen.Module子类。将其用作常规的 Flax 亚麻模块，并参考 Flax 文档以获取与一般用法和行为相关的所有内容。

最后，此模型支持 JAX 的固有功能，例如：

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 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（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 每个输入序列标记在位置嵌入中的位置索引。在范围[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.FlaxCausalLMOutputWithCrossAttentions 或tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包括根据配置（RobertaConfig）和输入不同元素。

  • logits（形状为(batch_size, sequence_length, config.vocab_size)的jnp.ndarray）- 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。
  • hidden_states（tuple(jnp.ndarray)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（嵌入输出和每一层输出各一个）。
    模型在每一层输出的隐藏状态加上初始嵌入输出。
  • attentions（tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
    在注意力 SoftMax 之后的自注意力头中的注意力权重，用于计算加权平均值。
  • cross_attentions（tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
    在注意力 SoftMax 之后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
  • past_key_values（tuple(tuple(jnp.ndarray))，可选，当传递use_cache=True或config.use_cache=True时返回）- 长度为config.n_layers的jnp.ndarray元组的元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态，如果模型用于编码器-解码器设置，则相关。仅在config.is_decoder = True时相关。
    包含预先计算的隐藏状态（注意力块中的键和值），可用于加速顺序解码（参见past_key_values输入）。

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

虽然前向传递的步骤需要在此函数内定义，但应该在此之后调用Module实例，而不是在此处调用，因为前者会处理运行前后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, FlaxRobertaForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("roberta-base")
>>> model = FlaxRobertaForCausalLM.from_pretrained("roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]


Transformers 4.37 中文文档（五十五）（8）https://developer.aliyun.com/article/1565398?spm=a2c6h.13148508.setting.15.7df94f0epaH6GK

文章标签：
索引
算法框架/工具
Python
PyTorch
缓存
布客飞龙
目录
相关文章
布客飞龙
|
4月前
|
PyTorch 算法框架/工具 索引
Transformers 4.37 中文文档（八十四）（3）
Transformers 4.37 中文文档（八十四）
布客飞龙
117 3
布客飞龙
|
4月前
|
PyTorch 算法框架/工具 异构计算
Transformers 4.37 中文文档（八十四）（5）
Transformers 4.37 中文文档（八十四）
布客飞龙
35 3
布客飞龙
|
4月前
|
存储 编解码 PyTorch
Transformers 4.37 中文文档（八十四）（1）
Transformers 4.37 中文文档（八十四）
布客飞龙
65 4
布客飞龙
|
4月前
|
PyTorch TensorFlow API
Transformers 4.37 中文文档（八十四）（4）
Transformers 4.37 中文文档（八十四）
布客飞龙
90 4
布客飞龙
|
4月前
|
自然语言处理 PyTorch 算法框架/工具
Transformers 4.37 中文文档（八十四）（2）
Transformers 4.37 中文文档（八十四）
布客飞龙
53 3
布客飞龙
|
4月前
|
PyTorch 算法框架/工具 索引
Transformers 4.37 中文文档（五十五）（9）
Transformers 4.37 中文文档（五十五）
布客飞龙
23 0
布客飞龙
|
4月前
|
存储 PyTorch API
Transformers 4.37 中文文档（五十五）（1）
Transformers 4.37 中文文档（五十五）
布客飞龙
26 0
布客飞龙
|
4月前
|
自然语言处理 PyTorch TensorFlow
Transformers 4.37 中文文档（五十五）（4）
Transformers 4.37 中文文档（五十五）
布客飞龙
27 0
布客飞龙
|
4月前
|
PyTorch TensorFlow 算法框架/工具
Transformers 4.37 中文文档（五十五）（6）
Transformers 4.37 中文文档（五十五）
布客飞龙
31 0
布客飞龙
|
4月前
|
缓存 PyTorch 算法框架/工具
Transformers 4.37 中文文档（五十五）（3）
Transformers 4.37 中文文档（五十五）
布客飞龙
28 0