参数

• 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) — 在编码序列时是否添加特殊标记。这将使用底层的 PretrainedTokenizerBase.build_inputs_with_special_tokens 函数，该函数定义了哪些标记会自动添加到输入 ID 中。如果您想自动添加 bos 或 eos 标记，这会很有用。
• 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 参数指定的最大长度，如果未提供该参数，则截断到模型可接受的最大输入长度。这将逐个标记地截断，如果提供了一对序列（或一批序列对），则从最长的序列中移除一个标记。
  • '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 时返回的溢出标记将包含一些来自截断序列末尾的标记，以在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。
• is_split_into_words (bool, optional, defaults to False) — 输入是否已经预分词（例如，拆分成单词）。如果设置为 True，分词器会假定输入已经拆分成单词（例如，通过在空白处拆分），它将对这些单词进行分词。这对于 NER 或标记分类很有用。
• pad_to_multiple_of (int, optional) — 如果设置，将把序列填充到所提供值的倍数。需要激活 padding。这对于在计算能力 >= 7.5（Volta）的 NVIDIA 硬件上启用 Tensor Cores 特别有用。
• 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) — 是否返回溢出的词元序列。如果提供了一对输入 ID 序列（或一批序列对）并设置 `truncation_strategy = longest_first` 或 `True`，则会引发错误而不是返回溢出的词元。
• return_special_tokens_mask (bool, 可选, 默认为 False) — 是否返回特殊词元掩码信息。
• return_offsets_mapping (bool, 可选, 默认为 False) — 是否为每个词元返回 `(char_start, char_end)`。

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

