参数

• text (str, List[str], List[List[str]], 可选) — 待编码的序列或序列批次。每个序列可以是一个字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）的形式提供，必须设置 is_split_into_words=True（以避免与序列批次的歧义）。
• text_pair (str, List[str], List[List[str]], 可选) — 待编码的序列或序列批次。每个序列可以是一个字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）的形式提供，必须设置 is_split_into_words=True（以避免与序列批次的歧义）。
• text_target (str, List[str], List[List[str]], 可选) — 作为目标文本待编码的序列或序列批次。每个序列可以是一个字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）的形式提供，必须设置 is_split_into_words=True（以避免与序列批次的歧义）。
• text_pair_target (str, List[str], List[List[str]], 可选) — 需要编码成目标文本的序列或一批序列。每个序列可以是字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）的形式提供，则必须设置 is_split_into_words=True（以解决与一批序列的歧义）。
• add_special_tokens (bool, 可选，默认为 True) — 加密序列时是否添加特殊标记。这会使用底层函数 PretrainedTokenizerBase.build_inputs_with_special_tokens，它定义了哪些标记会自动添加到输入ID中。这很有用，如果您想自动添加 bos 或 eos 标记。
• padding (bool, str 或 PaddingStrategy, 可选，默认为 False) — 激活并控制填充。接受以下值：
  • True 或 'longest'：填充到批量中最长的序列（如果有提供的单个序列则不填充）。
  • 'max_length'：填充到使用参数 max_length 指定或模型可接受的最大输入长度。
  • False 或 'do_not_pad'（默认）：不填充（即，可以输出具有不同长度的序列的批量）。
• 截断 (bool, str 或 截断策略, 可选, 默认为 False) — 激活并控制截断。接受以下值:
  • True 或 'longest_first'：截断到通过 max_length 参数指定的最大长度，或如果没有提供该参数，则截断到模型可接受的最大输入长度。这将逐个截断短序列，删除较长的序列对中的段落。
  • '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时返回的溢出标记将包含截断序列的末尾的一些标记，以在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。
• is_split_into_words （bool，可选，默认为 False）— 输入是否已经预先标记（例如，分割成单词）。如果设置为True，标记器假定输入已按单词分割（例如，通过空格分割），它将进行标记。这在命名实体识别或标记分类中很有用。
• pad_to_multiple_of （int，可选）— 如果设置为数值，将对序列填充到提供的值的倍数。需要激活 padding 。这在启用具有计算能力 >= 7.5（Volta）的 NVIDIA 硬件上的 Tensor Cores 时特别有用。
• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回张量而不是 Python 整数列表。可接受值如下：
• return_token_type_ids (bool, 可选) — 是否返回 token 类型 ID。如果默认设置，将根据特定分词器的默认设置返回 token 类型 ID，该设置由 return_outputs 属性定义。
• return_attention_mask (bool, 可选) — 是否返回注意力掩码。如果默认设置，将根据特定分词器的默认设置返回注意力掩码，该设置由 return_outputs 属性定义。
• return_overflowing_tokens (bool, 可选，默认为 False) — 是否返回溢出的标记序列。如果提供了输入ids的对（或一对批次）且使用truncation_strategy = longest_first或True，则抛出错误而不是返回溢出标记。
• return_special_tokens_mask (bool, 可选，默认为 False) — 是否返回特殊标记掩码信息。
• return_offsets_mapping (bool, 可选，默认为 False) — 是否为每个标记返回 (char_start, char_end)。
• return_length (bool, optional, defaults to False) — Whether or not to return the lengths of the encoded inputs.
• 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.

  输入ID是什么？

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

  标记类型ID是什么？

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

  注意掩码是什么？

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

参数

• 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]) — 分词输入IDs的列表。可以使用__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]], optional) — 要处理的序列或序列批次作为目标。每个序列可以是 numpy 数组、浮点值列表、numpy 数组列表或浮点值列表的列表。此输出 log-mel 频谱图特征。
• padding (bool, str 或 PaddingStrategy, optional, defaults to False) — 选择填充返回序列的策略（根据模型的填充边和填充索引），包括以下内容之一：
  • True 或 'longest'：填充到批次中最长的序列（如果只提供单个序列，则不填充）。
  • 'max_length'：填充到通过参数 max_length 指定的最大长度或到模型可以接受的最大输入长度。
  • False 或 'do_not_pad'（默认）：不填充（即，可以输出长度不同的序列批次）。
