参数

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

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

  什么是输入 ID？

• input_features （torch�多浮点型 形状为 (batch_size, sequence_length, num_banks)，可选）— 输入音频特征。这应该由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。有关详细信息，请见 SeamlessM4TFeatureExtractor.call()。
• return_intermediate_token_ids （布尔值，可选）— 如果设置为 True，则还返回中间生成的文本和单位标记。如果您还想要音频的翻译文本，则设置为 True。请注意，如果 generate_speech=True，则此参数将被忽略。
• tgt_lang （字符串，可选）— 用于翻译的目标语言。
• spkr_id (int, 可选, 默认 0) — 语音合成的发言人 ID。必须小于 config.vocoder_num_spkrs。
• generate_speech (bool, 可选, 默认 True) — 如果为 False，则仅返回文本标记，不会生成语音。
• kwargs (可选) — 传递给 GenerationMixin.generate() 的剩余关键字参数字典。关键字参数有两种类型：
  • 没有前缀的参数将作为 **kwargs 传递给各个子模型的 generate 方法，除了 decoder_input_ids 将只通过文本组件传递。
  • 使用 text_ 或 speech_ 前缀的参数将分别用于文本模型和语音模型的 generate 方法。它具有高于没有前缀的关键字的优先级。

  这意味着您可以例如为一次生成指定一个生成策略，而不为另一个指定。

• 如果 generate_speech 和 return_intermediate_token_ids，返回 SeamlessM4TGenerationOutput。
• 如果generate_speech为真并且return_intermediate_token_ids为假，则返回一个由形状为(batch_size, sequence_length)的波形和waveform_lengths组成的元组，其中waveform_lengths给出每个样本的长度。
• 如果generate_speech=False，它将返回ModelOutput。

参数

• input_ids （torch.LongTensor 形状为 (batch_size, sequence_length)） — 输入序列令牌在词汇表中的索引。

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

  输入ID是什么？

• return_intermediate_token_ids （bool，可选） — 如果为 True，则还会返回中间生成的文字和单位令牌。如果您还需要获取与音频一起的翻译文本，则将其设置为 True。
• tgt_lang （str，可选） — 用于翻译的目标语言。

  使用时请注意，这将影响生成的文本的语言风格。

• — speaker_id（整数，可选项，默认为0）— 用于语音合成的扬声器ID。必须小于config.vocoder_num_spkrs。
• — kwargs（可选）— 将传递给GenerationMixin.generate()的剩余关键词参数字典。关键词参数有两种类型：

• 如果return_intermediate_token_ids为真，则返回SeamlessM4T生成输出。
• 如果不return_intermediate_token_ids为真，则返回一个由形状为(batch_size, sequence_length)的波形信号和waveform_lengths组成的元组，后者给出每个样本的长度。

参数

• input_features (torch.FloatTensor of shape (batch_size, sequence_length, num_banks)) — 输入音频特征。这应该由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。有关详细信息，请参阅 SeamlessM4TFeatureExtractor.call()。
• return_intermediate_token_ids (bool, 可选) — 如果设置为True，则还返回中间生成的文本和单位标记。如果还想要获取与音频一起的翻译文本，请设置为True。
• tgt_lang (str, 可选) — 用作翻译目标语言的语种。
• spkr_id (int, 可选，默认0) — 用于语音合成的说话人ID。必须小于config.vocoder_num_spkrs。
• kwargs（可选） — 将传递给 GenerationMixin.generate() 的剩余字典形式的键值对。键值对类型有两种：kwargs (可选) — 将传递给 GenerationMixin.generate() 的剩余关键字参数字典。关键字参数有两种类型：
  • 没有前缀，将作为每个子模型的 generate 方法中的 **kwargs 输入，除了 decoder_input_ids，它只会通过文本组件传递。
  • 带有 text_ 或 speech_ 前缀，将分别用于文本模型和语音模型的 generate 方法。带前缀的键值对比无前缀的键值对有更高的优先级。
  这意味着您可以针对一个生成策略进行设置，而对另一个则不进行设置。

• 如果return_intermediate_token_ids为真，则返回SeamlessM4T生成输出。
• 如果不return_intermediate_token_ids为真，则返回一个由形状为(batch_size, sequence_length)的波形信号和waveform_lengths组成的元组，后者给出每个样本的长度。

参数

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

  索引可以通过使用 SeamlessM4TTokenizer 或 SeamlessM4TProcessor 获取。参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。

  什么是输入ID？