• return_length (bool, 可选, 默认为 False) — 是否返回编码后输入的长度。
• verbose (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 中时）。

  什么是注意力掩码？

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

参数

• token_ids (Union[int, list[int], np.ndarray, torch.Tensor, tf.Tensor]) — 分词后的输入 ID 列表。可以使用 `__call__` 方法获得。
• skip_special_tokens (bool, 可选, 默认为 False) — 是否在解码时移除特殊词元。
• clean_up_tokenization_spaces (bool, 可选) — 是否清理分词产生的空格。如果为 `None`，将默认为 `self.clean_up_tokenization_spaces`。
• kwargs (附加关键字参数, 可选) — 将传递给底层特定于模型的解码方法。

解码后的句子。

参数

• sequences (Union[list[int], list[list[int]], np.ndarray, torch.Tensor, tf.Tensor]) — 分词后的输入 ID 列表。可以使用 `__call__` 方法获得。
• skip_special_tokens (bool, 可选, 默认为 False) — 是否在解码时移除特殊词元。
• clean_up_tokenization_spaces (bool, 可选) — 是否清理分词产生的空格。如果为 `None`，将默认为 `self.clean_up_tokenization_spaces`。
• kwargs (附加关键字参数, 可选) — 将传递给底层特定于模型的解码方法。

解码后的句子列表。

参数

• audio (np.ndarray, list[float], list[np.ndarray], list[list[float]], 可选) — 要处理的序列或序列批次。每个序列可以是一个 numpy 数组、一个浮点值列表、一个 numpy 数组列表或一个浮点值列表的列表。此参数输出波形特征。必须是单声道音频，而不是立体声，即每个时间步长对应单个浮点数。
• audio_target (np.ndarray, list[float], list[np.ndarray], list[list[float]], 可选) — 要作为目标处理的序列或序列批次。每个序列可以是一个 numpy 数组、一个浮点值列表、一个 numpy 数组列表或一个浮点值列表的列表。此参数输出 log-mel 语谱图特征。
• padding (bool, str 或 PaddingStrategy, 可选, 默认为 False) — 选择一种策略对返回的序列进行填充（根据模型的填充侧和填充索引）：
  • True 或 'longest'：填充到批次中最长序列的长度（如果只提供单个序列则不填充）。
  • 'max_length'：填充到由 `max_length` 参数指定的最大长度，如果未提供该参数，则填充到模型可接受的最大输入长度。
  • False 或 'do_not_pad' (默认)：不进行填充（即，可以输出具有不同长度序列的批次）。
• max_length (int, 可选) — 返回列表的最大长度，以及可选的填充长度（见上文）。
• truncation (bool) — 激活截断功能，将长于 *max_length* 的输入序列截断至 *max_length*。
• pad_to_multiple_of (int, 可选) — 如果设置，将序列填充到所提供值的倍数。

  这对于在计算能力 `>= 7.5`（Volta）的 NVIDIA 硬件上启用 Tensor Cores，或在 TPUs 上使用特别有用，因为这些硬件受益于序列长度是 128 的倍数。

• return_attention_mask (bool, 可选) — 是否返回注意力掩码。如果保留默认值，将根据特定特征提取器的默认设置返回注意力掩码。

  什么是注意力掩码？

• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回张量而不是 Python 整数列表。可接受的值为：
  • 'tf'：返回 TensorFlow tf.constant 对象。
  • 'pt'：返回 PyTorch torch.Tensor 对象。
  • 'np'：返回 Numpy np.ndarray 对象。
• sampling_rate (int, 可选) — `audio` 或 `audio_target` 输入的采样率。强烈建议在调用 forward 时传递 `sampling_rate`，以防止静默错误。

参数

• pretrained_model_name_or_path (str 或 os.PathLike) — 这可以是以下之一：
  • 一个字符串，即托管在 huggingface.co 上的模型仓库中预训练特征提取器的 模型 ID。
  • 一个包含使用 save_pretrained() 方法保存的特征提取器文件的 目录 路径，例如 ./my_model_directory/。
  • 一个已保存的特征提取器 JSON 文件 的路径或 URL，例如 ./my_model_directory/preprocessor_config.json。
• **kwargs — 传递给 from_pretrained() 和 ~tokenization_utils_base.PreTrainedTokenizer.from_pretrained 的其他关键字参数。

参数

• save_directory (str 或 os.PathLike) — 将要保存特征提取器 JSON 文件和分词器文件的目录（如果目录不存在则会创建）。
• push_to_hub (bool, optional, 默认为 False) — 是否在保存模型后将其推送到 Hugging Face 模型中心。你可以使用 repo_id 指定要推送到的仓库（默认为你命名空间中 save_directory 的名称）。
• kwargs (dict[str, Any], optional) — 传递给 push_to_hub() 方法的其他关键字参数。

参数

• input_values (torch.Tensor，形状为 (batch_size, sequence_length)) — 根据使用的编码器，input_values 可以是：输入原始语音波形的浮点数值，或者词汇表中输入序列令牌的索引，或者隐藏状态。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length), optional) — 用于避免对填充令牌索引执行注意力操作的掩码。掩码值选自 [0, 1]：
  • 1 表示令牌未被掩码，
  • 0 表示令牌被掩码。

  什么是注意力掩码？

• decoder_input_values (torch.Tensor，形状为 (batch_size, target_sequence_length), optional) — 根据使用的解码器，decoder_input_values 可以是：从原始语音波形中提取的 log-mel 滤波器组特征的浮点数值，或者词汇表中解码器输入序列令牌的索引，或者隐藏状态。
• decoder_attention_mask (torch.LongTensor，形状为 (batch_size, target_sequence_length), optional) — 默认行为：生成一个忽略 decoder_input_values 中填充令牌的张量。默认情况下也会使用因果掩码。

  如果你想改变填充行为，你应该阅读 SpeechT5Decoder._prepare_decoder_attention_mask 并根据你的需求进行修改。有关默认策略的更多信息，请参阅论文中的图 1。

• head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads), optional) — 用于置零自注意力模块中选定头部的掩码。掩码值选自 [0, 1]：
  • 1 表示头部未被掩码，
  • 0 表示头部被掩码。
• decoder_head_mask (torch.FloatTensor，形状为 (decoder_layers, decoder_attention_heads), optional) — 用于置零解码器中注意力模块选定头部的掩码。掩码值选自 [0, 1]：
  • 1 表示头部未被掩码，
  • 0 表示头部被掩码。
• cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads), optional) — 用于置零交叉注意力模块中选定头部的掩码。掩码值选自 [0, 1]：
  • 1 表示头部未被掩码，
  • 0 表示头部被掩码。
