参数

• text (str, List[str], List[List[str]]) — 要编码的序列或序列批次。每个序列可以是字符串、字符串列表（单个示例的单词或批次示例的问题）或字符串列表列表（单词批次）。
• text_pair (List[str], List[List[str]]) — 要编码的序列或序列批次。每个序列应为字符串列表（预标记字符串）。
• boxes (List[List[int]], List[List[List[int]]]) — 词级边界框。每个边界框应规范化为 0-1000 比例。
• word_labels (List[int], List[List[int]], 可选) — 词级整数标签（用于 FUNSD、CORD 等标记分类任务）。
• add_special_tokens (bool, 可选, 默认值为 True) — 是否用其模型相关的特殊标记编码序列。
• padding (bool, str 或 PaddingStrategy, 可选, 默认值为 False) — 激活和控制填充。接受以下值：
  • True 或 'longest': 将批次中的最长序列填充到相同长度（如果只提供单个序列，则不进行填充）。
  • 'max_length': 填充到由 max_length 参数指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。
  • False 或 'do_not_pad' (默认): 不填充（即可以输出具有不同长度序列的批次）。
• truncation (bool, str 或 TruncationStrategy, 可选, 默认值为 False) — 激活和控制截断。接受以下值：
  • True 或 'longest_first': 截断到由 max_length 参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。这将逐个token截断，如果提供一对序列（或一对序列的批次），则从最长序列中删除一个token。
  • 'only_first': 截断到由 max_length 参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供一对序列（或一对序列的批次），这将只截断第一条序列。
  • 'only_second': 截断到由 max_length 参数指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供一对序列（或一对序列的批次），这将只截断第二条序列。
  • False 或 'do_not_truncate' (默认): 不截断（即可以输出序列长度大于模型最大可接受输入大小的批次）。
• max_length (int, 可选) — 通过截断/填充参数控制使用的最大长度。

  如果未设置或设置为 None，则如果截断/填充参数需要最大长度，这将使用预定义的模型最大长度。如果模型没有特定的最大输入长度（如 XLNet），则截断/填充到最大长度将被禁用。

• stride (int, 可选, 默认值为 0) — 如果与 max_length 一起设置为一个数字，当 return_overflowing_tokens=True 时返回的溢出token将包含截断序列末尾的一些token，以在截断序列和溢出序列之间提供一些重叠。此参数的值定义重叠token的数量。
• pad_to_multiple_of (int, 可选) — 如果设置，将序列填充到提供的值的倍数。这对于在具有计算能力 >= 7.5 (Volta) 的 NVIDIA 硬件上启用 Tensor Core 的使用特别有用。
• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回张量而不是 Python 整数列表。可接受的值为：
  • 'tf': 返回 TensorFlow tf.constant 对象。
  • 'pt': 返回 PyTorch torch.Tensor 对象。
  • 'np': 返回 Numpy np.ndarray 对象。
• return_token_type_ids (bool, 可选) — 是否返回token类型ID。如果保留默认值，将根据特定分词器的默认值返回token类型ID，由 return_outputs 属性定义。

  什么是token类型ID？

• return_attention_mask (bool, 可选) — 是否返回注意力掩码。如果保留默认值，将根据特定分词器的默认值返回注意力掩码，由 return_outputs 属性定义。

  什么是注意力掩码？

• return_overflowing_tokens (bool, 可选, 默认值为 False) — 是否返回溢出token序列。如果使用 truncation_strategy = longest_first 或 True 提供一对输入ID序列（或一对序列的批次），则会引发错误，而不是返回溢出token。
• return_special_tokens_mask (bool, 可选, 默认值为 False) — 是否返回特殊token掩码信息。
• return_offsets_mapping (bool, 可选, 默认值为 False) — 是否返回每个token的(char_start, char_end)。

  此功能仅适用于继承自 PreTrainedTokenizerFast 的快速分词器，如果使用 Python 的分词器，此方法将引发 NotImplementedError。

• return_length (bool, 可选, 默认值为 False) — 是否返回编码输入的长度。
• verbose (bool, 可选, 默认值为 True) — 是否打印更多信息和警告。 **kwargs — 传递给 self.tokenize() 方法

具有以下字段的 BatchEncoding

• input_ids — 要馈送到模型的token ID 列表。

  什么是输入 ID？

• bbox — 要馈送到模型的边界框列表。

• token_type_ids — 要馈送到模型的token类型ID列表（当 return_token_type_ids=True 或 “token_type_ids” 在 self.model_input_names 中时）。

  什么是token类型ID？

• attention_mask — 指定模型应该关注哪些token的索引列表（当 return_attention_mask=True 或 “attention_mask” 在 self.model_input_names 中时）。

  什么是注意力掩码？

• labels — 要馈送到模型的标签列表。（当指定 word_labels 时）。

• overflowing_tokens — 溢出token序列列表（当指定 max_length 且 return_overflowing_tokens=True 时）。

• num_truncated_tokens — 被截断的token数量（当指定 max_length 且 return_overflowing_tokens=True 时）。

• special_tokens_mask — 0 和 1 列表，其中 1 表示添加的特殊token，0 表示常规序列token（当 add_special_tokens=True 且 return_special_tokens_mask=True 时）。

• length — 输入的长度（当 return_length=True 时）。

参数

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

带有适当特殊token的 输入ID 列表。

参数

