参数

• text (str, List[str], List[List[str]], 可选) — 要编码的序列或序列批次。 每个序列可以是字符串或字符串列表（预 token 化字符串）。 如果序列以字符串列表（预 token 化）形式提供，则必须设置 is_split_into_words=True （以消除与序列批次的歧义）。
• text_pair (str, List[str], List[List[str]], 可选) — 要编码的序列或序列批次。 每个序列可以是字符串或字符串列表（预 token 化字符串）。 如果序列以字符串列表（预 token 化）形式提供，则必须设置 is_split_into_words=True （以消除与序列批次的歧义）。
• text_target (str, List[str], List[List[str]], 可选) — 要编码为目标文本的序列或序列批次。 每个序列可以是字符串或字符串列表（预 token 化字符串）。 如果序列以字符串列表（预 token 化）形式提供，则必须设置 is_split_into_words=True （以消除与序列批次的歧义）。
• text_pair_target (str, List[str], List[List[str]], 可选) — 要编码为目标文本的序列或序列批次。 每个序列可以是字符串或字符串列表（预 token 化字符串）。 如果序列以字符串列表（预 token 化）形式提供，则必须设置 is_split_into_words=True （以消除与序列批次的歧义）。
• add_special_tokens (bool, 可选, 默认为 True) — 在编码序列时是否添加特殊 token。 这将使用底层的 PretrainedTokenizerBase.build_inputs_with_special_tokens 函数，该函数定义了哪些 token 会自动添加到输入 id 中。 如果您想自动添加 bos 或 eos 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 的数量。
• is_split_into_words (bool, 可选, 默认为 False) — 输入是否已预 token 化（例如，拆分为单词）。 如果设置为 True，则 tokenizer 假定输入已拆分为单词（例如，通过在空格上拆分），它将对其进行 token 化。 这对于 NER 或 token 分类很有用。
• pad_to_multiple_of (int, 可选) — 如果设置，将序列填充为提供值的倍数。 需要激活 padding。 这对于在计算能力 >= 7.5 (Volta) 的 NVIDIA 硬件上启用 Tensor Core 的使用尤其有用。
• padding_side (str, 可选) — 模型应在其上应用填充的一侧。 应在 [‘right’, ‘left’] 之间选择。 默认值是从同名的类属性中选择的。
• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回 tensor 而不是 python 整数列表。 可接受的值为：
  • 'tf'：返回 TensorFlow tf.constant 对象。
  • 'pt'：返回 PyTorch torch.Tensor 对象。
  • 'np'：返回 Numpy np.ndarray 对象。
• return_token_type_ids (bool, 可选) — 是否返回 token 类型 ID。 如果保留为默认值，将根据特定 tokenizer 的默认值返回 token 类型 ID，由 return_outputs 属性定义。

  什么是 token 类型 ID？

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

  什么是 attention mask？

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

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

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

一个 BatchEncoding，包含以下字段

• input_ids — 输入模型的 token id 列表。

  什么是输入 IDs？

• token_type_ids — 输入模型的 token 类型 id 列表 (当 return_token_type_ids=True 或如果 “token_type_ids” 在 self.model_input_names 中时)。

  什么是 token 类型 IDs？

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

  什么是 attention masks？

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

参数

• input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。 如果您提供 padding，默认情况下会被忽略。

  索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

  什么是输入 IDs？

• attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), 可选) — 用于避免对 padding token 索引执行卷积和 attention 的掩码。 掩码值在 [0, 1] 中选择:
  • 1 表示 未被掩盖 的 token，
  • 0 表示 被掩盖 的 token。

  什么是 attention masks？

• speaker_id (int, 可选) — 要使用的说话人嵌入。 仅用于多说话人模型。
• output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的 hidden state。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
• labels (torch.FloatTensor，形状为 (batch_size, config.spectrogram_bins, sequence_length), 可选) — 目标频谱图的浮点值。 设置为 -100.0 的时间步长在损失计算中会被忽略 (掩盖)。

一个 transformers.models.vits.modeling_vits.VitsModelOutput 或 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (VitsConfig) 和输入。

• waveform (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 模型预测的最终音频波形。

• sequence_lengths (torch.FloatTensor，形状为 (batch_size,)) — waveform 批次中每个元素的样本长度。

• spectrogram (torch.FloatTensor，形状为 (batch_size, sequence_length, num_bins)) — 在 flow 模型输出端预测的 log-mel 频谱图。 此频谱图被传递到 Hi-Fi GAN 解码器模型以获得最终音频波形。

• hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (如果模型具有嵌入层，则为嵌入输出，每个层的输出各一个)，形状为 (batch_size, sequence_length, hidden_size)。

  模型在每一层输出端的 Hidden state，加上可选的初始嵌入输出。

• attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组 (每层一个)，形状为 (batch_size, num_heads, sequence_length, sequence_length)。

  attention softmax 后的 Attention 权重，用于计算 self-attention 头中的加权平均值。