参数

• 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]]], optional) — 要编码的实体跨度序列或实体跨度序列批次。每个序列由元组组成，每个元组包含两个整数，表示基于字符的实体的起始和结束位置。 如果您在构造函数中将 "entity_classification" 或 "entity_pair_classification" 指定为 task 参数，则每个序列的长度必须分别为 1 或 2。 如果您指定 entities，则每个序列的长度必须等于每个 entities 序列的长度。
• entity_spans_pair (List[Tuple[int, int]], List[List[Tuple[int, int]]], optional) — 要编码的成对实体跨度序列或成对实体跨度序列批次。每个序列由元组组成，每个元组包含两个整数，表示基于字符的实体的起始和结束位置。 如果您在构造函数中指定了 task 参数，则此参数将被忽略。 如果您指定 entities_pair，则每个序列的长度必须等于每个 entities_pair 序列的长度。
• entities (List[str], List[List[str]], optional) — 要编码的实体序列或实体序列批次。每个序列由表示实体的字符串组成，即特殊实体（例如，[MASK]）或维基百科的实体标题（例如，Los Angeles）。 如果您在构造函数中指定了 task 参数，则此参数将被忽略。 每个序列的长度必须等于每个 entity_spans 序列的长度。 如果您指定了 entity_spans 而未指定此参数，则实体序列或实体序列批次将通过填充 [MASK] 实体自动构建。
• entities_pair (List[str], List[List[str]], optional) — 要编码的成对实体序列或成对实体序列批次。每个序列由表示实体的字符串组成，即特殊实体（例如，[MASK]）或维基百科的实体标题（例如，Los Angeles）。 如果您在构造函数中指定了 task 参数，则此参数将被忽略。 每个序列的长度必须等于每个 entity_spans_pair 序列的长度。 如果您指定了 entity_spans_pair 而未指定此参数，则实体序列或实体序列批次将通过填充 [MASK] 实体自动构建。
• max_entity_length (int, optional) — entity_ids 的最大长度。
• add_special_tokens (bool, optional, defaults to True) — 是否在编码序列时添加特殊 token。 这将使用底层的 PretrainedTokenizerBase.build_inputs_with_special_tokens 函数，该函数定义了哪些 token 会自动添加到 input ids 中。 如果您想自动添加 bos 或 eos token，这将非常有用。
• padding (bool, str or PaddingStrategy, optional, defaults to False) — 激活并控制填充。 接受以下值：
  • True 或 'longest': 填充到批次中最长序列的长度（如果仅提供单个序列，则不填充）。
  • 'max_length': 填充到由参数 max_length 指定的最大长度，如果未提供该参数，则填充到模型可接受的最大输入长度。
  • False 或 'do_not_pad' (默认): 不填充（即，可以输出具有不同长度序列的批次）。
• truncation (bool, str or TruncationStrategy, optional, defaults to False) — 激活并控制截断。 接受以下值：
  • True 或 'longest_first': 截断为由参数 max_length 指定的最大长度，如果未提供该参数，则截断为模型可接受的最大输入长度。 如果提供了一对序列（或成对批次），这将逐个 token 截断，从序列对中最长的序列中删除一个 token。
  • 'only_first': 截断为由参数 max_length 指定的最大长度，如果未提供该参数，则截断为模型可接受的最大输入长度。 如果提供了一对序列（或成对批次），这将仅截断序列对中的第一个序列。
  • 'only_second': 截断为由参数 max_length 指定的最大长度，如果未提供该参数，则截断为模型可接受的最大输入长度。 如果提供了一对序列（或成对批次），这将仅截断序列对中的第二个序列。
  • False 或 'do_not_truncate' (默认): 不截断（即，可以输出序列长度大于模型最大允许输入大小的批次）。
• max_length (int, optional) — 控制截断/填充参数之一使用的最大长度。

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

• stride (int, optional, defaults to 0) — 如果与 max_length 一起设置为数字，则当 return_overflowing_tokens=True 时返回的溢出 token 序列将包含来自截断序列末尾的一些 token，以便在截断序列和溢出序列之间提供一些重叠。 此参数的值定义了重叠 token 的数量。
• is_split_into_words (bool, optional, defaults to False) — 输入是否已预分词（例如，拆分为单词）。 如果设置为 True，则分词器假定输入已拆分为单词（例如，通过在空格上拆分），它将对这些单词进行分词。 这对于 NER 或 token 分类非常有用。
• pad_to_multiple_of (int, optional) — 如果设置，则将序列填充到提供的值的倍数。 需要激活 padding。 这对于在计算能力 >= 7.5 (Volta) 的 NVIDIA 硬件上启用 Tensor Core 的使用尤其有用。
• padding_side (str, optional) — 模型应在其上应用填充的一侧。 应从 [‘right’, ‘left’] 中选择。 默认值从同名的类属性中选取。
• return_tensors (str or TensorType, optional) — 如果设置，将返回 tensor 而不是 python 整数列表。 可接受的值为：
  • 'tf': 返回 TensorFlow tf.constant 对象。
  • 'pt': 返回 PyTorch torch.Tensor 对象。
  • 'np': 返回 Numpy np.ndarray 对象。
• return_token_type_ids (bool, optional) — 是否返回 token 类型 ID。 如果保留为默认值，将根据特定分词器的默认值返回 token 类型 ID，由 return_outputs 属性定义。

  什么是 token 类型 ID？

• return_attention_mask (bool, optional) — 是否返回 attention mask。 如果保留为默认值，将根据特定分词器的默认值返回 attention mask，由 return_outputs 属性定义。

  什么是 attention mask？

• return_overflowing_tokens (bool, optional, defaults to False) — 是否返回溢出的 token 序列。 如果提供了一对输入 id 序列（或成对批次），并且 truncation_strategy = longest_first 或 True，则会引发错误，而不是返回溢出的 token。
• return_special_tokens_mask (bool, optional, defaults to False) — 是否返回特殊 token mask 信息。
• return_offsets_mapping (bool, optional, defaults to False) — 是否为每个 token 返回 (char_start, char_end)。

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

• return_length (bool, optional, defaults to False) — 是否返回编码输入的长度。
• verbose (bool, optional, defaults to 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 中时）。

  什么是 attention mask？

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

  什么是 attention mask？

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