• max_length (int, optional) — 返回列表的最大长度，以及可选的填充长度（参见上文）。
• 截断 (布尔值) — 激活截断功能，将长度超过 max_length 的输入序列截断至 max_length。
• pad_to_multiple_of (整数, 可选) — 如果设置，将序列填充至所提供值的倍数。

  这在启用使用 NVIDIA 硬件上 Tensor Cores，计算能力 >= 7.5 (Volta) 的 Tensor Cores，或在序列长度为 128 的倍数时特别有用，因为这有助于 TPUs 的性能。

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

  什么是注意力掩码？

• 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 or 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，可选，默认为 False) — 保存模型后是否将其推送到 Hugging Face 模型中心。您可以使用 repo_id 指定要推送到的存储库（默认为您的命名空间中 save_directory 的名称）。
• kwargs (Dict[str, Any], 可选) — 将额外关键字参数传递给 push_to_hub() 方法。

参数

• attention_mask (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免在填充token索引上执行卷积和注意力的掩码。掩码值在 [0, 1] 之间选择：
  • 为不掩码的token选择1，
  • 为掩码的token选择0。

  注意力掩码是什么？

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

• decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length), 可选) — 默认行为：生成一个 tensor，忽略 decoder_input_values 中的填充 token。默认还会使用因果掩码。

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

• head_mask (torch.FloatTensor 形状为 (encoder_layers, encoder_attention_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), 可选) — Tuple 组成 (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 时返回) — 一系列 tuple(torch.FloatTensor) 的长度为 config.n_layers，每个 tuple 包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，以及 2 个额外的形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的张量。
• use_cache（《布尔值》，《可选》）——如果设置为True，会返回past_key_values键值状态，并可用于加速解码（见past_key_values）。
• output_attentions（《布尔值》，《可选》）——是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回的张量下的attentions。
• output_hidden_states（《布尔值》，《可选》）——是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量下的hidden_states。
• return_dict (bool, 可选) —— 是否返回ModelOutput对象而不是一个普通的元组。
• input_values (torch.Tensor 形状为 (batch_size, sequence_length)) —— 根据使用的编码器不同，input_values 可以是：输入原始语音波形浮点值、词汇表中的输入序列标记索引或者隐藏状态。
• decoder_input_values (torch.Tensor 形状为 (batch_size, target_sequence_length), 可选) —— 根据使用的解码器不同，decoder_input_values 可以是：从原始语音波形中提取的 log-mel 滤波器组特征浮点值、解码器输入序列标记词汇表中的索引，或者隐藏状态。
• speaker_embeddings (torch.FloatTensor of shape (batch_size, config.speaker_embedding_dim), optional) — 包含说话人嵌入的 Tensor。

一个 transformers.modeling_outputs.Seq2SeqModelOutput 或一个包含多个元素的 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），这些元素取决于配置（SpeechT5Config）和输入。

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

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

• past_key_values (tuple(tuple(torch.FloatTensor)), optional, 返回当传递 use_cache=True 或当 config.use_cache=True 时) — 一个长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 Tensor 和 2 个额外的形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的 Tensor。

  包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见 past_key_values 输入）以加快连续解码。

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

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

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

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

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

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

• encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型编码器最后一层的隐藏状态序列。

• 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)，可选) — 避免在填充标记索引处执行卷积和注意力的掩码。在 [0, 1] 中选择掩码值：
  • 1 对于未被掩码的标记，
  • 0 对于被掩码的标记。

  什么是注意力掩码？

  attention_mask 应只在相应处理器有 config.return_attention_mask == True 时传递。对于所有处理器 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 中填充标记的张量。默认情况下还会使用因果关系掩码。
