参数

• 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 Core 的使用尤其有用。
• padding_side (str, optional) — 模型应在其上应用填充的一侧。应在 [‘right’, ‘left’] 之间选择。默认值从同名的类属性中选取。
• return_tensors (str or TensorType, optional) — 如果设置，将返回张量 (tensors) 而不是 Python 整数列表。可接受的值为：
  • 'tf'：返回 TensorFlow tf.constant 对象。
  • 'pt'：返回 PyTorch torch.Tensor 对象。
  • 'np'：返回 Numpy np.ndarray 对象。
• return_token_type_ids (bool, optional) — 是否返回词符类型 ID (token type IDs)。如果保留为默认值，将根据特定分词器的默认值（由 return_outputs 属性定义）返回词符类型 ID。

  什么是词符类型 ID？

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

  这仅在继承自 PreTrainedTokenizerFast 的 fast tokenizers 上可用，如果使用 Python 的 tokenizer，此方法将引发 NotImplementedError。

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

一个 BatchEncoding，包含以下字段

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

  什么是输入 IDs？

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

  什么是 token type 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 时)

参数

• token_ids (Union[int, List[int], np.ndarray, torch.Tensor, tf.Tensor]) — tokenized 输入 id 列表。可以使用 __call__ 方法获得。
• skip_special_tokens (bool, optional, defaults to False) — 是否在解码中移除特殊 token。
• clean_up_tokenization_spaces (bool, optional) — 是否清理 tokenization 空格。如果为 None，将默认为 self.clean_up_tokenization_spaces。
• kwargs (附加关键字参数, optional) — 将传递给底层模型特定的 decode 方法。

解码后的句子。

参数

• sequences (Union[List[int], List[List[int]], np.ndarray, torch.Tensor, tf.Tensor]) — tokenized 输入 id 列表。可以使用 __call__ 方法获得。
• skip_special_tokens (bool, optional, defaults to False) — 是否在解码中移除特殊 token。
• clean_up_tokenization_spaces (bool, optional) — 是否清理 tokenization 空格。如果为 None，将默认为 self.clean_up_tokenization_spaces。
• kwargs (附加关键字参数, optional) — 将传递给底层模型特定的 decode 方法。

解码后的句子列表。

参数

• 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 数组列表或浮点值列表的列表。这将输出对数梅尔频谱图特征。
• padding (bool, str 或 PaddingStrategy, 可选, 默认为 False) — 选择一种策略来填充返回的序列（根据模型的填充侧和填充索引）：
  • True 或 'longest'：填充到批次中最长的序列（如果仅提供单个序列，则不填充）。
  • 'max_length'：填充到由参数 max_length 指定的最大长度，如果未提供该参数，则填充到模型可接受的最大输入长度。
  • False 或 'do_not_pad' (默认)：不填充（即，可以输出具有不同长度序列的批次）。
• max_length (int, 可选) — 返回列表的最大长度，以及可选的填充长度（见上文）。
• truncation (bool) — 激活截断以将输入序列裁剪为不超过 max_length 的长度。
• pad_to_multiple_of (int, 可选) — 如果设置，则将序列填充为提供值的倍数。

  这对于在计算能力 >= 7.5 (Volta) 的 NVIDIA 硬件上或在受益于序列长度为 128 的倍数的 TPU 上启用 Tensor Cores 的使用尤其有用。

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

  什么是注意力掩码？

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

参数

• pretrained_model_name_or_path (str 或 os.PathLike) — 可以是以下之一：
  • 一个字符串，huggingface.co 上模型仓库中托管的预训练 feature_extractor 的模型 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 文件和 tokenizer 文件的目录（如果目录不存在，则将创建目录）。
• push_to_hub (bool, 可选, 默认为 False) — 是否在保存模型后将其推送到 Hugging Face 模型 Hub。 您可以使用 repo_id 指定要推送到的仓库（默认为您命名空间中 save_directory 的名称）。
• kwargs (Dict[str, Any], 可选) — 传递给 push_to_hub() 方法的额外关键字参数。