• encoder_outputs (tuple[tuple[torch.FloatTensor]], optional) — 元组包含（last_hidden_state, optional: hidden_states, optional: attentions）last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size)，optional）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。
• past_key_values (tuple[tuple[torch.FloatTensor]], optional) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在解码的先前阶段，当 use_cache=True 或 config.use_cache=True 时由模型返回的 past_key_values。

  允许两种格式：

  • 一个 Cache 实例，请参阅我们的 kv 缓存指南；
  • 一个长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，其中每个元组有两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为传统缓存格式。

  模型将输出与输入相同的缓存格式。如果没有传递 past_key_values，则将返回传统缓存格式。

  如果使用 past_key_values，用户可以选择只输入最后一个 input_ids（那些没有为其提供过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

• use_cache (bool, optional) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
• speaker_embeddings (torch.FloatTensor，形状为 (batch_size, config.speaker_embedding_dim), optional) — 包含说话人嵌入的张量。
• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。

一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False），包含根据配置（SpeechT5Config）和输入而变化的不同元素。

• last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)) — 模型解码器最后一层输出的隐藏状态序列。

  如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

• past_key_values (EncoderDecoderCache, optional, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

• decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  解码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

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

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

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

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

• encoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  编码器在每个层输出的隐藏状态，加上可选的初始嵌入输出。

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

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 或 numpy.ndarray 类型的数组中来获取这些值，例如，通过 soundfile 库（pip install soundfile）。要将数组准备成 input_values，应使用 SpeechT5Processor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 SpeechT5Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length), optional) — 用于避免对填充令牌索引执行注意力操作的掩码。掩码值选自 [0, 1]：
  • 1 表示令牌未被掩码，
  • 0 表示令牌被掩码。

  什么是注意力掩码？

• decoder_input_ids (torch.LongTensor，形状为 (batch_size, target_sequence_length), optional) — 词汇表中解码器输入序列令牌的索引。

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

  什么是解码器输入 ID？

  SpeechT5 使用 eos_token_id 作为生成 decoder_input_ids 的起始令牌。如果使用 past_key_values，可以选择只输入最后一个 decoder_input_ids（请参阅 past_key_values）。

• decoder_attention_mask (torch.LongTensor，形状为 (batch_size, target_sequence_length), optional) — 默认行为：生成一个忽略 decoder_input_values 中填充令牌的张量。默认情况下也会使用因果掩码。

  如果你想改变填充行为，你应该阅读 SpeechT5Decoder._prepare_decoder_attention_mask 并根据你的需求进行修改。有关默认策略的更多信息，请参阅论文中的图 1。