• attention_mask （形状为 (batch_size, sequence_length) 的 torch.FloatTensor，可选）- 避免对填充 token 索引执行 attention 的掩码。掩码值选择在 [0, 1]：
  • 1 表示未 掩码 的 token，
  • 0 表示 掩码 的 token。

  什么是 attention mask？

• decoder_input_ids （形状为 (batch_size, target_sequence_length) 的 torch.LongTensor，可选）- 词汇表中解码输入序列 token 的索引。

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

  什么是解码输入 ID？

  Bart 使用 eos_token_id 作为 decoder_input_ids 生成时的起始 token。如果使用 past_key_values，则可以选择只输入最后的 decoder_input_ids（见 past_key_values）。

  对于翻译和摘要训练，应提供 decoder_input_ids。如果没有提供 decoder_input_ids，则模型将根据论文中的去噪预训练方法通过将 input_ids 向右移动来创建此张量。

• decoder_attention_mask (torch.LongTensor of shape (batch_size, target_sequence_length), optional) — 默认行为：生成一个忽略decoder_input_ids中填充token的tensor。默认还将使用因果掩码。

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

• encoder_outputs (tuple(tuple(torch.FloatTensor), optional) — 元组包含（last_hidden_state，可选: hidden_states，可选: attentions）last_hidden_state的shape为(batch_size, sequence_length, hidden_size)，可选）是编码器最后一层的hidden-states序列。在解码器的交叉注意力中被使用。
• past_key_values (tuple(tuple(torch.FloatTensor)), 可选，当传入 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor))，其中每个 tuple 包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量以及两个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。《p>

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

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

  HTML_TAG_END -->

• inputs_embeds (torch.FloatTensor 形状为(batch_size, sequence_length, hidden_size), 可选) — 可选择直接传递嵌入式表示，而不是传递 input_ids。这在您想比模型内部的嵌入查找矩阵有更多控制权，将 input_ids 索引转换为相关向量时非常有用。

  HTML_TAG_END -->

• decoder_inputs_embeds (torch.FloatTensor维度为(batch_size, target_sequence_length, hidden_size)，可选) — 可以选择不传递decoder_input_ids，而是直接传递嵌入表示。如果使用past_key_values，则可以选择仅输入最后一个decoder_inputs_embeds（见past_key_values）。这在您想对自己的decoder_input_ids索引转换为相关向量有更多控制权时很有用，比模型内部的嵌入查找矩阵更灵活。

  如果同时未设置decoder_input_ids和decoder_inputs_embeds，则decoder_inputs_embeds将取inputs_embeds的值。

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

参数

• tgt_lang (str, 可选) — 用于翻译的目标语言。
• generation_config (~generation.GenerationConfig, 可选) — 用于生成调用作为基础参数化的生成配置。传递给 generate 的 **kwargs 将覆盖它们。如果不提供 generation_config，将使用默认值，其加载优先级如下：1) 从存在的 generation_config.json 模型文件加载；2) 从模型配置加载。请注意，未指定的参数将继承 GenerationConfig 的默认值，参数化生成时应检查其文档。
• logits_processor (LogitsProcessorList, 可选) — 用于补充从参数和生成配置构建的默认 logits 处理器的自定义 logits 处理器。如果传递了一个已经使用参数或生成配置创建的 logits 处理器，将引发错误。此功能旨在供高级用户使用。
• stopping_criteria (StoppingCriteriaList, 可选) — 配合由参数和生成配置构建的默认停止标准，自定义的停止标准。如果传入了已通过参数或生成配置创建的停止标准，则抛出错误。此功能旨在为高级用户使用。
• prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], List[int]], 可选) — 如果提供，此函数将限制每个步骤仅允许的标记。如果未提供，则不应用约束。此函数接受两个参数：批次 ID batch_id 和 input_ids。它必须根据批次 ID batch_id 和先前生成的标记 inputs_ids 返回一个包含允许标记的列表，以便于下一步的生成。此参数对于基于前缀的约束生成非常有用，如Autoregressive Entity Retrieval中所述。
• synced_gpus (bool, 可选, 默认为 False) — 是否持续运行 while 循环直到 max_length（对于 ZeRO 阶段 3 所需）。
• kwargs (Dict[str, Any], optional) — 为 generate_config 和/或模型特定的额外 kwargs 添加临时参数化，这些参数将被传递到模型的 forward 函数中。

A ModelOutput（如果 return_dict_in_generate=True 或当 config.return_dict_in_generate=True）或一个 torch.FloatTensor。可能的 ModelOutput 类型包括

