参数

• 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]]], 可选) — 要编码的实体跨度的序列或批次序列。每个序列都包含元组，每个元组有两个整数，表示实体的基于字符的起始和结束位置。如果您在构造函数中将"entity_classification"或"entity_pair_classification"指定为task参数，则每个序列的长度必须分别为1或2。如果您指定了entities，则每个序列的长度必须等于每个entities序列的长度。
• entity_spans_pair (List[Tuple[int, int]], List[List[Tuple[int, int]]], 可选) — 要编码的实体跨度的序列或批次序列。每个序列都包含元组，每个元组有两个整数，表示实体的基于字符的起始和结束位置。如果您在构造函数中指定了task参数，则忽略此参数。如果您指定了entities_pair，则每个序列的长度必须等于每个entities_pair序列的长度。
• entities (List[str], List[List[str]], 可选) — 要编码的实体的序列或批次序列。每个序列都包含表示实体的字符串，即特殊实体（例如，[MASK]）或维基百科的实体标题（例如，洛杉矶）。如果您在构造函数中指定了task参数，则忽略此参数。每个序列的长度必须等于每个entity_spans序列的长度。如果您指定了entity_spans但未指定此参数，则会自动构造实体序列或实体序列的批次，并将其填充为[MASK]实体。
• entities_pair (List[str], List[List[str]], 可选) — 要编码的实体的序列或批次序列。每个序列都包含表示实体的字符串，即特殊实体（例如，[MASK]）或维基百科的实体标题（例如，洛杉矶）。如果您在构造函数中指定了task参数，则忽略此参数。每个序列的长度必须等于每个entity_spans_pair序列的长度。如果您指定了entity_spans_pair但未指定此参数，则会自动构造实体序列或实体序列的批次，并将其填充为[MASK]实体。
• max_entity_length (int, 可选) — entity_ids的最大长度。
• add_special_tokens (bool, 可选，默认为True) — 是否在编码序列时添加特殊标记。这将使用底层的PretrainedTokenizerBase.build_inputs_with_special_tokens函数，该函数定义了哪些标记会自动添加到输入 ID 中。如果您想自动添加bos或eos标记，这将非常有用。
• 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指定的最大长度，或者如果未提供该参数，则截断到模型可接受的最大输入长度。如果提供了序列对（或序列对的批次），这将逐个标记进行截断，从对中最长的序列中删除一个标记。
  • '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 时返回的溢出标记将包含截断序列末尾的一些标记，以在截断和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。
• is_split_into_words (bool，可选，默认为 False) — 输入是否已被预先分词（例如，拆分为单词）。如果设置为 True，则分词器假设输入已拆分为单词（例如，通过在空格处拆分），它将对这些单词进行分词。这对于 NER 或标记分类很有用。
• pad_to_multiple_of (int，可选) — 如果设置，则将序列填充到提供的值的倍数。需要激活 padding。这对于在具有计算能力 >= 7.5（Volta）的 NVIDIA 硬件上启用 Tensor Core 特别有用。
• padding_side (str，可选) — 模型应在其上应用填充的一侧。应从 [‘right’, ‘left’] 中选择。默认值从同名的类属性中获取。
• return_tensors (str 或 TensorType，可选) — 如果设置，则返回张量而不是 Python 整数列表。可接受的值为：
  • 'tf'：返回 TensorFlow tf.constant 对象。
  • 'pt'：返回 PyTorch torch.Tensor 对象。
  • 'np'：返回 Numpy np.ndarray 对象。
• return_token_type_ids (bool，可选) — 是否返回标记类型 ID。如果保留为默认值，则将根据特定分词器的默认值返回标记类型 ID，由 return_outputs 属性定义。

  什么是标记类型 ID？

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

  什么是注意力掩码？

• return_overflowing_tokens (bool，可选，默认为 False) — 是否返回溢出标记序列。如果使用 truncation_strategy = longest_first 或 True 提供了一对输入 ID 序列（或一对批次），则会引发错误而不是返回溢出标记。
• return_special_tokens_mask (bool，可选，默认为 False) — 是否返回特殊标记掩码信息。
• 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？

• 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 中时）。

  什么是注意力掩码？

• entity_ids — 要馈送到模型的实体 ID 列表。

  什么是输入 ID？

• entity_position_ids — 要馈送到模型的输入序列中实体位置的列表。

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

  什么是 token 类型 ID？

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

  什么是注意力掩码？

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

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

• 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 时）