参数

• text (str, list[str], list[list[str]]) — 要编码的序列或序列批次。每个序列必须是字符串。请注意，此分词器不支持基于预分词字符串的分词。
• text_pair (str, list[str], list[list[str]]) — 要编码的序列或序列批次。每个序列必须是字符串。请注意，此分词器不支持基于预分词字符串的分词。
• entity_spans (list[tuple[int, int]], list[list[tuple[int, int]]], 可选) — 要编码的实体跨度序列或序列批次。每个序列由元组组成，每个元组包含两个整数，表示实体的基于字符的开始和结束位置。如果您在构造函数中将 task 参数指定为 "entity_classification" 或 "entity_pair_classification"，则每个序列的长度必须分别为 1 或 2。如果您指定 entities，则每个序列的长度必须等于 entities 中每个序列的长度。
• entity_spans_pair (list[tuple[int, int]], list[list[tuple[int, int]]], 可选) — 要编码的实体跨度序列或序列批次。每个序列由元组组成，每个元组包含两个整数，表示实体的基于字符的开始和结束位置。如果您在构造函数中指定 task 参数，则此参数将被忽略。如果您指定 entities_pair，则每个序列的长度必须等于 entities_pair 中每个序列的长度。
• 实体 (list[str], list[list[str]], 可选) — 要编码的实体序列或批次序列。每个序列由表示实体的字符串组成，即特殊实体（例如 [MASK]）或维基百科的实体标题（例如 Los Angeles）。如果您在构造函数中指定了 task 参数，则此参数将被忽略。每个序列的长度必须等于每个 entity_spans 序列的长度。如果您在未指定此参数的情况下指定了 entity_spans，则实体序列或实体序列批次将通过填充 [MASK] 实体自动构建。
• 实体对 (list[str], list[list[str]], 可选) — 要编码的实体序列或批次序列。每个序列由表示实体的字符串组成，即特殊实体（例如 [MASK]）或维基百科的实体标题（例如 Los Angeles）。如果您在构造函数中指定了 task 参数，则此参数将被忽略。每个序列的长度必须等于每个 entity_spans_pair 序列的长度。如果您在未指定此参数的情况下指定了 entity_spans_pair，则实体序列或实体序列批次将通过填充 [MASK] 实体自动构建。
• 最大实体长度 (int, 可选) — entity_ids 的最大长度。
• 添加特殊标记 (bool, 可选, 默认为 True) — 在编码序列时是否添加特殊标记。这将使用底层 PretrainedTokenizerBase.build_inputs_with_special_tokens 函数，该函数定义了哪些标记会自动添加到输入 ID。如果您希望自动添加 bos 或 eos 标记，这会很有用。
• 填充 (bool, str 或 PaddingStrategy, 可选, 默认为 False) — 激活和控制填充。接受以下值：
  • True 或 'longest'：填充到批次中最长的序列（如果只提供一个序列，则不填充）。
  • 'max_length'：填充到由参数 max_length 指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。
  • False 或 'do_not_pad' (默认)：不填充（即，可以输出具有不同长度序列的批次）。
• 截断 (bool, str 或 TruncationStrategy, 可选, 默认为 False) — 激活和控制截断。接受以下值：
  • True 或 'longest_first'：截断到由参数 max_length 指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了一对序列（或批次对），这将逐个标记进行截断，从对中最长的序列中移除一个标记。
  • 'only_first'：截断到由参数 max_length 指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了一对序列（或批次对），这将只截断对的第一个序列。
  • 'only_second'：截断到由参数 max_length 指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了一对序列（或批次对），这将只截断对的第二个序列。
  • False 或 'do_not_truncate' (默认)：不截断（即，可以输出序列长度大于模型最大允许输入大小的批次）。
• 最大长度 (int, 可选) — 控制截断/填充参数之一所使用的最大长度。

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

• 步长 (int, 可选, 默认为 0) — 如果设置为一个数字并结合 max_length 使用，则当 return_overflowing_tokens=True 时返回的溢出标记将包含来自截断序列末尾的一些标记，以在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。
• 已分词 (bool, 可选, 默认为 False) — 输入是否已预分词（例如，已拆分为单词）。如果设置为 True，则分词器假定输入已拆分为单词（例如，通过在空白处拆分），然后对其进行分词。这对于 NER 或标记分类很有用。
• 填充到倍数 (int, 可选) — 如果设置，将序列填充到所提供值的倍数。需要激活 padding。这对于在计算能力 >= 7.5 (Volta) 的 NVIDIA 硬件上启用 Tensor Cores 特别有用。
• 填充方向 (str, 可选) — 模型应该在哪个方向上应用填充。应在 ['right', 'left'] 之间选择。默认值取自同名类属性。
• 返回张量 (str 或 TensorType, 可选) — 如果设置，将返回张量而不是 Python 整数列表。可接受的值有：
  • 'tf'：返回 TensorFlow tf.constant 对象。
  • 'pt'：返回 PyTorch torch.Tensor 对象。
  • 'np'：返回 Numpy np.ndarray 对象。
• 返回标记类型 ID (bool, 可选) — 是否返回标记类型 ID。如果保留默认值，将根据特定分词器的默认值（由 return_outputs 属性定义）返回标记类型 ID。

  什么是标记类型 ID？

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

  什么是注意力掩码？

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

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

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

一个 BatchEncoding，包含以下字段：

• input_ids — 要输入到模型中的标记 ID 列表。

  什么是输入 ID？

• token_type_ids — 要输入到模型中的标记类型 ID 列表（当 return_token_type_ids=True 或如果 *“token_type_ids”* 在 self.model_input_names 中时）。

  什么是标记类型 ID？

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

  什么是注意力掩码？

• 实体 ID — 实体 ID 列表，用于馈送到模型中。

  什么是输入 ID？

• 实体位置 ID — 实体在输入序列中的位置 ID 列表，用于馈送到模型中。

• 实体标记类型 ID — 实体标记类型 ID 列表，用于馈送到模型中（当 return_token_type_ids=True 或如果 "entity_token_type_ids" 在 self.model_input_names 中）。

  什么是标记类型 ID？

• 实体注意力掩码 — 指定模型应关注哪些实体的索引列表（当 return_attention_mask=True 或如果 "entity_attention_mask" 在 self.model_input_names 中）。

  什么是注意力掩码？

• 实体起始位置 — 实体在单词标记序列中的起始位置列表（当 task="entity_span_classification" 时）。

• 实体结束位置 — 实体在单词标记序列中的结束位置列表（当 task="entity_span_classification" 时）。

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

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

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

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