• GenerateEncoderDecoderOutput,
• GenerateBeamEncoderDecoderOutput

参数

• input_features (torch.FloatTensor of shape (batch_size, sequence_length, num_banks)) — 输入音频特征。应由SeamlessM4TFeatureExtractor类或SeamlessM4TProcessor类返回。请参阅SeamlessM4TFeatureExtractor.call()获取详细信息。
• attention_mask (torch тариф. floating. Int32 的形状为 (batch_size, sequence_length), 可选) — 避免在填充token索引上执行注意力操作的掩码。掩码值选择在 [0, 1]:
  • 1 表示 未掩码 的token,
  • 0 表示 掩码 的token.

  什么是注意力掩码？

• decoder_input_ids (torch.tarif. Int64 的形状为 (batch_size, target_sequence_length), 可选) — 词汇中解码输入序列token的索引。

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

  什么是解码器输入ID？

  Bart将 eos_token_id 用作 decoder_input_ids 生成器的起始token。如果使用 past_key_values，可以选择只输入最后一个 decoder_input_ids。（请参阅 past_key_values）。

  对于翻译和摘要训练，应提供 decoder_input_ids。如果没有提供 decoder_input_ids，则该模型将创建此张量，按论文进行的去噪预训练将 input_ids 向右移位。

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

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

• 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) 的额外张量。《p>

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

  如果使用 past_key_values，用户可选择只输入最后 decoder_input_ids（未向此模型提供其过去键值状态的）形状为 (batch_size, 1) 的 decoder_input_ids，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。《p>

• inputs_embeds （代码 torch.FloatTensor 的形状为 (batch_size, sequence_length, hidden_size)，可选）— 你可以选择直接传递嵌入表示，而不是传递 input_ids，这在你想要比模型的内部嵌入查找矩阵有更多控制权时很有用，如果你想对比如何将 input_ids 索引转换为其相关向量有更多控制权。
• decoder_inputs_embeds (torch.FloatTensor of shape (batch_size, target_sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递 decoder_input_ids。如果使用 past_key_values，则可选项中只需要输入最后一个 decoder_inputs_embeds。这在您想要相较于模型的内部嵌入查找矩阵，拥有更多控制权时很有用，将其从 decoder_input_ids 索引转换为关联向量。

  如果 decoder_input_ids 和 decoder_inputs_embeds 都未设置，则 decoder_inputs_embeds 的值为 inputs_embeds。

• labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 范围内（参见 input_ids 说明）。将索引设置为 -100 的标记将被忽略（掩码），只对具有标记的标记 [0, ..., config.vocab_size] 计算损失。

  如果 decoder_input_ids 和 decoder_inputs_embeds 都未设置，则 decoder_inputs_embeds 的值为 inputs_embeds。

• use_cache (bool, optional) — 如果设置为 True，那么将返回 past_key_values 的键值状态，并可用于加速解码（参见 past_key_values）。

参数

• tgt_lang (str, 可选) — 用于翻译的目标语言。
• generation_config (~generation.GenerationConfig, 可选) — 用于生成调用的基本参数配置。传递给generate的匹配generation_config属性的**kwargs将覆盖它们。如果没有提供generation_config，将使用默认设置，其加载优先级如下：1) 从generation_config.json模型文件，如果存在；2) 从模型配置。请注意，未指定的参数将继承GenerationConfig的默认值，其文档应进行检查以进行生成参数化。
• logits_processor (LogitsProcessorList, 可选) — 互补默认logits处理器的自定义logits处理器。如果传入了一个已经使用参数或生成配置创建的logit处理器，将引发错误。该功能针对高级用户。
• stopping_criteria (StoppingCriteriaList, 可选) — 自定义停止条件，用于补充分配默认的停止条件。如果传入的停止条件与参数或生成配置已存在的停止条件相同，则会抛出错误。此功能面向高级用户。
• prefix_allowed_tokens_fn (Callable:[[int, torch.Tensor], List[int]], 可选) — 如果提供，这个函数将将束带搜索限制为每个步骤只允许的标记。如果不提供，则不应用任何约束。这个函数接受两个参数：批次IDbatch_id和 input_ids。它必须返回一个列表，表示下一个生成步骤的允许标记，基于批次ID batch_id 和之前的生成标记 inputs_ids。此参数对于根据前缀约束生成很有用，如自回归实体检索中所述。
• synced_gpus (bool, 可选，默认为 False) — 是否继续运行循环直到 max_length（这对于 ZeRO 阶段 3）
• kwargs (Dict[str, Any], 可选) — 对generate_config的临时参数化和/或模型特定的其他参数，这些参数将被转发到模型的forward函数。