• head_mask （torch.FloatTensor 形状为 (encoder_layers, encoder_attention_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 时返回）— 一个长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，以及两个附加形状为 (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 (形状为 (batch_size, sequence_length) 的 torch.FloatTensor)- 输入原始语音波形数据的浮点值。这些值可以通过将 .flac 或 .wav 音频文件加载到一个类型为 List[float] 或 numpy.ndarray 的数组中，例如通过 soundfile 库（安装方法：pip install soundfile）获得。e.g. 准备数组为 input_values，应使用 SpeechT5Processor 进行填充和转换为类型为 torch.FloatTensor 的张量。有关详细信息，请参阅 SpeechT5Processor.call()。
• decoder_input_ids (形状为 (batch_size, target_sequence_length) 的 torch.LongTensor，可选) - 词汇表中解码器输入序列令牌的索引。

  可以使用 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 of shape (batch_size, sequence_length), 可选) — 用于计算语言模型损失的标签。索引可以是 [0, ..., config.vocab_size] 或 -100（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩码），损失仅对 [0, ..., config.vocab_size] 内有标签的标记进行计算。

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

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

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

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

• past_key_values (tuple(tuple(torch.FloatTensor)), optional, 返回当传递 use_cache=True 或当 config.use_cache=True 时) — 一个长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 Tensor 和 2 个额外的形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的 Tensor。

  包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见 past_key_values 输入）以加快连续解码。

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

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

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

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

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

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

• encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型编码器最后一层的隐藏状态序列。

• 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)，可选) — 用于避免在填充token的索引上执行卷积和注意力操作。mask值在[0, 1]中选择：
  • 1 对于非mask token，
  • 0 对于mask token。

  什么是注意力mask?

  attention_mask应仅在相应的处理器有config.return_attention_mask == True时传入。对于所有处理器有config.return_attention_mask == False的模型，不应传入attention_mask，以避免进行批量推理时性能下降。对于此类模型，应使用0填充而不使用attention_mask。请注意，这些模型也会根据是否填充而产生略微不同的结果。

• decoder_attention_mask (torch.LongTensor 的形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略decoder_input_values中填充token的tensor。默认情况下还会使用因果mask。
  SpeechT5Decoder._prepare_decoder_attention_mask并将其修改为您的需求。更多信息请参阅论文中的图1。

• head_mask （形状为(encoder_layers, encoder_attention_heads)的torch.FloatTensor，可选） — 取消编码器中注意力模块选定头部的掩码。掩码值选择在[0, 1]区间内：
  • 1表示头部未掩码，
  • 0表示头部已掩码。
• decoder_head_mask （形状为(decoder_layers, decoder_attention_heads)的torch.FloatTensor，可选） — 取消解码器中注意力模块选定头部的掩码。掩码值选择在[0, 1]区间内：
  • 1表示头部未掩码，
  • 0表示头部已掩码。
• cross_attn_head_mask （形状为(decoder_layers, decoder_attention_heads)的torch.Tensor，可选） — 取消交叉注意力模块选定头部的掩码。掩码值选择在[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时) — 长度为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)，而不是所有decoder_input_values的形状为(batch_size, sequence_length)。decoder_inputs_embeds (torch.FloatTensor of shape (batch_size, target_sequence_length, hidden_size), optional)：可选择性地，而不是传递decoder_input_values，可以直接传递嵌入表示。如果使用past_key_values，可选择性地只需输入最后一个decoder_inputs_embeds（见past_key_values）。这在您想要更多地控制如何将decoder_input_values索引转换为相关矢量，而不是模型内部的嵌入查找矩阵时很有用。

• use_cache (bool, 可选) — 如果设置为 True，将返回 past_key_values key value states 并可用于加速解码（参看 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参考返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参考返回张量下的 hidden_states。
• return_dict (bool，可选参数）—— 是否返回一个模型输出而非一个简单的元组。
• 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 of shape (batch_size, config.speaker_embedding_dim), 可选) — 包含说话者嵌入的 Tensor。
• labels (torch.FloatTensor of shape (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 of shape (1,), 可选, 当提供了 labels 时返回) — 频谱生成损失。

• spectrogram (torch.FloatTensor of shape (batch_size, sequence_length, num_bins)) — 预测的频谱图。

• past_key_values (tuple(tuple(torch.FloatTensor)), optional, 返回当传递 use_cache=True 或当 config.use_cache=True 时) — 一个长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 Tensor 和 2 个额外的形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的 Tensor。

  包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见 past_key_values 输入）以加快连续解码。

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

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

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

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

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

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

• encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型编码器最后一层的隐藏状态序列。

• 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 of shape (batch_size, sequence_length)) — 输入序列词汇中的标记索引。

  可以通过使用 SpeechT5Tokenizer 来获取索引。请参阅 encode() 和 call() 了解详细信息。

  什么是输入 ID？