• head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值选自 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• decoder_head_mask (torch.FloatTensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使解码器中注意力模块选定的头无效的掩码。掩码值选自 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使交叉注意力模块中选定的头无效的掩码。掩码值选自 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• encoder_outputs (tuple[tuple[torch.FloatTensor]]，可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state（形状为 (batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。
• past_key_values (tuple[tuple[torch.FloatTensor]]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的先前阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

  允许两种格式：

  • Cache 实例，请参阅我们的 kv cache 指南；
  • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）。这也称为传统缓存格式。

  模型将输出与输入相同的缓存格式。如果未传递 past_key_values，则将返回传统缓存格式。

  如果使用 past_key_values，用户可以选择只输入形状为 (batch_size, 1) 的最后 input_ids（那些没有将其过去键值状态提供给此模型的 ID），而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

• use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
• labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 之间（参见 input_ids 文档）。索引设置为 -100 的词元将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 范围内的词元计算。

  可以使用 SpeechT5Tokenizer 获取标签索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

一个 transformers.modeling_outputs.Seq2SeqLMOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），根据配置 (SpeechT5Config) 和输入包含各种元素。

• loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失。

• logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。

• past_key_values (EncoderDecoderCache, optional, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

• decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  解码器在每一层输出时的隐藏状态以及初始嵌入输出。

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

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

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

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

• encoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  编码器在每一层输出时的隐藏状态以及初始嵌入输出。

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

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

参数

• input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列词元的索引。

  可以使用 SpeechT5Tokenizer 获取索引。有关详细信息，请参见 encode() 和 call()。

  什么是输入 ID？

• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 避免对填充词元索引执行注意力的掩码。掩码值选自 [0, 1]：
  • 1 表示词元未被掩码，
  • 0 表示词元被掩码。

  什么是注意力掩码？

• decoder_input_values (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_mel_bins)) — 输入梅尔频谱图的浮点值。

  SpeechT5 使用全零频谱作为生成 decoder_input_values 的起始标记。如果使用 past_key_values，可以选择只输入最后的 decoder_input_values（参见 past_key_values）。

• decoder_attention_mask (torch.LongTensor，形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略 decoder_input_values 中填充标记的张量。默认情况下也会使用因果掩码。

  如果要更改填充行为，应阅读 SpeechT5Decoder._prepare_decoder_attention_mask 并根据需要进行修改。有关默认策略的更多信息，请参阅论文中的图 1。

• head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值选自 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• decoder_head_mask (torch.FloatTensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使解码器中注意力模块选定的头无效的掩码。掩码值选自 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于使交叉注意力模块中选定的头无效的掩码。掩码值选自 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• encoder_outputs (tuple[tuple[torch.FloatTensor]]，可选) — 元组包含 (last_hidden_state, 可选: hidden_states, 可选: attentions) last_hidden_state（形状为 (batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。
• past_key_values (tuple[tuple[torch.FloatTensor]]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的先前阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

  允许两种格式：

  • Cache 实例，请参阅我们的 kv cache 指南；
  • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）。这也称为传统缓存格式。

  模型将输出与输入相同的缓存格式。如果未传递 past_key_values，则将返回传统缓存格式。

  如果使用 past_key_values，用户可以选择只输入形状为 (batch_size, 1) 的最后 input_ids（那些没有将其过去键值状态提供给此模型的 ID），而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

• use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
• speaker_embeddings (torch.FloatTensor，形状为 (batch_size, config.speaker_embedding_dim)，可选) — 包含说话人嵌入的张量。
• labels (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_mel_bins)，可选) — 目标梅尔频谱图的浮点值。设置为 -100.0 的时间步在损失计算中被忽略（掩码）。可以使用 SpeechT5Processor 获取频谱图。有关详细信息，请参见 SpeechT5Processor.call()。
• stop_labels (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 指示序列中停止标记位置的二进制张量。

一个 transformers.modeling_outputs.Seq2SeqSpectrogramOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），根据配置 (SpeechT5Config) 和输入包含各种元素。

• loss (torch.FloatTensor，形状为 (1,)，可选，在提供 labels 时返回) — 频谱图生成损失。

• spectrogram (torch.FloatTensor，形状为 (batch_size, sequence_length, num_bins)) — 预测的频谱图。

• past_key_values (EncoderDecoderCache, optional, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

• decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  解码器在每一层输出时的隐藏状态以及初始嵌入输出。

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

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

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

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

• encoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  编码器在每一层输出时的隐藏状态以及初始嵌入输出。

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

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

参数

• input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列词元的索引。

  可以使用 SpeechT5Tokenizer 获取索引。有关详细信息，请参见 encode() 和 call()。

  什么是输入 ID？

• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)) — 来自 tokenizer 的注意力掩码，在批处理推理中需要，用于向模型指示在 input_ids 中忽略填充词元的位置。
• speaker_embeddings (torch.FloatTensor，形状为 (batch_size, config.speaker_embedding_dim)，可选) — 包含说话人嵌入的张量。
• threshold (float，可选，默认为 0.5) — 当预测的停止标记概率超过此值时，生成的序列结束。
• minlenratio (float，可选，默认为 0.0) — 用于计算输出序列的最小所需长度。
• maxlenratio (float，可选，默认为 20.0) — 用于计算输出序列的最大允许长度。
• vocoder (nn.Module，可选) — 将梅尔频谱图转换为语音波形的声码器。如果为 None，则输出为梅尔频谱图。
• output_cross_attentions (bool，可选，默认为 False) — 是否返回解码器交叉注意力层的注意力张量。
• return_output_lengths (bool，可选，默认为 False) — 是否返回具体的频谱图/波形长度。

• 当 `return_output_lengths` 为 False 时
  • spectrogram (可选，当未提供 `vocoder` 时返回) torch.FloatTensor，形状为 (output_sequence_length, config.num_mel_bins) — 预测的对数梅尔频谱图。
  • waveform (可选，当提供 `vocoder` 时返回) torch.FloatTensor，形状为 (num_frames,) — 预测的语音波形。
  • cross_attentions (可选，当 `output_cross_attentions` 为 `True` 时返回) torch.FloatTensor，形状为 (config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) — 解码器交叉注意力层的输出。
• 当 `return_output_lengths` 为 True 时
  • spectrograms (可选，当未提供 `vocoder` 时返回) torch.FloatTensor，形状为 (batch_size, output_sequence_length, config.num_mel_bins) — 预测的对数梅尔频谱图，已填充到最大长度。
  • spectrogram_lengths (可选，当未提供 `vocoder` 时返回) list[Int] — 每个频谱图的具体长度列表。
  • waveforms (可选，当提供 `vocoder` 时返回) torch.FloatTensor，形状为 (batch_size, num_frames) — 预测的语音波形，已填充到最大长度。
  • waveform_lengths (可选，当提供 `vocoder` 时返回) list[Int] — 每个波形的具体长度列表。
  • cross_attentions (可选，当 `output_cross_attentions` 为 `True` 时返回) torch.FloatTensor，形状为 (batch_size, config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) — 解码器交叉注意力层的输出。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 或 numpy.ndarray 类型的数组中获得值，例如，通过 soundfile 库（pip install soundfile）。要将数组准备为 input_values，应使用 SpeechT5Processor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参见 SpeechT5Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 避免对填充词元索引执行注意力的掩码。掩码值选自 [0, 1]：
  • 1 表示词元未被掩码，
  • 0 表示词元被掩码。

  什么是注意力掩码？

• decoder_input_values (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_mel_bins)) — 输入梅尔频谱图的浮点值。

  SpeechT5 使用全零频谱作为生成 decoder_input_values 的起始标记。如果使用 past_key_values，可以选择只输入最后的 decoder_input_values（参见 past_key_values）。

• decoder_attention_mask (torch.LongTensor，形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略 decoder_input_values 中填充标记的张量。默认情况下也会使用因果掩码。

  如果要更改填充行为，应阅读 SpeechT5Decoder._prepare_decoder_attention_mask 并根据需要进行修改。有关默认策略的更多信息，请参阅论文中的图 1。

• head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于将自注意力模块中选定的头置为零的掩码。掩码值的取值范围为 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• decoder_head_mask (torch.FloatTensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于将解码器中注意力模块选定的头置为零的掩码。掩码值的取值范围为 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于将交叉注意力模块中选定的头置为零的掩码。掩码值的取值范围为 [0, 1]：
  • 1 表示头未被掩码，
  • 0 表示头被掩码。
• encoder_outputs (tuple[tuple[torch.FloatTensor]]，可选) — 元组包含 (last_hidden_state，可选：hidden_states，可选：attentions) last_hidden_state 的形状为 (batch_size, sequence_length, hidden_size)，可选）是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力机制。
• past_key_values (tuple[tuple[torch.FloatTensor]]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括在解码的先前阶段，当 use_cache=True 或 config.use_cache=True 时由模型返回的 past_key_values。

  允许两种格式：

  • 一个 Cache 实例，请参阅我们的 kv 缓存指南；
  • 一个长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组包含2个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量）。这也被称为旧版缓存格式。

  模型将输出与输入相同的缓存格式。如果未传递 past_key_values，则将返回旧版缓存格式。

  如果使用 past_key_values，用户可以选择只输入最后一个 input_ids（那些没有为其提供过去键值状态的 ID）而不是所有 input_ids，其形状为 (batch_size, 1)，而不是 (batch_size, sequence_length)。

• use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
• speaker_embeddings (torch.FloatTensor，形状为 (batch_size, config.speaker_embedding_dim)，可选) — 包含说话人嵌入的张量。
• labels (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_mel_bins)，可选) — 目标梅尔频谱图的浮点数值。频谱图可以使用 SpeechT5Processor 获取。有关详细信息，请参阅 SpeechT5Processor.call()。
• stop_labels (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 二进制张量，指示序列中停止标记的位置。

一个 transformers.modeling_outputs.Seq2SeqSpectrogramOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），根据配置 (SpeechT5Config) 和输入包含各种元素。

• loss (torch.FloatTensor，形状为 (1,)，可选，在提供 labels 时返回) — 频谱图生成损失。

• spectrogram (torch.FloatTensor，形状为 (batch_size, sequence_length, num_bins)) — 预测的频谱图。

• past_key_values (EncoderDecoderCache, optional, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

  包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

• decoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  解码器在每一层输出时的隐藏状态以及初始嵌入输出。

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

  解码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

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

  解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。

• encoder_last_hidden_state (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出的隐藏状态序列。

• encoder_hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

  编码器在每一层输出时的隐藏状态以及初始嵌入输出。

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

  编码器的注意力权重，在注意力 softmax 之后，用于计算自注意力头中的加权平均。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点数值。

  可以通过将 .flac 或 .wav 音频文件加载到类型为 list[float] 或 numpy.ndarray 的数组中来获取值，例如，通过 soundfile 库（pip install soundfile）。要将数组准备成 input_values，应使用 SpeechT5Processor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 SpeechT5Processor.call()。

• speaker_embeddings (torch.FloatTensor，形状为 (batch_size, config.speaker_embedding_dim)，可选) — 包含说话人嵌入的张量。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 避免对填充标记索引执行卷积和注意力的掩码。掩码值的取值范围为 [0, 1]：
  • 1 表示标记未被掩码，
  • 0 表示标记被掩码。

  什么是注意力掩码？

• threshold (float，可选，默认为 0.5) — 当预测的停止标记概率超过此值时，生成的序列结束。
• minlenratio (float，可选，默认为 0.0) — 用于计算输出序列所需的最小长度。
• maxlenratio (float，可选，默认为 20.0) — 用于计算输出序列允许的最大长度。
• vocoder (nn.Module，可选，默认为 None) — 将梅尔频谱图转换为语音波形的声码器。如果为 None，则输出为梅尔频谱图。
• output_cross_attentions (bool，可选，默认为 False) — 是否返回解码器交叉注意力层的注意力张量。
• return_output_lengths (bool，可选，默认为 False) — 是否返回具体的频谱图/波形长度。

• 当 `return_output_lengths` 为 False 时
  • spectrogram (可选，当未提供 `vocoder` 时返回) torch.FloatTensor，形状为 (output_sequence_length, config.num_mel_bins) — 预测的对数梅尔频谱图。
  • waveform (可选，当提供 `vocoder` 时返回) torch.FloatTensor，形状为 (num_frames,) — 预测的语音波形。
  • cross_attentions (可选，当 `output_cross_attentions` 为 `True` 时返回) torch.FloatTensor，形状为 (config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) — 解码器交叉注意力层的输出。
• 当 `return_output_lengths` 为 True 时
  • spectrograms (可选，当未提供 `vocoder` 时返回) torch.FloatTensor，形状为 (batch_size, output_sequence_length, config.num_mel_bins) — 预测的对数梅尔频谱图，已填充到最大长度。
  • spectrogram_lengths (可选，当未提供 `vocoder` 时返回) list[Int] — 每个频谱图的具体长度列表。
  • waveforms (可选，当提供 `vocoder` 时返回) torch.FloatTensor，形状为 (batch_size, num_frames) — 预测的语音波形，已填充到最大长度。
  • waveform_lengths (可选，当提供 `vocoder` 时返回) list[Int] — 每个波形的具体长度列表。
  • cross_attentions (可选，当 `output_cross_attentions` 为 `True` 时返回) torch.FloatTensor，形状为 (batch_size, config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) — 解码器交叉注意力层的输出。

参数

• spectrogram (torch.FloatTensor) — 包含对数梅尔频谱图的张量。可以是批处理的，形状为 (batch_size, sequence_length, config.model_in_dim)，或者非批处理的，形状为 (sequence_length, config.model_in_dim)。

包含语音波形的张量。如果输入谱图是批处理的，则形状为 (batch_size, num_frames,)。如果未批处理，则形状为 (num_frames,)。