Transformers 4.37 中文文档(二十八)(4)https://developer.aliyun.com/article/1563598
TFDebertaForMaskedLM
class transformers.TFDebertaForMaskedLM
( config: DebertaConfig *inputs **kwargs )
参数
config
(DebertaConfig)— 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained()方法以加载模型权重。
DeBERTa 模型在顶部带有一个语言建模
头。DeBERTa 模型是由 Pengcheng He、Xiaodong Liu、Jianfeng Gao、Weizhu Chen 在DeBERTa: Decoding-enhanced BERT with Disentangled Attention中提出的。它是在 BERT/RoBERTa 的基础上进行了两项改进,即解耦注意力和增强掩码解码器。通过这两项改进,它在 80GB 预训练数据上的大多数任务中表现优于 BERT/RoBERTa。
这个模型也是一个tf.keras.Model的子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档以获取与一般用法和行为相关的所有内容。
transformers
中的 TensorFlow 模型和层接受两种格式的输入:
- 将所有输入作为关键字参数(类似于 PyTorch 模型),或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用model.fit()
等方法时,应该可以“正常工作” - 只需以model.fit()
支持的任何格式传递输入和标签!但是,如果您想在 Keras 方法之外使用第二种格式,例如在使用 Keras Functional
API 创建自己的层或模型时,有三种可能性可用于在第一个位置参数中收集所有输入张量:
- 一个只包含
input_ids
的单个张量,没有其他内容:model(input_ids)
- 一个长度不定的列表,其中包含一个或多个按照文档字符串中给定顺序的输入张量:
model([input_ids, attention_mask])
或model([input_ids, attention_mask, token_type_ids])
- 一个字典,其中包含一个或多个与文档字符串中给定输入名称相关联的输入张量:
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意,当使用子类化创建模型和层时,您无需担心这些问题,因为您可以像对待任何其他 Python 函数一样传递输入!
call
( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None 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 ) → export const metadata = 'undefined';transformers.modeling_tf_outputs.TFMaskedLMOutput or tuple(tf.Tensor)
参数
input_ids
(np.ndarray
,tf.Tensor
,List[tf.Tensor]
``Dict[str, tf.Tensor]或
Dict[str, np.ndarray],每个示例的形状必须为
(batch_size, sequence_length)`)— 词汇表中输入序列标记的索引。
可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call
()。
什么是输入 ID?attention_mask
(形状为(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选)— 用于避免在填充标记索引上执行注意力的掩码。选择的掩码值在[0, 1]
中:
- 对于
未被掩码
的标记为 1, - 对于
被掩码
的标记为 0。
- 什么是注意力掩码?
token_type_ids
(np.ndarray
或tf.Tensor
,形状为(batch_size, sequence_length)
,可选) — 段标记索引,用于指示输入的第一部分和第二部分。索引在[0, 1]
中选择:
- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
- 什么是标记类型 ID?
position_ids
(np.ndarray
或tf.Tensor
,形状为(batch_size, sequence_length)
,可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]
中选择。
什么是位置 ID?inputs_embeds
(np.ndarray
或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
,可选) — 是否返回一个 [`~utils.ModelOutput“] 而不是一个普通元组。标签
(tf.Tensor
或np.ndarray
,形状为(batch_size, sequence_length)
,可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]
内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(掩码),损失仅计算具有标签在[0, ..., config.vocab_size]
内的标记。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 tf.Tensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
)包含根据配置(DebertaConfig)和输入的不同元素。
loss
(tf.Tensor
,形状为(n,)
,可选,其中 n 是非掩码标签的数量,当提供labels
时返回) — 掩码语言建模(MLM)损失。logits
(tf.Tensor
,形状为(batch_size, sequence_length, config.vocab_size)
) — 语言建模头的预测分数(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 之后的注意力权重,用于计算自注意力头中的加权平均值。
TFDebertaForMaskedLM 的前向方法,覆盖了 __call__
特殊方法。
虽然前向传递的配方需要在此函数内定义,但应该在此之后调用 Module
实例,而不是在此处调用,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, TFDebertaForMaskedLM >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base") >>> model = TFDebertaForMaskedLM.from_pretrained("kamalkraj/deberta-base") >>> 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)
>>> 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)
TFDebertaForSequenceClassification
class transformers.TFDebertaForSequenceClassification
( config: DebertaConfig *inputs **kwargs )
参数
config
(DebertaConfig)- 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained()方法以加载模型权重。
DeBERTa 模型变压器,顶部带有序列分类/回归头(池化输出的线性层),例如用于 GLUE 任务。
DeBERTa 模型是由 Pengcheng He,Xiaodong Liu,Jianfeng Gao,Weizhu Chen 在DeBERTa: Decoding-enhanced BERT with Disentangled Attention中提出的。它在 BERT/RoBERTa 的基础上进行了两项改进,即解缠注意力和增强掩码解码器。通过这两项改进,它在 80GB 预训练数据上的大多数任务上表现优于 BERT/RoBERTa。
该模型也是一个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 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 ) → export const metadata = 'undefined';transformers.modeling_tf_outputs.TFSequenceClassifierOutput or tuple(tf.Tensor)
参数
input_ids
(np.ndarray
,tf.Tensor
,List[tf.Tensor]
,Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
,每个示例的形状必须为(batch_size, sequence_length)
)- 词汇表中输入序列标记的索引。
可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call
()。
什么是输入 ID?attention_mask
(np.ndarray
或tf.Tensor
of shape(batch_size, sequence_length)
, 可选) — 用于避免在填充令牌索引上执行注意力的掩码。选择的掩码值为[0, 1]
:
- 1 表示未被掩盖的令牌,
- 0 表示被
masked
的令牌。
- 什么是注意力掩码?
token_type_ids
(np.ndarray
或tf.Tensor
of shape(batch_size, sequence_length)
, 可选) — 段令牌索引,指示输入的第一部分和第二部分。索引在[0, 1]
中选择:
- 0 对应于句子 A令牌,
- 1 对应于句子 B令牌。
- 什么是令牌类型 ID?
position_ids
(np.ndarray
或tf.Tensor
of shape(batch_size, sequence_length)
, 可选) — 每个输入序列令牌在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]
中选择。
什么是位置 ID?inputs_embeds
(np.ndarray
或tf.Tensor
of shape(batch_size, sequence_length, hidden_size)
, 可选) — 可选地,您可以直接传递嵌入表示而不是传递input_ids
。如果您想要更多控制权来将input_ids索引转换为相关向量,这将非常有用,而不是使用模型的内部嵌入查找矩阵。output_attentions
(bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的attentions
。output_hidden_states
(bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的hidden_states
。return_dict
(bool
, 可选) — 是否返回[~utils.ModelOutput
]而不是普通元组。labels
(tf.Tensor
或np.ndarray
of shape(batch_size,)
, 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]
范围内。如果config.num_labels == 1
,则计算回归损失(均方损失),如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个tf.Tensor
元组(如果传递return_dict=False
或config.return_dict=False
时)包含各种元素,这取决于配置(DebertaConfig)和输入。
loss
(tf.Tensor
of shape(batch_size, )
, 可选, 当提供labels
时返回) — 分类(如果 config.num_labels==1 则为回归)损失。logits
(tf.Tensor
of shape(batch_size, config.num_labels)
) — 分类(如果 config.num_labels==1 则为回归)得分(SoftMax 之前)。hidden_states
(tuple(tf.Tensor)
, 可选, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回) — 形状为(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 后的注意力权重。
TFDebertaForSequenceClassification 的前向方法,覆盖了__call__
特殊方法。
尽管前向传递的步骤需要在此函数内定义,但应该在之后调用Module
实例,而不是在此处调用,因为前者会负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, TFDebertaForSequenceClassification >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base") >>> model = TFDebertaForSequenceClassification.from_pretrained("kamalkraj/deberta-base") >>> 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])
>>> # 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 = TFDebertaForSequenceClassification.from_pretrained("kamalkraj/deberta-base", num_labels=num_labels) >>> labels = tf.constant(1) >>> loss = model(**inputs, labels=labels).loss
TFDebertaForTokenClassification
class transformers.TFDebertaForTokenClassification
( config: DebertaConfig *inputs **kwargs )
参数
config
(DebertaConfig)-模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained()方法以加载模型权重。
DeBERTa 模型在顶部有一个标记分类头部(隐藏状态输出的线性层),例如用于命名实体识别(NER)任务。
DeBERTa 模型是由 Pengcheng He、Xiaodong Liu、Jianfeng Gao、Weizhu Chen 在DeBERTa: Decoding-enhanced BERT with Disentangled Attention中提出的。它在 BERT/RoBERTa 的基础上进行了两项改进,即解缠注意力和增强掩码解码器。通过这两项改进,它在 80GB 预训练数据上的大多数任务上表现优于 BERT/RoBERTa。
这个模型也是一个tf.keras.Model子类。将其用作常规的 TF 2.0 Keras 模型,并参考 TF 2.0 文档以获取与一般用法和行为相关的所有内容。
TensorFlow 模型和层在transformers
中接受两种格式的输入:
- 将所有输入作为关键字参数(类似于 PyTorch 模型),或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是,Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于有了这种支持,当使用model.fit()
等方法时,应该可以“正常工作” - 只需以model.fit()
支持的任何格式传递输入和标签即可!但是,如果您想在 Keras 方法之外使用第二种格式,比如在使用 Keras Functional
API 创建自己的层或模型时,有三种可能性可以用来收集第一个位置参数中的所有输入张量:
- 只有一个包含
input_ids
的张量,没有其他内容:model(input_ids)
- 一个长度不定的列表,其中包含一个或多个输入张量,按照文档字符串中给定的顺序:
model([input_ids, attention_mask])
或model([input_ids, attention_mask, token_type_ids])
- 一个字典,其中包含一个或多个与文档字符串中给定的输入名称相关联的输入张量:
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意,当使用子类化创建模型和层时,您不需要担心这些问题,因为您可以像将输入传递给任何其他 Python 函数一样传递输入!
call
( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None 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 ) → export const metadata = 'undefined';transformers.modeling_tf_outputs.TFTokenClassifierOutput or tuple(tf.Tensor)
参数
input_ids
(np.ndarray
、tf.Tensor
、List[tf.Tensor]
、Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
,每个示例的形状必须为(batch_size, sequence_length)
)-词汇表中输入序列标记的索引。
可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call
()。
什么是 input IDs?attention_mask
(np.ndarray
或形状为(batch_size, sequence_length)
的tf.Tensor
,optional) — 避免在填充 token 索引上执行注意力的掩码。掩码值在[0, 1]
中选择:
- 1 表示未被
masked
的 token, - 0 表示被
masked
的 token。
- 什么是 attention masks?
token_type_ids
(np.ndarray
或形状为(batch_size, sequence_length)
的tf.Tensor
,optional) — 指示输入的第一部分和第二部分的段 token 索引。索引在[0, 1]
中选择:
- 0 对应于sentence A token,
- 1 对应于sentence B token。
- 什么是 token type IDs?
position_ids
(np.ndarray
或形状为(batch_size, sequence_length)
的tf.Tensor
,optional) — 每个输入序列 token 的位置嵌入的位置索引。在范围[0, config.max_position_embeddings - 1]
中选择。
什么是 position IDs?inputs_embeds
(np.ndarray
或形状为(batch_size, sequence_length, hidden_size)
的tf.Tensor
,optional) — 可选地,您可以直接传递嵌入表示,而不是传递input_ids
。如果您想要更多控制如何将input_ids索引转换为相关向量,而不是使用模型的内部嵌入查找矩阵,这将非常有用。output_attentions
(bool
, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的attentions
。output_hidden_states
(bool
, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的hidden_states
。return_dict
(bool
, optional) — 是否返回[~utils.ModelOutput
]而不是普通元组。labels
(tf.Tensor
或形状为(batch_size, sequence_length)
的np.ndarray
,optional) — 用于计算 token 分类损失的标签。索引应在[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
时)取决于配置(DebertaConfig)和输入。
loss
(tf.Tensor
,形状为(n,)
,optional,当提供labels
时返回) — 分类损失。logits
(tf.Tensor
,形状为(batch_size, sequence_length, config.num_labels)
) — SoftMax 之前的分类分数。hidden_states
(tuple(tf.Tensor)
, optional, returned whenoutput_hidden_states=True
is passed or whenconfig.output_hidden_states=True
) — 形状为(batch_size, sequence_length, hidden_size)
的tf.Tensor
元组(一个用于嵌入的输出 + 一个用于每个层的输出)。
每个层的模型的隐藏状态加上初始嵌入输出。attentions
(tuple(tf.Tensor)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的tf.Tensor
元组(每个层一个)。
在自注意力头中用于计算加权平均值的注意力 softmax 之后的注意力权重。
TFDebertaForTokenClassification 的前向方法覆盖了__call__
特殊方法。
虽然前向传递的步骤需要在此函数内定义,但应该在此之后调用Module
实例,而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, TFDebertaForTokenClassification >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base") >>> model = TFDebertaForTokenClassification.from_pretrained("kamalkraj/deberta-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) • 1 • 2
TFDebertaForQuestionAnswering
class transformers.TFDebertaForQuestionAnswering
( config: DebertaConfig *inputs **kwargs )
参数
config
(DebertaConfig)— 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained()方法以加载模型权重。
DeBERTa 模型在顶部有一个用于提取式问答任务(如 SQuAD)的跨度分类头(在隐藏状态输出的线性层上计算span start logits
和span end logits
)。
DeBERTa 模型是由 Pengcheng He、Xiaodong Liu、Jianfeng Gao、Weizhu Chen 在DeBERTa: Decoding-enhanced BERT with Disentangled Attention中提出的。它在 BERT/RoBERTa 的基础上进行了两项改进,即解缠注意力和增强掩码解码器。通过这两项改进,它在 80GB 预训练数据上的大多数任务中优于 BERT/RoBERTa。
该模型也是一个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 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
(np.ndarray
,tf.Tensor
,List[tf.Tensor]
,Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
,每个示例的形状必须为(batch_size, sequence_length)
)— 输入序列标记在词汇表中的索引。
可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call
()。
什么是输入 ID?attention_mask
(形状为(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选)- 避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]
中选择:
- 1 表示
未被掩盖
的标记, - 0 表示
被掩盖
的标记。
- 什么是注意力掩码?
token_type_ids
(形状为(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选)- 段标记索引,指示输入的第一部分和第二部分。索引在[0, 1]
中选择:
- 0 对应于句子 A的标记,
- 1 对应于句子 B的标记。
- 什么是标记类型 ID?
position_ids
(形状为(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选)- 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]
中选择。
什么是位置 ID?inputs_embeds
(形状为(batch_size, sequence_length, hidden_size)
的np.ndarray
或tf.Tensor
,可选)- 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您想要更多控制如何将input_ids索引转换为相关向量,而不是使用模型的内部嵌入查找矩阵,这将非常有用。output_attentions
(bool
,可选)- 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。output_hidden_states
(bool
,可选)- 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。return_dict
(bool
,可选)- 是否返回[`~utils.ModelOutput“]而不是普通元组。start_positions
(形状为(batch_size,)
的tf.Tensor
或np.ndarray
,可选)- 用于计算标记分类损失的标记跨度起始位置的标签。位置被夹紧到序列的长度(sequence_length
)。序列外的位置不会计入损失计算。end_positions
(形状为(batch_size,)
的tf.Tensor
或np.ndarray
,可选)- 用于计算标记跨度结束位置的位置(索引)的标签。位置被夹紧到序列的长度(sequence_length
)。序列外的位置不会计入损失计算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或tf.Tensor
的元组(如果传递了return_dict=False
或config.return_dict=False
时)包括根据配置(DebertaConfig)和输入的不同元素。
loss
(形状为(batch_size,)
的tf.Tensor
,可选,当提供start_positions
和end_positions
时返回)- 总跨度提取损失是起始位置和结束位置的交叉熵之和。start_logits
(形状为(batch_size, sequence_length)
的tf.Tensor
)- 跨度起始分数(SoftMax 之前)。end_logits
(tf.Tensor
,形状为(batch_size, sequence_length)
) — 跨度结束得分(SoftMax 之前)。hidden_states
(tuple(tf.Tensor)
, optional, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回 — 形状为(batch_size, sequence_length, hidden_size)
的tf.Tensor
元组。
模型在每一层输出的隐藏状态以及初始嵌入输出。attentions
(tuple(tf.Tensor)
, optional, 当传递output_attentions=True
或config.output_attentions=True
时返回 — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的tf.Tensor
元组。
在注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
TFDebertaForQuestionAnswering 的前向方法重写了__call__
特殊方法。
虽然前向传递的步骤需要在此函数内定义,但应该在此之后调用Module
实例,而不是在此处调用,因为前者会负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, TFDebertaForQuestionAnswering >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base") >>> model = TFDebertaForQuestionAnswering.from_pretrained("kamalkraj/deberta-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)
和第二部分。索引在[0, 1]
中选择:
+ 0 对应于*句子 A*的标记, + 1 对应于*句子 B*的标记。 什么是标记类型 ID?
position_ids
(形状为(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选)- 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]
中选择。
什么是位置 ID?inputs_embeds
(形状为(batch_size, sequence_length, hidden_size)
的np.ndarray
或tf.Tensor
,可选)- 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您想要更多控制如何将input_ids索引转换为相关向量,而不是使用模型的内部嵌入查找矩阵,这将非常有用。output_attentions
(bool
,可选)- 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。output_hidden_states
(bool
,可选)- 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。return_dict
(bool
,可选)- 是否返回[`~utils.ModelOutput“]而不是普通元组。start_positions
(形状为(batch_size,)
的tf.Tensor
或np.ndarray
,可选)- 用于计算标记分类损失的标记跨度起始位置的标签。位置被夹紧到序列的长度(sequence_length
)。序列外的位置不会计入损失计算。end_positions
(形状为(batch_size,)
的tf.Tensor
或np.ndarray
,可选)- 用于计算标记跨度结束位置的位置(索引)的标签。位置被夹紧到序列的长度(sequence_length
)。序列外的位置不会计入损失计算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或tf.Tensor
的元组(如果传递了return_dict=False
或config.return_dict=False
时)包括根据配置(DebertaConfig)和输入的不同元素。
loss
(形状为(batch_size,)
的tf.Tensor
,可选,当提供start_positions
和end_positions
时返回)- 总跨度提取损失是起始位置和结束位置的交叉熵之和。start_logits
(形状为(batch_size, sequence_length)
的tf.Tensor
)- 跨度起始分数(SoftMax 之前)。end_logits
(tf.Tensor
,形状为(batch_size, sequence_length)
) — 跨度结束得分(SoftMax 之前)。hidden_states
(tuple(tf.Tensor)
, optional, 当传递output_hidden_states=True
或config.output_hidden_states=True
时返回 — 形状为(batch_size, sequence_length, hidden_size)
的tf.Tensor
元组。
模型在每一层输出的隐藏状态以及初始嵌入输出。attentions
(tuple(tf.Tensor)
, optional, 当传递output_attentions=True
或config.output_attentions=True
时返回 — 形状为(batch_size, num_heads, sequence_length, sequence_length)
的tf.Tensor
元组。
在注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。
TFDebertaForQuestionAnswering 的前向方法重写了__call__
特殊方法。
虽然前向传递的步骤需要在此函数内定义,但应该在此之后调用Module
实例,而不是在此处调用,因为前者会负责运行预处理和后处理步骤,而后者会默默地忽略它们。
示例:
>>> from transformers import AutoTokenizer, TFDebertaForQuestionAnswering >>> import tensorflow as tf >>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base") >>> model = TFDebertaForQuestionAnswering.from_pretrained("kamalkraj/deberta-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)