• attention_mask (torch.LongTensor of shape (batch_size, sequence_length)) — 来自分词器的注意力掩码，在批处理推理中用于向模型指示忽略输入_ids中的填充token的位置。
• speaker_embeddings (torch.FloatTensor of shape (batch_size, config.speaker_embedding_dim), 可选) — 包含说话人嵌入的tensor。
• threshold (float, 可选, 默认为0.5) — 预测的停止token概率超过此值时，生成的序列结束。
• minlenratio (float, 可选, 默认为0.0) — 用于计算输出序列所需的最小长度。

• 当 return_output_lengths 为 False 时
  • 频谱图 （可选，当未提供 vocoder 时返回） —— 形状为 (output_sequence_length, config.num_mel_bins) 的 torch.FloatTensor —— 预测的 log-mel 频谱图。
  • 波形 （可选，当提供 vocoder 时返回） —— 形状为 (num_frames,) 的 torch.FloatTensor —— 预测的语音波形。
  • 交叉注意力 （可选，当 output_cross_attentions 为 True 时返回） —— 形状为 (config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) 的 torch.FloatTensor —— 解码器交叉注意力层的输出。
• 当 return_output_lengths 为 True
  • 频谱图 （可选，当未提供 vocoder 时返回） —— 形状为 (batch_size, output_sequence_length, config.num_mel_bins) 的 torch.FloatTensor —— 补充到最大长度的预测 log-mel 频谱图。
  • 频谱图长度 （可选，当未提供 vocoder 时返回） —— 形状为 List[Int] 的列表 —— 包含每个频谱图的特定长度。
  • 波形 （可选，当提供 vocoder 时返回） —— 形状为 (batch_size, num_frames) 的 torch.FloatTensor —— 补充到最大长度的预测语音波形。
  • 波形长度 （可选，当提供 vocoder 时返回） —— 形状为 List[Int] 的列表 —— 包含每个波形的特定长度。
  • 交叉注意力 （可选，当 output_cross_attentions 为 True 时返回） —— 形状为 (batch_size, config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) 的 torch.FloatTensor —— 解码器交叉注意力层的输出。

参数

• attention_mask （torch.LongTensor 的形状为 (batch_size, sequence_length)，可选）— 用于避免在填充标记索引上执行卷积和注意力操作的掩码。选定的掩码值为 [0, 1]：
  • 1 dla tokenów, które są nie maskowane，
  • 0 dla tokenów, które są maskowane。

  什么是注意力掩码？

  attention_mask powinno być przekazywane tylko w przypadku, gdy odpowiedni procesor ma config.return_attention_mask == True. W przypadku wszystkich modeli, dla których procesor ma config.return_attention_mask == False, attention_mask nie powinno być przekazywane, aby uniknąć pogorszenia wydajności podczas wykonywania tabel mixes inference. W takich modelach input_values powinni być po prostu wypełnione 0 i przekazywane bez attention_mask. Proszę zauważyć, że te modely dają nieco różne wyniki w zależności od tego, czy input_values są wypełnione, czy nie.

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

  Jeśli chcesz zmienić zachowanie wypełniania, powinieneś przeczytać SpeechT5Decoder._prepare_decoder_attention_mask i wprowadzić odpowiednie zmiany. Zobacz diagram 1 w artykule dla więcej informacji na temat domyślnej strategii.

• head_mask (torch.FloatTensor of shape (encoder_layers, encoder_attention_heads), optional) — 用于在编码器的注意力模块中屏蔽选择的头的掩码。掩码值选择在 [0, 1] 之间：
  • 1表示该头未被屏蔽，
  • 0表示该头被屏蔽。
