参数

• text (str, List[str], List[List[str]], optional) — 要编码的序列或序列批次。每个序列可以是字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）形式提供，则必须设置 is_split_into_words=True (以消除与序列批次的歧义)。
• text_pair (str, List[str], List[List[str]], optional) — 要编码的第二个序列或序列批次。每个序列可以是字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）形式提供，则必须设置 is_split_into_words=True (以消除与序列批次的歧义)。
• text_target (str, List[str], List[List[str]], optional) — 要编码为目标文本的序列或序列批次。每个序列可以是字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）形式提供，则必须设置 is_split_into_words=True (以消除与序列批次的歧义)。
• text_pair_target (str, List[str], List[List[str]], optional) — 要编码为目标文本的第二个序列或序列批次。每个序列可以是字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）形式提供，则必须设置 is_split_into_words=True (以消除与序列批次的歧义)。
• add_special_tokens (bool, optional, defaults to True) — 是否在编码序列时添加特殊 token。 这将使用底层的 PretrainedTokenizerBase.build_inputs_with_special_tokens 函数，该函数定义了哪些 token 会自动添加到 input ids 中。 如果你想自动添加 bos 或 eos token，这将非常有用。
• padding (bool, str 或 PaddingStrategy, optional, defaults to False) — 激活和控制填充。接受以下值：
  • True 或 'longest'：填充到批次中最长序列的长度（如果仅提供单个序列，则不填充）。
  • 'max_length'：填充到 max_length 参数指定的长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。
  • False 或 'do_not_pad' (默认)：不填充（即，可以输出包含不同长度序列的批次）。
• truncation (bool, str 或 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 或 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 类型 IDs？

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

  什么是 attention masks？

• 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 掩码信息。
• return_offsets_mapping (bool, optional, defaults to False) — 是否为每个 token 返回 (char_start, char_end)。

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

• verbose (bool, optional, defaults to True) — Whether or not to print more information and warnings.
• **kwargs — passed to the self.tokenize() method

A BatchEncoding with the following fields

• input_ids — List of token ids to be fed to a model.

  What are input IDs?

• token_type_ids — List of token type ids to be fed to a model (when return_token_type_ids=True or if “token_type_ids” is in self.model_input_names).

  What are token type IDs?

• attention_mask — List of indices specifying which tokens should be attended to by the model (when return_attention_mask=True or if “attention_mask” is in self.model_input_names).

  What are attention masks?

• overflowing_tokens — List of overflowing tokens sequences (when a max_length is specified and return_overflowing_tokens=True).

• num_truncated_tokens — Number of tokens truncated (when a max_length is specified and return_overflowing_tokens=True).

• special_tokens_mask — List of 0s and 1s, with 1 specifying added special tokens and 0 specifying regular sequence tokens (when add_special_tokens=True and return_special_tokens_mask=True).

• length — The length of the inputs (when return_length=True)

参数

• sequences (Union[List[int], List[List[int]], np.ndarray, torch.Tensor, tf.Tensor]) — 分词后的输入 id 列表。 可以使用 __call__ 方法获得。
• skip_special_tokens (bool, optional, defaults to False) — 是否在解码时移除特殊 token，默认为 False。
• clean_up_tokenization_spaces (bool, optional) — 是否清理分词空格。
• output_char_offsets (bool, optional, defaults to False) — 是否输出字符偏移量。 字符偏移量可以与采样率和模型下采样率结合使用，以计算转录字符的时间戳。

  请查看 ~models.wav2vec2.tokenization_wav2vec2.decode 的示例，以更好地理解如何使用 output_word_offsets。 ~model.wav2vec2_phoneme.tokenization_wav2vec2_phoneme.batch_decode 的工作原理与音素和批量输出类似。

• kwargs (额外关键字参数, optional) — 将会传递给底层模型特定的解码方法。

解码后的句子。当 output_char_offsets == True 时，将为 ~models.wav2vec2.tokenization_wav2vec2_phoneme.Wav2Vec2PhonemeCTCTokenizerOutput。

参数

• token_ids (Union[int, List[int], np.ndarray, torch.Tensor, tf.Tensor]) — 分词后的输入 id 列表。 可以使用 __call__ 方法获得。
• skip_special_tokens (bool, optional, defaults to False) — 是否在解码时移除特殊 token，默认为 False。
• clean_up_tokenization_spaces (bool, optional) — 是否清理分词空格。
• output_char_offsets (bool, optional, defaults to False) — 是否输出字符偏移量。 字符偏移量可以与采样率和模型下采样率结合使用，以计算转录字符的时间戳。

  请查看 ~models.wav2vec2.tokenization_wav2vec2.decode 的示例，以更好地理解如何使用 output_word_offsets。 ~model.wav2vec2_phoneme.tokenization_wav2vec2_phoneme.batch_decode 对于音素和批量输出的工作方式相同。

• kwargs (额外关键字参数, optional) — 将会传递给底层模型特定的解码方法。

解码后的句子。当 output_char_offsets == True 时，将为 ~models.wav2vec2.tokenization_wav2vec2_phoneme.Wav2Vec2PhonemeCTCTokenizerOutput。