• token_ids_0 (List[int]) — ID 列表。
• token_ids_1 (List[int], 可选) — 用于序列对的可选第二个 ID 列表。
• already_has_special_tokens (bool, 可选, 默认值为 False) — 令牌列表是否已经使用模型的特殊令牌进行格式化。

一个范围在 [0, 1] 之内的整数列表：1 表示特殊令牌，0 表示序列令牌。

参数

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

零列表。

参数

• text (str, List[str], List[List[str]]) — 要编码的序列或序列批次。 每个序列可以是字符串、字符串列表（单个示例的单词或示例批次的查询）或字符串列表列表（单词批次）。
• text_pair (List[str], List[List[str]]) — 要编码的序列或序列批次。 每个序列都应该是字符串列表（预标记化字符串）。
• boxes (List[List[int]], List[List[List[int]]]) — 词级边界框。 每个边界框都应归一化为 0-1000 范围内的比例。
• word_labels (List[int], List[List[int]], 可选) — 词级整数标签（用于 FUNSD、CORD 等 token 分类任务）。
• padding (bool, str 或 PaddingStrategy, 可选, 默认值为 False) — 激活并控制填充。接受以下值：
  • True 或 'longest'：填充到批次中最长的序列（如果只提供单个序列，则不填充）。
  • 'max_length'：填充到使用参数 max_length 指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。
  • False 或 'do_not_pad' (默认)：不填充（即，可以输出具有不同长度序列的批次）。
• truncation (bool, str 或 TruncationStrategy, 可选, 默认值为 False) — 激活并控制截断。接受以下值：
  • True 或 'longest_first'：截断到使用参数 max_length 指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供一对序列（或一对序列的批次），这将逐个token进行截断，从最长序列中删除一个token。
  • 'only_first'：截断到使用参数 max_length 指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供一对序列（或一对序列的批次），这将只截断一对中的第一个序列。
  • 'only_second'：截断到使用参数 max_length 指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供一对序列（或一对序列的批次），这将只截断一对中的第二个序列。
  • False 或 'do_not_truncate' (默认)：不截断（即，可以输出序列长度大于模型最大可接受输入大小的批次）。
• max_length (int, 可选) — 控制截断/填充参数所使用的最大长度。

  如果未设置或设置为 None，则如果截断/填充参数需要最大长度，则将使用预定义的模型最大长度。如果模型没有特定的最大输入长度（如 XLNet），则将禁用截断/填充到最大长度。

• stride (int, 可选, 默认值为 0) — 如果与 max_length 一起设置为一个数字，当 return_overflowing_tokens=True 时返回的溢出token将包含截断序列末尾的一些token，以在截断序列和溢出序列之间提供一些重叠。此参数的值定义重叠token的数量。
• pad_to_multiple_of (int, 可选) — 如果设置，将填充序列到所提供值的倍数。这对于在 NVIDIA 硬件（具有计算能力 >= 7.5 (Volta)）上启用 Tensor Core 的使用特别有用。
• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回张量而不是 python 整数列表。可接受的值为：
  • 'tf'：返回 TensorFlow tf.constant 对象。
  • 'pt'：返回 PyTorch torch.Tensor 对象。
  • 'np'：返回 Numpy np.ndarray 对象。
• return_token_type_ids (bool, 可选) — 是否返回token类型ID。如果保留默认值，将根据特定分词器的默认值返回token类型ID，由 return_outputs 属性定义。

  什么是token类型ID？

• return_attention_mask (bool, 可选) — 是否返回注意力掩码。如果保留默认值，将根据特定分词器的默认值返回注意力掩码，由 return_outputs 属性定义。

  什么是注意力掩码？

• return_overflowing_tokens (bool, 可选, 默认值为 False) — 是否返回溢出token序列。如果使用 truncation_strategy = longest_first 或 True 提供一对输入ID序列（或一对序列的批次），则会引发错误而不是返回溢出token。
• return_special_tokens_mask (bool, 可选, 默认值为 False) — 是否返回特殊标记掩码信息。
• return_offsets_mapping (bool, 可选, 默认值为 False) — 是否返回每个标记的 (char_start, char_end)。

  这仅适用于从 PreTrainedTokenizerFast 继承的快速分词器，如果使用 Python 的分词器，此方法将引发 NotImplementedError。

• return_length (bool, 可选, 默认值为 False) — 是否返回编码输入的长度。
• verbose (bool, 可选, 默认值为 True) — 是否打印更多信息和警告。 **kwargs — 传递给 self.tokenize() 方法

具有以下字段的 BatchEncoding

• input_ids — 要馈送到模型的token ID 列表。

  什么是输入 ID？

• bbox — 要馈送到模型的边界框列表。

• token_type_ids — 要馈送到模型的token类型ID列表（当 return_token_type_ids=True 或 “token_type_ids” 在 self.model_input_names 中时）。

  什么是token类型ID？

• attention_mask — 指定模型应该关注哪些token的索引列表（当 return_attention_mask=True 或 “attention_mask” 在 self.model_input_names 中时）。

  什么是注意力掩码？

• labels — 要馈送到模型的标签列表。（当指定 word_labels 时）。

• overflowing_tokens — 溢出token序列列表（当指定 max_length 且 return_overflowing_tokens=True 时）。

• num_truncated_tokens — 被截断的token数量（当指定 max_length 且 return_overflowing_tokens=True 时）。

• special_tokens_mask — 0 和 1 列表，其中 1 表示添加的特殊token，0 表示常规序列token（当 add_special_tokens=True 且 return_special_tokens_mask=True 时）。

• length — 输入的长度（当 return_length=True 时）。