• decoder_head_mask (torch.FloatTensor of shape (decoder_layers, decoder_attention_heads), optional) — 在解码器的注意力模块中屏蔽选择的头的掩码。掩码值选择在 [0, 1] 之间：
  • 1表示该头未被屏蔽，
  • 0表示该头被屏蔽。
• cross_attn_head_mask (torch.Tensor of shape (decoder_layers, decoder_attention_heads), optional) — 屏蔽交叉注意力模块选择的头的掩码。掩码值选择在 [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 时返回) — 长度为 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) 的额外张量。
• use_cache (bool, 可选) — 如果设置为 True，将返回 past_key_values 键值状态，并可用于加快解码速度（见 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有注意力的张量。有关更多详细资料，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细资料，请参阅返回张量下的 hidden_states。

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

• loss (torch.FloatTensor of shape (1,), 可选, 当提供了 labels 时返回) — 频谱生成损失。

• spectrogram (torch.FloatTensor of shape (batch_size, sequence_length, num_bins)) — 预测的频谱图。

• past_key_values (tuple(tuple(torch.FloatTensor)), optional, 返回当传递 use_cache=True 或当 config.use_cache=True 时) — 一个长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 Tensor 和 2 个额外的形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的 Tensor。

  包含预计算的隐藏状态（自我关注块和交叉关注块中的键和值），可用于（参见 past_key_values 输入）以加快连续解码。

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

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

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

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

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

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

• encoder_last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 模型编码器最后一层的隐藏状态序列。

• 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之后使用的注意力权重，用于计算自注意力头中的加权平均值。

参数

• speaker_embeddings（torch.FloatTensor，形状(batch_size, config.speaker_embedding_dim)，可选）— 包含说话人嵌入的Tensor。
• 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) — 将mel频谱图转换为语音波形的vocoder。如果为 None，输出为mel频谱图。
• output_cross_attentions (bool, 可选, 默认值 False) — 是否返回解码器交叉注意力层的注意力张量。
• return_output_lengths (bool, 可选, 默认为 False) — 是否返回具体的频谱图/波形长度。

• 当 return_output_lengths 为 False 时
  • 频谱图 （可选，当未提供 vocoder 时返回） —— 形状为 (output_sequence_length, config.num_mel_bins) 的 torch.FloatTensor —— 预测的 log-mel 频谱图。
  • 波形 （可选，当提供 vocoder 时返回） —— 形状为 (num_frames,) 的 torch.FloatTensor —— 预测的语音波形。
  • 交叉注意力 （可选，当 output_cross_attentions 为 True 时返回） —— 形状为 (config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) 的 torch.FloatTensor —— 解码器交叉注意力层的输出。
• 当 return_output_lengths 为 True
  • 频谱图 （可选，当未提供 vocoder 时返回） —— 形状为 (batch_size, output_sequence_length, config.num_mel_bins) 的 torch.FloatTensor —— 补充到最大长度的预测 log-mel 频谱图。
  • 频谱图长度 （可选，当未提供 vocoder 时返回） —— 形状为 List[Int] 的列表 —— 包含每个频谱图的特定长度。
  • 波形 （可选，当提供 vocoder 时返回） —— 形状为 (batch_size, num_frames) 的 torch.FloatTensor —— 补充到最大长度的预测语音波形。
  • 波形长度 （可选，当提供 vocoder 时返回） —— 形状为 List[Int] 的列表 —— 包含每个波形的特定长度。
  • 交叉注意力 （可选，当 output_cross_attentions 为 True 时返回） —— 形状为 (batch_size, config.decoder_layers, config.decoder_attention_heads, output_sequence_length, input_sequence_length) 的 torch.FloatTensor —— 解码器交叉注意力层的输出。

参数

• spectrogram（《torch.FloatTensor》）— 包含对数梅尔频谱的Tensor。可以是批处理的，形状为(batch_size, sequence_length, config.model_in_dim)，也可以是未批处理的，形状为(sequence_length, config.model_in_dim)。

包含语音信号的Tensor。如果输入频谱是批处理的，其形状将为(batch_size, num_frames,)。如果未批处理，其形状为(num_frames,)。