A ModelOutput（如果 return_dict_in_generate=True 或当 config.return_dict_in_generate=True）或一个 torch.FloatTensor。可能的 ModelOutput 类型包括

• GenerateEncoderDecoderOutput,
• GenerateBeamEncoderDecoderOutput

参数

• 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（消除批处理序列的不确定性）。
• padding (bool, str 或 PaddingStrategy，可选，默认为 True）— 选择一个策略来填充返回的序列（根据模型的填充侧和填充索引），在以下选项中选择：
  • True 或 'longest'：填充到批次中最长的序列（如果只提供了单个序列，则为不填充）。
  • 'max_length'：填充到使用参数 max_length 指定的最大长度，或到模型可接受的最大输入长度。
  • False 或 'do_not_pad'（默认）：不填充（即可以输出具有不同长度的序列的批次）。
• pad_to_multiple_of (int，可选）— 如果设置，将序列填充到指定值的倍数。

  这在启用 NVIDIA 硬件上具有计算能力 >= 7.5（Volta）的 Tensor Cores 非常有用。

• src_lang (str，可选）— 表示源语言的字符串。如果没有指定，将使用在初始化或调用此分词器时指定的最后一个 src_lang。
• tgt_lang (str, 可选) — 表示目标语言的字符串。如果没有指定，将使用最后指定的 tgt_lang（无论是初始化时还是调用此分词器时）。
• kwargs (可选) — 将传递给 PreTrainedTokenizer.call() 的剩余关键字参数字典。

参数

• token_ids_0 (int列表) — 将特殊标记添加到的ID列表。
• token_ids_1 (int列表, 可选) — 用于序列对的第二个可选ID列表。

添加了适当特殊标记的输入ID列表。

参数

• token_ids_0 (列表[int]) — ID 列表。
• token_ids_1 (列表[int], 可选) — 顺序对的可选第二个 ID 列表。
• already_has_special_tokens (布尔, 可选, 默认为 False) — 检查标记列表是否已经格式化为具有模型特殊标记的格式。

范围 [0, 1] 内的整数值列表：1 代表特殊标记，0 代表序列标记。

参数

• token_ids_0 (列表[int]) — 标识符列表。
• token_ids_1 (列表[int], 可选) — 可选的序列对第二个ID列表。

零的列表。

参数

• 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（以消除与序列批次的歧义）。
• padding (bool, str 或 PaddingStrategy, 可选, 默认为 True) — 选择填充策略来填充返回的序列（根据模型填充方向和填充索引），在以下选项中选择一个：
  • True 或 'longest'：填充到批中序列最长的那一个（或者如果没有提供序列则不填充）。
  • 'max_length'：填充到使用 max_length 参数指定的最大长度，如果没有提供该参数则填充到模型可以接受的最大输入长度。
  • False 或 'do_not_pad'（默认）：不填充（即，可以输出长度不同的序列批）。
• pad_to_multiple_of (int, 可选) — 如果设置，将序列填充到指定值的倍数。

  这在启用与具有计算能力 >= 7.5（Volta）的 NVIDIA 硬件上的 Tensor Cores 时特别有用。

• src_lang (str, 可选) — 代表源语言的字符串。如果未指定，将使用在初始化或调用此标记化器时指定的最后一个 src_lang。
• tgt_lang (str, 可选) — 表示目标语言的字符串。如果没有指定，将使用最后指定的 tgt_lang（无论是在初始化时还是在调用此标记化器时）
• kwargs (可选) — 将传递给 PreTrainedTokenizerFast.call() 的剩余关键字参数字典

参数

• raw_speech (np.ndarray, torch.Tensor, List[float], List[np.ndarray], List[torch.Tensor], —
• List[List[float]], List[List[List[float]]]) — 要填充的序列或序列批量。每个序列可以是一个numpy数组，一个torch张量，一个浮点值列表，一个numpy数组列表，一个torch张量列表，一个浮点值列表列表，或一个浮点值列表列表列表。如果raw_speech是一个一维np.ndarray，torch.Tensor或一个List[float]，则raw_speech被视为单通道、单样本声音。在其他所有情况下，raw_speech的第一个维度（无论来自np.ndarray，torch.Tensor还是List[...]），对应于批量的样本数，通道数（即单声道或立体声特征）由其他维度推导（1D -> 单通道波形批量；2D -> 立体声波形批量）。
• padding (bool, str 或 PaddingStrategy，可选，默认为True） — 选择策略以填充返回的序列（根据模型填充方向和填充索引），从以下选项中选一个：
  • True 或 'longest'：填充到批量中最长的序列（如果提供单个序列则不填充）。
  • 'max_length'：填充到使用 max_length 参数指定的最大长度，如果未提供该参数，则到模型接受的输入长度。
  • False 或 'do_not_pad'（默认）：不填充（即可以输出具有不同长度的序列的批量）。
• pad_to_multiple_of (int, optional, defaults to 2) — If set, the sequence will be padded to a multiple of the provided value.

  This is particularly useful for enabling the use of Tensor Cores on NVIDIA hardware with compute capability >= 7.5 (Volta), or on TPUs that benefit from having sequence lengths as multiples of 128.

• max_length (int, optional) — The maximum length of the returned list and the optional padding length (see above).
• // HTML_TAG_START -->truncation (bool) — Activates truncation to cut the input sequences longer than max_length to max_length.
• return_attention_mask (bool, 可选) — 是否返回注意力掩码。如果设置为默认，将根据特定特征提取器的默认值返回注意力掩码。

  什么是注意力掩码？

  对于SeamlessM4T模型，attention_mask应始终在批推理时传递，以避免微妙的错误。

• return_tensors (str 或 TensorType, 可选) — 如果设置，将返回张量而不是Python整数列表。可接受值为：
  • 'tf': 返回TensorFlow tf.constant对象。
  • 'pt': 返回PyTorch torch.Tensor对象。
  • 'np': 返回Numpy np.ndarray对象。
• sampling_rate (int, 可选) — raw_speech输入被采样的采样率。强烈建议在正向调用时传递sampling_rate以防止静默错误。
• do_normalize_per_mel_bins （bool，可选，默认为 True）— 是否使用输入的 mel 通道进行零均值单位方差归一化。
• kwargs（可选）— 传递给分词器或特征提取器的剩余关键字参数字典。

• input_ids （形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选）— 输入序列标记在词汇表中的索引。

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

  什么是输入ID？

• attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 避免在填充标记索引上执行注意力操作的掩码。掩码值在 [0, 1] 范围内选择：
  • 1 对应未遮蔽的标记；
  • 0 对应遮蔽的标记。

  什么是注意力掩码？

• decoder_input_ids (torch.LongTensor of shape (batch_size, target_sequence_length), optional) — 词汇表中解码器输入序列标记的索引。

  可以使用 AutoTokenizer 获取索引。详情见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

  什么是解码器输入 ID？

  Bart 使用 eos_token_id 作为 decoder_input_ids 生成中的起始标记。如果使用 past_key_values，则可选地只需要输入最后 decoder_input_ids（见 past_key_values）。

  在翻译和摘要训练中，应提供 decoder_input_ids。如果没有提供 decoder_input_ids，则模型将根据论文中的去噪预训练技术通过将 input_ids 向右移位来创建这个张量。

• decoder_attention_mask (torch.LongTensor 形状为 (batch_size, target_sequence_length)，可选) — 默认行为：生成一个忽略 decoder_input_ids 中填充令牌的张量。默认还将使用因果掩码。

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

• 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) 的 2 个张量以及形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的 2 个额外张量。
  包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加快顺序解码

  如果使用past_key_values，则用户可以只输入最后一个decoder_input_ids（那些未向此模型提供过去键值状态的decoder_input_ids），其形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。

• inputs_embeds （形状为torch.FloatTensor），(batch_size, sequence_length, hidden_size)，可选 — 除了传递input_ids外，您还可以直接传递嵌入表示。如果您想比模型内部的嵌入查找矩阵有更多控制权，则这很有用，以控制如何将input_ids索引转换为相关向量。
• decoder_inputs_embeds （形状为torch.FloatTensor的(batch_size, target_sequence_length, hidden_size)，可选）—— 可选择不传递decoder_input_ids，而是直接传递嵌入表示。如果使用past_key_values，则可选地仅输入最后的decoder_inputs_embeds（参见past_key_values）。这有助于更好地控制如何将decoder_input_ids索引转换为关联向量，而不是使用模型内部的嵌入查找矩阵。

  如果既未设置decoder_input_ids也未设置decoder_inputs_embeds，则decoder_inputs_embeds将取值为inputs_embeds。

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