参数

• attention_mask (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 用于避免在 padding token 索引上执行卷积和注意力的 Mask。 Mask 值在 [0, 1] 中选择：
  • 1 表示 tokens 未被 mask，
  • 0 表示 tokens 已被 mask。

  什么是 attention masks？

  仅当相应的 processor 具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有 processor 具有 config.return_attention_mask == False 的模型，不应传递 attention_mask，以避免在执行批量推理时性能下降。 对于此类模型，input_values 应简单地用 0 填充，并在不使用 attention_mask 的情况下传递。 请注意，这些模型也会产生略有不同的结果，具体取决于 input_values 是否已填充。

• decoder_attention_mask (形状为 (batch_size, target_sequence_length) 的 torch.LongTensor, 可选) — 默认行为：生成一个忽略 decoder_input_values 中 pad tokens 的张量。 默认情况下，还将使用因果 mask。

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

• head_mask (形状为 (encoder_layers, encoder_attention_heads) 的 torch.FloatTensor, 可选) — 用于 nullify 编码器中注意力模块的选定头的 Mask。 Mask 值在 [0, 1] 中选择：
  • 1 表示 head 未被 mask，
  • 0 表示 head 已被 mask。
• decoder_head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.FloatTensor, 可选) — 用于 nullify 解码器中注意力模块的选定头的 Mask。 Mask 值在 [0, 1] 中选择：
  • 1 表示 head 未被 mask，
  • 0 表示 head 已被 mask。
• cross_attn_head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor, 可选) — 用于 nullify 交叉注意力模块的选定头的 Mask。 Mask 值在 [0, 1] 中选择：
  • 1 表示 head 未被 mask，
  • 0 表示 head 已被 mask。
• encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — 由 (形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state, 可选: hidden_states, 可选: attentions) 组成的元组。 last_hidden_state，可选) 是编码器最后一层输出的隐藏状态序列。在解码器的交叉注意力机制中使用。
• past_key_values (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

  如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_values （那些没有提供给此模型的过去键值状态的输入值），其形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_values。decoder_inputs_embeds (torch.FloatTensor，形状为 (batch_size, target_sequence_length, hidden_size)，可选): 可选地，您可以选择直接传递嵌入表示，而不是传递 decoder_input_values。 如果使用 past_key_values，则可以选择仅输入最后的 decoder_inputs_embeds （请参阅 past_key_values）。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 decoder_input_values 索引转换为关联向量，这将非常有用。

• use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
• input_values (torch.Tensor，形状为 (batch_size, sequence_length)) — 根据所使用的编码器，input_values 可以是：输入原始语音波形的浮点值，或者词汇表中输入序列 token 的索引，或者隐藏状态。
• decoder_input_values (torch.Tensor，形状为 (batch_size, target_sequence_length), 可选) — 根据所使用的解码器，decoder_input_values 可以是：从原始语音波形中提取的 log-mel 滤波器组特征的浮点值，或者词汇表中解码器输入序列 token 的索引，或者隐藏状态。
• speaker_embeddings (torch.FloatTensor，形状为 (batch_size, config.speaker_embedding_dim), 可选) — 包含说话人嵌入的张量。

一个 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 (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

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

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

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

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

• cross_attentions (tuple(torch.FloatTensor), 可选，当传递 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), 可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

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

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

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

参数

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

  什么是注意力掩码？

  只有当相应的处理器具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有处理器具有 config.return_attention_mask == False 的模型，不应传递 attention_mask，以避免在执行批量推理时性能下降。 对于此类模型，input_values 应简单地用 0 填充，并在不使用 attention_mask 的情况下传递。 请注意，这些模型也会根据 input_values 是否填充而产生略有不同的结果。

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

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

• head_mask (torch.FloatTensor，形状为 (encoder_layers, encoder_attention_heads), 可选) — 用于 nullify 编码器中注意力模块的选定头的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示头 未被掩盖，
  • 0 表示头 被掩盖。
• decoder_head_mask (torch.FloatTensor，形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于 nullify 解码器中注意力模块的选定头的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示头 未被掩盖，
  • 0 表示头 被掩盖。
• cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads), 可选) — 用于 nullify 交叉注意力模块的选定头的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示头 未被掩盖，
  • 0 表示头 被掩盖。
• encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组，包含 (last_hidden_state, optional: hidden_states, optional: attentions) 形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state，可选) 是编码器最后一层的输出隐藏状态序列。用于解码器的交叉注意力机制中。
• past_key_values (tuple(tuple(torch.FloatTensor)), optional, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，以及 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

  如果使用 past_key_values，用户可以选择仅输入最后的 decoder_input_values （那些没有将其过去的键值状态提供给此模型的），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_values。 decoder_inputs_embeds (torch.FloatTensor，形状为 (batch_size, target_sequence_length, hidden_size)，可选): 可选地，您可以选择直接传递嵌入表示，而不是传递 decoder_input_values。 如果使用 past_key_values，则可以选择仅输入最后的 decoder_inputs_embeds (参见 past_key_values)。 如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 decoder_input_values 索引转换为关联向量，这将非常有用。

• use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（参见 past_key_values）。
• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 更多详细信息请参阅返回张量下的 attentions。
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 更多详细信息请参阅返回张量下的 hidden_states。
• return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
• 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()。
• decoder_input_ids (torch.LongTensor，形状为 (batch_size, target_sequence_length)，可选) — 解码器输入序列标记在词汇表中的索引。

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

  什么是解码器输入 ID？

  SpeechT5 使用 eos_token_id 作为 decoder_input_ids 生成的起始标记。 如果使用 past_key_values，则可以选择仅输入最后的 decoder_input_ids (参见 past_key_values)。

• labels (torch.LongTensor，形状为 (batch_size, sequence_length)，optional) — 用于计算语言建模损失的标签。 索引应为 [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 (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。

• past_key_values (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

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

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

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

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

• cross_attentions (tuple(torch.FloatTensor), 可选，当传递 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), 可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

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

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

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

参数

• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，optional) — 用于避免对 padding 标记索引执行卷积和注意力的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示标记未被掩蔽，
  • 0 表示标记已被掩蔽。

  什么是注意力掩码？

  只有当相应的处理器具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有处理器具有 config.return_attention_mask == False 的模型，不应传递 attention_mask，以避免在进行批量推理时性能下降。 对于此类模型，input_values 应简单地用 0 填充并在没有 attention_mask 的情况下传递。 请注意，这些模型的结果也会因 input_values 是否填充而略有不同。

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

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

• head_mask (torch.FloatTensor，形状为 (encoder_layers, encoder_attention_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) 形状为 (batch_size, sequence_length, hidden_size) 的 last_hidden_state，可选) 是编码器最后一层的输出隐藏状态序列。用于解码器的交叉注意力机制中。
• past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

  如果使用 past_key_values，用户可以选择仅输入最后一个 decoder_input_values （那些没有将其过去键值状态提供给此模型的）形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_values。decoder_inputs_embeds (torch.FloatTensor，形状为 (batch_size, target_sequence_length, hidden_size), 可选): 可选地，您可以选择直接传递嵌入表示，而不是传递 decoder_input_values。 如果使用 past_key_values，可选地只需输入最后一个 decoder_inputs_embeds（参见 past_key_values）。 如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 decoder_input_values 索引转换为关联向量，这将非常有用。

• use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
• input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

  什么是输入 ID？

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

• 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()。

一个 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 (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

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

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

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

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

• cross_attentions (tuple(torch.FloatTensor), 可选，当传递 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), 可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

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

• encoder_attentions (tuple(torch.FloatTensor), 可选，当传递 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) — 解码器交叉注意力层的输出。

参数

• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免对填充 token 索引执行卷积和注意力机制。掩码值选自 [0, 1]：
  • 1 表示 token 未被掩码，
  • 0 表示 token 已被掩码。

  什么是注意力掩码？

  仅当对应的处理器具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有处理器具有 config.return_attention_mask == False 的模型，应不传递 attention_mask，以避免在执行批量推理时性能下降。 对于此类模型，input_values 应简单地用 0 填充，并在不使用 attention_mask 的情况下传递。 请注意，这些模型的结果也会因 input_values 是否填充而略有不同。

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

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

• head_mask (torch.FloatTensor，形状为 (encoder_layers, encoder_attention_heads)，可选) — 掩码，用于使编码器中注意力模块的选定 head 失效。掩码值选自 [0, 1]：
  • 1 表示 head 未被掩码，
  • 0 表示 head 已被掩码。
• decoder_head_mask (torch.FloatTensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使解码器中注意力模块的选定 head 失效。掩码值选自 [0, 1]：
  • 1 表示 head 未被掩码，
  • 0 表示 head 已被掩码。
• cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 掩码，用于使交叉注意力模块的选定 head 失效。掩码值选自 [0, 1]：
  • 1 表示 head 未被掩码，
  • 0 表示 head 已被掩码。
• 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 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，其中每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

  如果使用 past_key_values，则用户可以选择仅输入最后的 decoder_input_values（那些没有将其过去的键值状态提供给此模型的），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_values。 decoder_inputs_embeds（torch.FloatTensor，形状为 (batch_size, target_sequence_length, hidden_size)，可选）：或者，您可以选择直接传递嵌入表示，而不是传递 decoder_input_values。 如果使用 past_key_values，则可以选择仅输入最后的 decoder_inputs_embeds（请参阅 past_key_values）。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 decoder_input_values 索引转换为关联的向量，这将非常有用。

• use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
• 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()。
• decoder_input_values (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_mel_bins)) — 输入梅尔频谱图的浮点值。

  SpeechT5 使用全零频谱作为 decoder_input_values 生成的起始 token。 如果使用 past_key_values，则可以选择仅输入最后的 decoder_input_values（请参阅 past_key_values）。

• speaker_embeddings (torch.FloatTensor，形状为 (batch_size, config.speaker_embedding_dim)，可选) — 包含说话人嵌入的张量。
• labels (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_mel_bins)，可选) — 目标梅尔频谱图的浮点值。 可以使用 SpeechT5Processor 获得频谱图。 有关详细信息，请参见 SpeechT5Processor.call()。

一个 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 (tuple(tuple(torch.FloatTensor)), 可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，其中每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

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

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

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

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

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

• cross_attentions (tuple(torch.FloatTensor), 可选，当传递 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), 可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型具有嵌入层，则为嵌入输出一个，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

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

• encoder_attentions (tuple(torch.FloatTensor), 可选，当传递 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)，可选) — 掩码，用于避免对填充 token 索引执行卷积和注意力机制。掩码值选自 [0, 1]：
  • 1 表示 token 未被掩码，
  • 0 表示 token 已被掩码。

  什么是注意力掩码？

• threshold (float，可选，默认为 0.5) — 当预测的停止 token 概率超过此值时，生成的序列结束。
• minlenratio (float，可选，默认为 0.0) — 用于计算输出序列的最小所需长度。
• maxlenratio (float，可选，默认为 20.0) — 用于计算输出序列的最大允许长度。
• vocoder (nn.Module，可选，默认为 None) — 将梅尔频谱图转换为语音波形的声码器。 如果为 None，则输出为梅尔频谱图。
• output_cross_attentions (bool, optional, defaults to False) — 是否返回解码器交叉注意力层的注意力张量。
• return_output_lengths (bool, optional, defaults to 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) — 包含 log-mel 频谱图的张量。可以是批处理的，形状为 (batch_size, sequence_length, config.model_in_dim)，也可以是非批处理的，形状为 (sequence_length, config.model_in_dim)。

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