Transformers documentation
SeamlessM4T
该模型于 2023-08-22 在 HF papers 上发布，并于 2023-10-23 贡献至 Hugging Face Transformers。
SeamlessM4T
概述
SeamlessM4T 模型由 Meta AI 的 Seamless Communication 团队在 SeamlessM4T — Massively Multilingual & Multimodal Machine Translation 中提出。
这是该模型的 版本 1 发布。有关更新的 版本 2 发布，请参阅 Seamless M4T v2 文档。
SeamlessM4T 是一组旨在提供高质量翻译的模型，让来自不同语言社区的人们能够通过语音和文本轻松交流。
SeamlessM4T 无需依赖单独的模型即可实现多种任务：
- 语音到语音翻译 (S2ST)
- 语音到文本翻译 (S2TT)
- 文本到语音翻译（T2ST）
- 文本到文本翻译 (T2TT)
- 自动语音识别（ASR）
SeamlessM4TModel 可以执行上述所有任务，但每个任务也有其专用的子模型。
该论文的摘要如下：
打造 Babel Fish——一款能够帮助人们在任意两种语言之间进行语音翻译的工具——需要具备哪些条件？尽管基于文本的模型近期取得了突破性进展，将机器翻译的覆盖范围扩展到了 200 多种语言，但统一的语音到语音翻译模型尚未取得类似的进展。更具体地说，传统的语音到语音翻译系统依赖于级联系统，逐步执行翻译任务，这使得高性能的统一系统难以实现。为了弥补这些不足，我们推出了 SeamlessM4T，这是一个单一模型，支持多达 100 种语言的语音到语音翻译、语音到文本翻译、文本到语音翻译、文本到文本翻译以及自动语音识别。为了构建该模型，我们使用了 100 万小时的开放语音音频数据，通过 w2v-BERT 2.0 学习自监督语音表示。随后，我们创建了一个由自动对齐的语音翻译组成的多模态语料库。经过过滤并与人工标注数据和伪标注数据相结合，我们开发了首个能够同时支持语音和文本、且以英语为源语言或目标语言进行翻译的多语言系统。在 FLEURS 上，SeamlessM4T 为多种目标语言的翻译树立了新标准，在直接语音到文本翻译中，BLEU 分数比之前的 SOTA 提升了 20%。与强大的级联模型相比，SeamlessM4T 将语音到文本的英语翻译质量提高了 1.3 个 BLEU 点，将语音到语音的英语翻译质量提高了 2.6 个 ASR-BLEU 点。在鲁棒性测试中，与当前的 SOTA 模型相比，我们的系统在语音到文本任务中更能抵抗背景噪声和说话人变化。至关重要的是，我们评估了 SeamlessM4T 的性别偏见并添加了毒性检测，以评估翻译的安全性。最后，本工作的所有贡献均已开源，并可在 https://github.com/facebookresearch/seamless_communication 获取。
用法
首先，加载处理器和模型的检查点：
from transformers import AutoProcessor, SeamlessM4TModel
processor = AutoProcessor.from_pretrained("facebook/hf-seamless-m4t-medium")
model = SeamlessM4TModel.from_pretrained("facebook/hf-seamless-m4t-medium", device_map="auto")您可以无缝地将此模型用于文本或音频，以生成翻译后的文本或翻译后的音频。
以下是如何使用处理器处理文本和音频：
# let's load an audio sample from an Arabic speech corpus
from datasets import load_dataset
dataset = load_dataset("halabi2016/arabic_speech_corpus", split="test", streaming=True)
audio_sample = next(iter(dataset))["audio"]
# now, process it
audio_inputs = processor(audio=audio_sample["array"], return_tensors="pt").to(model.device)
# now, process some English test as well
text_inputs = processor(text = "Hello, my dog is cute", src_lang="eng", return_tensors="pt").to(model.device)语音
SeamlessM4TModel 可以无缝生成文本或语音，几乎无需任何更改。我们以俄语语音翻译为目标：
audio_array_from_text = model.generate(**text_inputs, tgt_lang="rus")[0].cpu().numpy().squeeze()
audio_array_from_audio = model.generate(**audio_inputs, tgt_lang="rus")[0].cpu().numpy().squeeze()使用几乎相同的代码，我将英文文本和阿拉伯语语音翻译成了俄语语音样本。
文本
类似地，你可以使用相同的模型从音频文件或文本生成翻译后的文本。你只需将 generate_speech=False 传递给 SeamlessM4TModel.generate() 即可。
这次，让我们将其翻译成法语。
# from audio
output_tokens = model.generate(**audio_inputs, tgt_lang="fra", generate_speech=False)
translated_text_from_audio = processor.decode(output_tokens[0].tolist()[0], skip_special_tokens=True)
# from text
output_tokens = model.generate(**text_inputs, tgt_lang="fra", generate_speech=False)
translated_text_from_text = processor.decode(output_tokens[0].tolist()[0], skip_special_tokens=True)提示
1. 使用专用模型
SeamlessM4TModel 是 transformers 中用于生成语音和文本的顶层模型，但您也可以使用专门执行该任务的独立模型，从而减少内存占用。 例如，您可以将语音到语音生成的代码片段替换为专门用于 S2ST 任务的模型，其余代码完全相同：
from transformers import SeamlessM4TForSpeechToSpeech
model = SeamlessM4TForSpeechToSpeech.from_pretrained("facebook/hf-seamless-m4t-medium", device_map="auto")或者，您可以将文本到文本生成的代码片段替换为专门用于 T2TT 任务的模型，只需移除 generate_speech=False 即可。
from transformers import SeamlessM4TForTextToText
model = SeamlessM4TForTextToText.from_pretrained("facebook/hf-seamless-m4t-medium", device_map="auto")您也可以尝试使用 SeamlessM4TForSpeechToText 和 SeamlessM4TForTextToSpeech。
2. 更改说话人身份
您可以通过 spkr_id 参数更改用于语音合成的说话人。对于某些语言，某些 spkr_id 的效果比其他 spkr_id 更好！
3. 更改生成策略
你可以为语音和文本生成使用不同的生成策略，例如 .generate(input_ids=input_ids, text_num_beams=4, speech_do_sample=True)，该调用会先在文本模型上执行束搜索解码，再在语音模型上执行多项式采样。
4. 同时生成语音和文本
使用 return_intermediate_token_ids=True 配合 SeamlessM4TModel 可同时返回语音和文本！
模型架构
SeamlessM4T 采用了一种灵活的架构，能够流畅地处理文本和语音的序列生成。该设置由两个序列到序列（seq2seq）模型组成。第一个模型将输入模态翻译为译文文本，而第二个模型则从译文文本中生成语音 token，即所谓的“unit token”。
每种模态都拥有各自专用的编码器，且架构各不相同。此外，对于语音输出，会在第二个 seq2seq 模型之上放置一个受 HiFi-GAN 架构启发的声码器。
生成过程的工作方式如下：
- 输入文本或语音会通过其对应的编码器进行处理。
- 解码器生成目标语言中的文本标记。
- 如果需要语音生成，第二个 seq2seq 模型将采用标准的编码器-解码器结构来生成单元 token。
- 随后，这些单元 token 会被送入最终的声码器，以生成实际的语音。
SeamlessM4TModel
class transformers.SeamlessM4TModel
< source >( config: SeamlessM4TConfigcurrent_modality = 'text' )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
- current_modality (
str，可选，默认为"text") — 默认模态。用于初始化模型。
原始的 SeamlessM4T Model transformer，可用于所有可用任务（S2ST、S2TT、T2TT、T2ST）。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
generate
< source >( input_ids: typing.Optional[torch.Tensor] = Noneinput_features: typing.Optional[torch.Tensor] = Nonereturn_intermediate_token_ids: bool | None = Nonetgt_lang: str | None = Nonespkr_id: int | None = 0generate_speech: bool | None = True**kwargs ) → Union[SeamlessM4TGenerationOutput, tuple[Tensor], ModelOutput]
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 输入序列中各 token 在词汇表中的索引。可通过 SeamlessM4TTokenizer 或 SeamlessM4TProcessor 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。什么是输入 ID？可以使用 SeamlessM4TTokenizer 或 SeamlessM4TProcessor 获取索引。详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, num_banks)，可选) — 输入音频特征。这应由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。详情请参见 SeamlessM4TFeatureExtractor.call()。 - return_intermediate_token_ids (
bool，可选) — 如果为True，还会返回中间生成的文本和单元 token。如果您希望在获取音频的同时也获取翻译后的文本，请将其设置为True。 请注意，如果generate_speech=False，此参数将被忽略，并返回文本 token。 - tgt_lang (
str, 可选) — 用于翻译的目标语言。 - spkr_id (
int，可选，默认为 0) — 用于语音合成的说话人 ID。必须小于config.vocoder_num_spkrs。 - generate_speech（
bool，可选，默认为True） — 如果为False，则仅返回文本 token，不生成语音。 - kwargs (可选) —
其余关键字参数字典，将传递给 GenerationMixin.generate(). 关键字参数分为两种类型：
不带前缀的参数将作为 **kwargs 传入每个子模型的 generate 方法，但 decoder_input_ids 除外，它只会通过文本组件传递。带有 text_ 或 speech_ 前缀的参数将分别作为文本模型和语音模型的 generate 方法的输入。它们优先于不带前缀的关键字。这意味着例如，您可以为一种生成指定生成策略，而不为另一种生成指定。
- 如果没有前缀，它们将作为
**kwargs传入每个子模型的generate方法， 但decoder_input_ids除外，它只会通过文本组件传递。 - 如果带有 text_ 或 speech_ 前缀，它们将分别作为文本模型和语音模型的
generate方法的输入。其优先级高于不带前缀的关键字。
这意味着，例如，你可以为一次生成指定生成策略，而不为另一次生成指定。
- 如果没有前缀，它们将作为
返回值
Union[SeamlessM4TGenerationOutput, tuple[Tensor], ModelOutput]
- 如果设置了
generate_speech和return_intermediate_token_ids，则返回SeamlessM4TGenerationOutput。 - 如果
generate_speech为真且return_intermediate_token_ids为假，则返回一个元组，其中包含形状为(batch_size, sequence_length)的波形以及waveform_lengths，后者给出每个样本的长度。 - 如果
generate_speech=False，则返回ModelOutput。
生成翻译后的 token id 和/或翻译后的音频波形。
该方法会依次调用两个不同子模型的
.generate函数。您可以在两个不同的层级指定关键字参数：通用参数会传递给两个模型，而带前缀的参数则只传递给其中一个模型。例如，调用
.generate(input_ids=input_ids, num_beams=4, speech_do_sample=True)会依次对文本模型执行束搜索解码，并对语音模型执行多项式束搜索采样。有关生成策略和代码示例的概述，请参阅以下指南。
SeamlessM4TForTextToSpeech
class transformers.SeamlessM4TForTextToSpeech
< source >( config: SeamlessM4TConfig )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于 T2ST 的文本转语音 SeamlessM4T 模型 transformer。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
generate
< source >( input_ids: typing.Optional[torch.Tensor] = Nonereturn_intermediate_token_ids: bool | None = Nonetgt_lang: str | None = Nonespkr_id: int | None = 0**kwargs ) → Union[SeamlessM4TGenerationOutput, tuple[Tensor]]
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列中各 token 在词汇表中的索引。可以使用 SeamlessM4TTokenizer 或 SeamlessM4TProcessor 获取索引。详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- return_intermediate_token_ids (
bool，可选) — 如果为True，还会返回中间生成的文本和单元 token。如果您希望在获取音频的同时也获取翻译后的文本，请将其设置为True。 - tgt_lang (
str, 可选) — 用于翻译的目标语言。 - spkr_id (
int，可选，默认为 0) — 用于语音合成的说话人 ID。必须小于config.vocoder_num_spkrs。 - kwargs (可选) —
其余关键字参数字典，将传递给 GenerationMixin.generate(). 关键字参数分为两种类型：
不带前缀的参数将作为 **kwargs 传入每个子模型的 generate 方法，但 decoder_input_ids 除外，它只会通过文本组件传递。带有 text_ 或 speech_ 前缀的参数将分别作为文本模型和语音模型的 generate 方法的输入。它们优先于不带前缀的关键字。这意味着例如，您可以为一种生成指定生成策略，而不为另一种生成指定。
- 如果没有前缀，它们将作为
**kwargs传入每个子模型的generate方法， 但decoder_input_ids除外，它只会通过文本组件传递。 - 如果带有 text_ 或 speech_ 前缀，它们将分别作为文本模型和语音模型的
generate方法的输入。其优先级高于不带前缀的关键字。
这意味着，例如，你可以为一次生成指定生成策略，而不为另一次生成指定。
- 如果没有前缀，它们将作为
返回值
Union[SeamlessM4TGenerationOutput, tuple[Tensor]]
- 如果设置了
return_intermediate_token_ids，则返回SeamlessM4TGenerationOutput。 - 如果未设置
return_intermediate_token_ids，则返回一个元组，其中包含形状为(batch_size, sequence_length)的波形以及waveform_lengths，后者给出每个样本的长度。
生成翻译后的音频波形。
该方法会依次调用两个不同子模型的
.generate函数。您可以在两个不同的层级指定关键字参数：通用参数会传递给两个模型，而带前缀的参数则只传递给其中一个模型。例如，调用
.generate(input_ids, num_beams=4, speech_do_sample=True)会依次对文本模型执行束搜索解码，并对语音模型执行多项式束搜索采样。有关生成策略和代码示例的概述，请参阅以下指南。
SeamlessM4TForSpeechToSpeech
class transformers.SeamlessM4TForSpeechToSpeech
< source >( config: SeamlessM4TConfig )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
可用于 S2ST 的语音到语音 SeamlessM4T 模型 transformer。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
generate
< source >( input_features: typing.Optional[torch.Tensor] = Nonereturn_intermediate_token_ids: bool | None = Nonetgt_lang: str | None = Nonespkr_id: int | None = 0**kwargs ) → Union[SeamlessM4TGenerationOutput, tuple[Tensor]]
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, num_banks)) — 输入音频特征。这应由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。详情请参见 SeamlessM4TFeatureExtractor.call()。 - return_intermediate_token_ids (
bool，可选) — 如果为True，还会返回中间生成的文本和单元 token。如果您希望在获取音频的同时也获取翻译后的文本，请将其设置为True。 - tgt_lang (
str, 可选) — 用于翻译的目标语言。 - spkr_id (
int，可选，默认为 0) — 用于语音合成的说话人 ID。必须小于config.vocoder_num_spkrs。 - kwargs (可选) —
其余关键字参数字典，将传递给 GenerationMixin.generate(). 关键字参数分为两种类型：
不带前缀的参数将作为 **kwargs 传入每个子模型的 generate 方法，但 decoder_input_ids 除外，它只会通过文本组件传递。带有 text_ 或 speech_ 前缀的参数将分别作为文本模型和语音模型的 generate 方法的输入。它们优先于不带前缀的关键字。这意味着例如，您可以为一种生成指定生成策略，而不为另一种生成指定。
- 如果没有前缀，它们将作为
**kwargs传入每个子模型的generate方法， 但decoder_input_ids除外，它只会通过文本组件传递。 - 如果带有 text_ 或 speech_ 前缀，它们将分别作为文本模型和语音模型的
generate方法的输入。其优先级高于不带前缀的关键字。
这意味着，例如，你可以为一次生成指定生成策略，而不为另一次生成指定。
- 如果没有前缀，它们将作为
返回值
Union[SeamlessM4TGenerationOutput, tuple[Tensor]]
- 如果设置了
return_intermediate_token_ids，则返回SeamlessM4TGenerationOutput。 - 如果未设置
return_intermediate_token_ids，则返回一个元组，其中包含形状为(batch_size, sequence_length)的波形以及waveform_lengths，后者给出每个样本的长度。
生成翻译后的音频波形。
该方法会依次调用两个不同子模型的
.generate函数。您可以在两个不同的层级指定关键字参数：通用参数会传递给两个模型，而带前缀的参数则只传递给其中一个模型。例如，调用
.generate(input_features, num_beams=4, speech_do_sample=True)会依次对文本模型执行束搜索解码，并对语音模型执行多项式束搜索采样。有关生成策略和代码示例的概述，请参阅以下指南。
SeamlessM4TForTextToText
class transformers.SeamlessM4TForTextToText
< source >( config: SeamlessM4TConfig )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
可用于 T2TT 的文本到文本 SeamlessM4T 模型 transformer。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: tuple[tuple[torch.Tensor]] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonedecoder_inputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → Seq2SeqLMOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), ，可选) — 输入序列中各 token 在词汇表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- decoder_input_ids (
torch.LongTensor形状为(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 向右移位以创建该张量，用于去噪预训练。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
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.Tensor]]，可选) — 元组由 (last_hidden_state，可选：hidden_states，可选：attentions) 组成last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由past_key_values在解码的先前阶段返回，当use_cache=True或config.use_cache=True.仅允许将 Cache 实例作为输入，请参阅我们的 kv cache 指南。 如果未传入
past_key_values，则默认会初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未向该模型提供其过去键值状态的那些），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部input_ids。 - inputs_embeds (
torch.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，除了传递input_ids之外，您还可以选择直接传递嵌入表示。如果您希望对input_ids索引如何转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选)： 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids的文档字符串）。索引设置为-100的 token 将被忽略（即被掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的 token 进行计算。 - decoder_inputs_embeds (
torch.Tensor形状为(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)，可选) — 用于计算掩码语言建模损失的标签。索引值应在[0, ..., config.vocab_size]范围内，或为 -100（参见input_ids的文档字符串）。索引值设为-100的 token 将被忽略（即被掩码），损失仅针对标签位于[0, ..., config.vocab_size]范围内的 token 进行计算。 - use_cache (
bool，可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回值
Seq2SeqLMOutput 或 tuple(torch.Tensor)
一个 Seq2SeqLMOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（SeamlessM4TConfig）和输入。
SeamlessM4TForTextToText 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为
(1,)的torch.Tensor，可选，在提供labels时返回）— 语言建模损失。logits（形状为
(batch_size, sequence_length, config.vocab_size)的torch.Tensor）— 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。past_key_values（
EncoderDecoderCache，可选，在传入use_cache=True或config.use_cache=True时返回）—— 它是一个 EncoderDecoderCache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出处的隐藏状态，以及初始嵌入输出。
decoder_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
cross_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层在注意力 softmax 之后的注意力权重，用于在交叉注意力头中计算加权平均值。
encoder_last_hidden_state（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选）— 模型编码器最后一层输出的隐藏状态序列。encoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出处的隐藏状态，以及初始嵌入输出。
encoder_attentions（
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回）—— 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
generate
< source >( input_ids = Nonetgt_lang = Nonegeneration_config = Nonelogits_processor = Nonestopping_criteria = Noneprefix_allowed_tokens_fn = Nonesynced_gpus = False**kwargs ) → ModelOutput or torch.LongTensor
参数
- input_ids (
torch.Tensor形状因模态而异的 可选) — 输入序列中各 token 在词汇表中的索引。可以使用 SeamlessM4TTokenizer 或 SeamlessM4TProcessor 获取索引。详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]], 可选) — 如果提供，此函数会在每一步将束搜索限制为仅使用允许的 token。如果未提供，则不施加任何约束。此函数接受 2 个参数：批次 IDbatch_id和input_ids。它必须返回一个列表，其中包含根据批次 IDbatch_id和之前生成的 tokeninputs_ids条件化后，用于下一步生成的允许 token。此参数对于基于前缀的约束生成非常有用，如 Autoregressive Entity Retrieval 中所述。 - synced_gpus (
bool，可选，默认为False) — 是否继续执行 while 循环直到达到 max_length（为避免与FullyShardedDataParallel和 DeepSpeed ZeRO Stage 3 发生死锁，需要此设置）。 - kwargs (
dict[str, Any], 可选) —generate_config的临时参数设置，和/或将被转发到模型forward函数的额外模型特定 kwargs。
返回值
ModelOutput 或 torch.LongTensor
ModelOutput（当 return_dict_in_generate=True 或 config.return_dict_in_generate=True 时）或 torch.Tensor。可能的 ModelOutput 类型包括：
生成 token id 序列。
大多数生成控制参数都在
generation_config中设置，如果未传入该参数，则会使用模型的默认生成配置。你可以通过向 generate() 传入相应参数来覆盖generation_config中的任意设置，例如.generate(inputs, num_beams=4, do_sample=True)。有关生成策略和代码示例的概述，请参阅以下指南。
SeamlessM4TForSpeechToText
class transformers.SeamlessM4TForSpeechToText
< source >( config: SeamlessM4TConfig )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
可用于 S2TT 的语音转文本 SeamlessM4T 模型 transformer。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_features: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: tuple[tuple[torch.Tensor]] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonedecoder_inputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → Seq2SeqLMOutput or tuple(torch.Tensor)
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, num_banks)) — 输入音频特征。这应由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。详情请参见 SeamlessM4TFeatureExtractor.call()。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- decoder_input_ids (
torch.LongTensor形状为(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 向右移位以创建该张量，用于去噪预训练。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
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.Tensor]]，可选) — 元组由 (last_hidden_state，可选：hidden_states，可选：attentions) 组成last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由past_key_values在解码的先前阶段返回，当use_cache=True或config.use_cache=True.仅允许将 Cache 实例作为输入，请参阅我们的 kv cache 指南。 如果未传入
past_key_values，则默认会初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未向该模型提供其过去键值状态的那些），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部input_ids。 - inputs_embeds (
torch.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，除了传递input_ids之外，您还可以选择直接传递嵌入表示。如果您希望对input_ids索引如何转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选)： 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids的文档字符串）。索引设置为-100的 token 将被忽略（即被掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的 token 进行计算。 - decoder_inputs_embeds (
torch.Tensor形状为(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)，可选) — 用于计算掩码语言建模损失的标签。索引值应在[0, ..., config.vocab_size]范围内，或为 -100（参见input_ids的文档字符串）。索引值设为-100的 token 将被忽略（即被掩码），损失仅针对标签位于[0, ..., config.vocab_size]范围内的 token 进行计算。 - use_cache (
bool，可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回值
Seq2SeqLMOutput 或 tuple(torch.Tensor)
一个 Seq2SeqLMOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（SeamlessM4TConfig）和输入。
SeamlessM4TForSpeechToText 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为
(1,)的torch.Tensor，可选，在提供labels时返回）— 语言建模损失。logits（形状为
(batch_size, sequence_length, config.vocab_size)的torch.Tensor）— 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。past_key_values（
EncoderDecoderCache，可选，在传入use_cache=True或config.use_cache=True时返回）—— 它是一个 EncoderDecoderCache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出处的隐藏状态，以及初始嵌入输出。
decoder_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
cross_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层在注意力 softmax 之后的注意力权重，用于在交叉注意力头中计算加权平均值。
encoder_last_hidden_state（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选）— 模型编码器最后一层输出的隐藏状态序列。encoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出处的隐藏状态，以及初始嵌入输出。
encoder_attentions（
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回）—— 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoProcessor, SeamlessM4TForSpeechToText
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("facebook/hf-seamless-m4t-medium")
>>> model = SeamlessM4TForSpeechToText.from_pretrained("facebook/hf-seamless-m4t-medium")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_ids = torch.argmax(logits, dim=-1)
>>> # transcribe speech
>>> transcription = processor.batch_decode(predicted_ids)
>>> transcription[0]
...
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
...generate
< source >( input_features = Nonetgt_lang = Nonegeneration_config = Nonelogits_processor = Nonestopping_criteria = Noneprefix_allowed_tokens_fn = Nonesynced_gpus = False**kwargs ) → ModelOutput or torch.LongTensor
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, num_banks)) — 输入音频特征。这应由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。详情请参见 SeamlessM4TFeatureExtractor.call()。 - 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]], 可选) — 如果提供，此函数会在每一步将束搜索限制为仅使用允许的 token。如果未提供，则不施加任何约束。此函数接受 2 个参数：批次 IDbatch_id和input_ids。它必须返回一个列表，其中包含根据批次 IDbatch_id和之前生成的 tokeninputs_ids条件化后，用于下一步生成的允许 token。此参数对于基于前缀的约束生成非常有用，如 Autoregressive Entity Retrieval 中所述。 - synced_gpus (
bool，可选，默认为False) — 是否继续执行 while 循环直到达到 max_length（为避免与FullyShardedDataParallel和 DeepSpeed ZeRO Stage 3 发生死锁，需要此设置）。 - kwargs (
dict[str, Any], 可选) —generate_config的临时参数设置，和/或将被转发到模型forward函数的额外模型特定 kwargs。
返回值
ModelOutput 或 torch.LongTensor
ModelOutput（当 return_dict_in_generate=True 或 config.return_dict_in_generate=True 时）或 torch.Tensor。可能的 ModelOutput 类型包括：
生成 token id 序列。
大多数生成控制参数都在
generation_config中设置，如果未传入该参数，则会使用模型的默认生成配置。你可以通过向 generate() 传入相应参数来覆盖generation_config中的任意设置，例如.generate(inputs, num_beams=4, do_sample=True)。有关生成策略和代码示例的概述，请参阅以下指南。
SeamlessM4TConfig
class transformers.SeamlessM4TConfig
< source >( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0id2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Noneis_encoder_decoder: bool = Truevocab_size: int = 256102t2u_vocab_size: int = 10082hidden_size: int = 1024initializer_range: float = 0.02layer_norm_eps: float = 1e-05use_cache: bool = Truemax_position_embeddings: int = 1024encoder_layerdrop: float | int = 0.05decoder_layerdrop: float | int = 0.05activation_function: str = 'relu'dropout: float | int = 0.1attention_dropout: float | int = 0.1activation_dropout: float | int = 0.0scale_embedding: bool = Trueencoder_layers: int = 24encoder_ffn_dim: int = 8192encoder_attention_heads: int = 16decoder_layers: int = 24decoder_ffn_dim: int = 8192decoder_attention_heads: int = 16decoder_start_token_id: int = 3max_new_tokens: int | None = 256pad_token_id: int | None = 0bos_token_id: int | None = 2eos_token_id: int | list[int] | None = 3speech_encoder_layers: int = 24speech_encoder_attention_heads: int = 16speech_encoder_intermediate_size: int = 4096speech_encoder_hidden_act: str = 'swish'speech_encoder_dropout: float | int = 0.0add_adapter: bool = Truespeech_encoder_layerdrop: float | int = 0.1feature_projection_input_dim: int = 160num_conv_pos_embeddings: int = 128num_conv_pos_embedding_groups: int = 16adaptor_kernel_size: int = 8adaptor_stride: int = 8adaptor_dropout: float | int = 0.1num_adapter_layers: int = 1position_embeddings_type: str = 'relative'rotary_embedding_base: int = 10000max_source_positions: int = 4096conv_depthwise_kernel_size: int = 31t2u_bos_token_id: int | None = 0t2u_pad_token_id: int | None = 1t2u_eos_token_id: int | list[int] | None = 2t2u_decoder_start_token_id: int = 2t2u_max_new_tokens: int = 1024t2u_encoder_layers: int = 6t2u_encoder_ffn_dim: int = 8192t2u_encoder_attention_heads: int = 16t2u_decoder_layers: int = 6t2u_decoder_ffn_dim: int = 8192t2u_decoder_attention_heads: int = 16t2u_max_position_embeddings: int = 2048sampling_rate: int = 16000upsample_initial_channel: int = 512upsample_rates: list[int] | tuple[int, ...] = (5, 4, 4, 2, 2)upsample_kernel_sizes: list[int] | tuple[int, ...] = (11, 8, 8, 4, 4)resblock_kernel_sizes: list[int] | tuple[int, ...] = (3, 7, 11)resblock_dilation_sizes: list | tuple = ((1, 3, 5), (1, 3, 5), (1, 3, 5))leaky_relu_slope: float = 0.1unit_hifi_gan_vocab_size: int = 10000unit_embed_dim: int = 1280lang_embed_dim: int = 256spkr_embed_dim: int = 256vocoder_num_langs: int = 36vocoder_num_spkrs: int = 200variance_predictor_kernel_size: int = 3var_pred_dropout: float | int = 0.5vocoder_offset: int = 4tie_word_embeddings: bool = True )
参数
- is_encoder_decoder (
bool，可选，默认为True) — 指示该模型是否用作编码器/解码器。 - vocab_size (
int，可选，默认为256102) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - t2u_vocab_size (
int, 可选，默认值为 10082) — SeamlessM4T 模型的单元词表大小。定义了调用 ~SeamlessM4TModel、~SeamlessM4TForSpeechToSpeech 或 ~SeamlessM4TForTextToSpeech 的 Text-To-Units 子模型时，传入的inputs_ids所能表示的不同单元 token 的数量。 - hidden_size (
int，可选，默认为1024) — 隐藏表示的维度。 - initializer_range (
float，可选，默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float，可选，默认为1e-05) — 层归一化层所使用的 epsilon 值。 - use_cache (
bool，可选，默认为True) — 模型是否应返回最后一次键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True或模型为仅解码器生成式模型时相关。 - max_position_embeddings (
int，可选，默认为1024) — 该模型可能使用的最大序列长度。 - encoder_layerdrop (
Union[float, int]，可选，默认值为0.05) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。 - decoder_layerdrop (
Union[float, int]，可选，默认值为0.05) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](see https://huggingface.co/papers/1909.11556)。 - activation_function (
str，可选，默认为relu) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu"等。 - dropout (
Union[float, int]，可选，默认为0.1) — 所有 dropout 层的比率。 - attention_dropout (
Union[float, int]，可选，默认为0.1) — 注意力概率的 dropout 比率。 - activation_dropout (
Union[float, int]，可选，默认为0.0) — 全连接层中激活值的 dropout 比率。 - scale_embedding (
bool，可选，默认为True) — 是否通过将嵌入除以 sqrt(d_model) 来对嵌入进行缩放。 - encoder_layers (
int，可选，默认为24) — Transformer 编码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - encoder_ffn_dim (
int, 可选, 默认值为8192) — 编码器中“中间”（通常称为前馈）层的维度。 - encoder_attention_heads (
int，可选，默认为16) — Transformer 编码器中每个注意力层的注意力头数量。 - decoder_layers (
int，可选，默认为24) — Transformer 解码器中的隐藏层数量。如果未设置，将使用与num_layers相同的值。 - decoder_ffn_dim (
int，可选，默认为8192) — 解码器中“中间”（通常称为前馈）层的维度。 - decoder_attention_heads (
int，可选，默认为16) — Transformer 解码器中每个注意力层的注意力头数量。 - decoder_start_token_id (
int，可选，默认为3) — 如果编码器-解码器模型使用不同于bos的 token 开始解码，则指定该 token 的 id。 - max_new_tokens (
int，可选，默认值为 256) — 要生成的文本 token 的最大数量，忽略提示词中的 token 数量。 - pad_token_id (
int, 可选，默认为0) — 词表中用于填充的 token id。 - bos_token_id (
int，可选，默认为2) — 词汇表中用于表示流起始的 Token id。 - eos_token_id (
Union[int, list[int]]，可选，默认为3) — 词汇表中用于表示流结束（end-of-stream）的 token id。 - speech_encoder_layers (
int，可选，默认为 24) — Transformer 语音编码器中的隐藏层数。 - speech_encoder_attention_heads (
int, 可选，默认为 16) — Transformer 语音编码器中每个注意力层的注意力头数量。 - speech_encoder_intermediate_size (
int，可选，默认为 4096) — Transformer 语音编码器中“中间”（即前馈）层的维度。 - speech_encoder_hidden_act (
str或function，可选，默认为"swish") — 语音编码器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"、"swish"和"gelu_new"。 - speech_encoder_dropout (
float, 可选，默认为 0.0) — 语音编码器中所有层的 dropout 概率。 - add_adapter (
bool，可选，默认为True) — 在语音编码器之上添加一个适配器层。 - speech_encoder_layerdrop (
float，可选，默认值为 0.1) — 语音编码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](see https://huggingface.co/papers/1909.11556)。 - feature_projection_input_dim (
int, 可选，默认为 160) — 语音编码器输入特征投影的输入维度，即使用 SeamlessM4TFeatureExtractor 处理输入音频后的维度。 - num_conv_pos_embeddings (
int，可选，默认为 128) — 卷积位置嵌入的数量。定义语音编码器中一维卷积位置嵌入层的核大小。 - num_conv_pos_embedding_groups (
int, 可选，默认为 16) — 语音编码器中一维卷积位置嵌入层的组数。 - adaptor_kernel_size (
int, 可选，默认为 8) — 适配器网络中卷积层的卷积核大小。仅当add_adapter is True时相关。 - adaptor_stride (
int，可选，默认为 8) — 适配器网络中卷积层的步长。仅在add_adapter is True时相关。 - adaptor_dropout (
float，可选，默认值为 0.1) — 语音适配器中所有层的 dropout 概率。 - num_adapter_layers (
int，可选，默认为 1) — 适配器网络中应使用的卷积层数量。仅在add_adapter is True时相关。 - position_embeddings_type (
str，可选，默认为"relative") — 可以指定为relative或rotary，分别表示相对位置嵌入或旋转位置嵌入。如果保留为None，则不应用相对位置嵌入。仅应用于语音编码器。 - rotary_embedding_base (
int，可选，默认值为 10000) — 如果使用"rotary"位置嵌入，则定义嵌入基数的大小。仅应用于语音编码器。 - max_source_positions (
int，可选，默认值为 4096) — 如果使用"relative"位置嵌入，则定义源输入的最大位置数。仅应用于语音编码器。 - conv_depthwise_kernel_size (
int，可选，默认值为 31) — Conformer 块中卷积深度 1D 层的卷积核大小。仅应用于语音编码器。 - t2u_bos_token_id (
int, 可选，默认为 0) — 流开始 单元令牌的 id。仅应用于文本到单元的 seq2seq 模型。 - t2u_pad_token_id (
int, 可选，默认为 1) — padding 单元 token 的 id。仅应用于 text-to-unit seq2seq 模型。 - t2u_eos_token_id (
int, 可选，默认为 2) — 流结束 单元令牌的 id。仅应用于文本到单元的 seq2seq 模型。 - t2u_decoder_start_token_id (
int，可选，默认为 2) — 如果编码器-解码器模型使用不同于 bos 的 token 开始解码，则指定该 token 的 id。仅应用于 text-to-unit seq2seq 模型。 - t2u_max_new_tokens (
int，可选，默认值为 1024) — 要生成的最大单元 token 数量，忽略提示词中的 token 数量。仅适用于文本到单元的 seq2seq 模型。 - t2u_encoder_layers (
int, 可选，默认为 6) — Transformer 文本到单元编码器中的隐藏层数。 - t2u_encoder_ffn_dim (
int, 可选，默认为 8192) — Transformer 文本到单元编码器中“中间”（即前馈）层的维度。 - t2u_encoder_attention_heads (
int, 可选，默认为 16) — Transformer 文本到单元编码器中每个注意力层的注意力头数量。 - t2u_decoder_layers (
int, 可选，默认为 6) — Transformer 文本到单元解码器中的隐藏层数量。 - t2u_decoder_ffn_dim (
int，可选，默认值为 8192) — Transformer 文本到单元解码器中“中间”（即前馈）层的维度。 - t2u_decoder_attention_heads (
int, 可选，默认为 16) — Transformer 文本到单元解码器中每个注意力层的注意力头数量。 - t2u_max_position_embeddings (
int，可选，默认值为 2048) — 该模型文本到单元（text-to-unit）组件可能使用的最大序列长度。通常建议将其设置为一个较大的值以防万一（例如 512、1024 或 2048）。 - sampling_rate (
int，可选，默认为16000) — 音频文件应被数字化时的采样率，以赫兹（Hz）为单位。 - upsample_initial_channel (
int，可选，默认值为 512) — hifi-gan 上采样网络的输入通道数。仅适用于声码器。 - upsample_rates (
tuple[int]或list[int]，可选，默认为[5, 4, 4, 2, 2]) — 一个整数元组，用于定义声码器上采样网络中每个一维卷积层的步长。 upsample_rates 的长度定义了卷积层的数量，并且必须与 upsample_kernel_sizes 的长度相匹配。仅适用于声码器。 - upsample_kernel_sizes (
tuple[int]或list[int]，可选，默认为[11, 8, 8, 4, 4]) — 一个整数元组，用于定义声码器上采样网络中每个一维卷积层的卷积核大小。upsample_kernel_sizes 的长度决定了卷积层的数量，并且必须与 upsample_rates 的长度相匹配。仅适用于声码器。 - resblock_kernel_sizes (
tuple[int]或list[int]，可选，默认为[3, 7, 11]) — 一个整数元组，用于定义多感受野融合（MRF）模块中声码器一维卷积层的卷积核大小。仅适用于声码器。 - resblock_dilation_sizes (
tuple[tuple[int]]或list[list[int]]，可选，默认为[[1, 3, 5], [1, 3, 5], [1, 3, 5]]) — 一个嵌套的整数元组，用于定义声码器中多感受野融合（MRF）模块内膨胀一维卷积层的膨胀率。仅适用于声码器。 - leaky_relu_slope (
float, 可选，默认为 0.1) — 声码器中 leaky ReLU 激活函数所使用的负斜率角度。仅适用于声码器。 - unit_hifi_gan_vocab_size (
int, 可选，默认为 10000) — SeamlessM4T 声码器的词表大小。定义了调用 ~SeamlessM4TModel、~SeamlessM4TForSpeechToSpeech 或 ~SeamlessM4TForTextToSpeech 的声码器时，通过传入的inputs_ids所能表示的不同单元 token 的数量。 - unit_embed_dim (
int，可选，默认为 1280) — 提供给 hifi-gan 声码器的输入 id 的投影维度。仅适用于声码器。 - lang_embed_dim (
int，可选，默认为 256) — 提供给 hifi-gan 声码器的目标语言投影维度。仅适用于声码器。 - spkr_embed_dim (
int，可选，默认为 256) — 提供给 hifi-gan 声码器的说话人 ID 的投影维度。仅适用于声码器。 - vocoder_num_langs (
int, 可选，默认为 36) — vocoder 支持的语言数量。可能与t2u_num_langs不同。 - vocoder_num_spkrs (
int, 可选，默认为 200) — 声码器支持的说话人数量。 - variance_predictor_kernel_size (
int，可选，默认为 3) — 时长预测器的卷积核大小。仅适用于声码器。 - var_pred_dropout（
float，可选，默认值为 0.5）—— 时长预测器的 dropout 概率。仅适用于声码器。 - vocoder_offset (
int, 可选，默认为 4) — 将此数值作为偏移量加到单元 token id 上，以处理符号 token。仅适用于声码器。 - tie_word_embeddings (
bool，可选，默认为True) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。
这是用于存储 SeamlessM4TModel 配置的类。它根据指定的参数实例化 Seamless M4T 模型，并定义模型架构。使用默认值实例化配置将得到与 facebook/hf-seamless-m4t-medium 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PreTrainedConfig 的文档。
>>> from transformers import SeamlessM4TModel, SeamlessM4TConfig
>>> # Initializing a SeamlessM4T "facebook/hf-seamless-m4t-medium" style configuration
>>> configuration = SeamlessM4TConfig()
>>> # Initializing a model from the "facebook/hf-seamless-m4t-medium" style configuration
>>> model = SeamlessM4TModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configSeamlessM4TTokenizer
class transformers.SeamlessM4TTokenizer
< source >( vocab: str | dict[str, int] | None = Nonemerges: str | list[str] | None = Nonebos_token = '<s>'eos_token = '</s>'sep_token = '</s>'cls_token = '<s>'unk_token = '<unk>'pad_token = '<pad>'src_lang = 'eng'tgt_lang = 'fra'additional_special_tokens = Nonekeep_accents = Nonevocab_file = None**kwargs )
参数
- vocab (
list或dict，可选) — (token, score) 元组的列表，或从 token 映射到索引的字典。如果未提供，则使用默认词表。 - merges（
str或list，可选）— BPE 模型的合并规则列表。如果未提供，则使用空列表。 - bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列起始标记。也可用作序列分类标记。在构建序列时，如果使用了特殊标记，序列开头使用的并不是这个标记。实际使用的标记是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。在构建包含特殊标记的序列时，序列结束使用的并非此标记，而是 sep_token。在构建包含特殊标记的序列时，序列末尾使用的并不是这个标记。 实际使用的是
sep_token。 - sep_token (
str，可选，默认为"</s>") — 分隔符 token，用于从多个序列构建序列时，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊 token 构建的序列的最后一个 token。 - cls_token (
str，可选，默认为"<s>") — 用于序列分类（对整个序列进行分类，而非逐 token 分类）的分类器 token。当使用特殊 token 构建序列时，它是序列的第一个 token。 - unk_token (
str，可选，默认为"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，因此会被设置为该标记。 - pad_token (
str，可选，默认为"<pad>") — 用于填充的标记，例如在对长度不同的序列进行批处理时。 - src_lang (
str，可选，默认为"eng") — 用于翻译的源语言。 - tgt_lang (
str，可选，默认为"fra") — 用作翻译目标语言的语言。 - additional_special_tokens（
str或tokenizers.AddedToken的元组或列表，可选） — 额外特殊标记的元组或列表。
构建一个 SeamlessM4T 分词器（基于 HuggingFace 的 tokenizers 库）。基于 BPE。
该分词器继承自 TokenizersBackend，其中包含了大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
源语言文档的分词方法为 <language code> <tokens> <eos>，目标语言文档的分词方法为 <eos> <language code> <tokens> <eos>。
示例：
>>> from transformers import SeamlessM4TTokenizer
>>> tokenizer = SeamlessM4TTokenizer.from_pretrained(
... "facebook/hf-seamless-m4t-medium", src_lang="eng", tgt_lang="fra"
... )
>>> example_english_phrase = " UN Chief Says There Is No Military Solution in Syria"
>>> expected_translation_french = "Le chef de l'ONU affirme qu'il n'y a pas de solution militaire en Syrie."
>>> inputs = tokenizer(example_english_phrase, text_target=expected_translation_french, return_tensors="pt")__call__
< source >( text: str | list[str] | list[list[str]] | None = Nonetext_pair: str | list[str] | list[list[str]] | None = Nonetext_target: str | list[str] | list[list[str]] | None = Nonetext_pair_target: str | list[str] | list[list[str]] | None = Nonepadding: bool | str | transformers.utils.generic.PaddingStrategy = Falsepad_to_multiple_of: int | None = Nonesrc_lang: str | None = Nonetgt_lang: str | None = None**kwargs )
参数
- 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, 可选, 默认为False) — 选择一种策略，根据模型的填充侧和填充索引对返回的序列进行填充，可选策略如下：True或'longest'：填充至批次中最长的序列（如果仅提供单个序列，则不进行填充）。'max_length'：填充至由参数max_length指定的最大长度；若未提供该参数，则填充至模型可接受的最大输入长度。False或'do_not_pad'（默认值）：不进行填充（即可以输出包含不同长度序列的批次）。
- pad_to_multiple_of (
int, 可选, 默认为None) — 如果设置，则将序列填充为所提供值的倍数。这在启用 NVIDIA 硬件（计算能力
>= 7.5，即 Volta 架构）上的 Tensor Cores 使用时尤为有用。 - src_lang (
str, 可选) — 表示源语言的字符串。如果未指定，将使用最后一次指定的src_lang（无论是在初始化时还是调用此分词器时指定的）。 - tgt_lang (
str, 可选) — 表示目标语言的字符串。如果未指定，将使用最后一次指定的tgt_lang（无论是在初始化时还是调用此 tokenizer 时）。 - kwargs (可选) — 将传递给 TokenizersBackend.call() 的其余关键字参数字典。
get_special_tokens_mask
< source >( token_ids_0: list[int]token_ids_1: list[int] | None = Nonealready_has_special_tokens: bool = False ) → A list of integers in the range [0, 1]
从未添加特殊标记的标记列表中检索序列 ID。
对于快速分词器，数据整理器会传入 already_has_special_tokens=True 来调用此方法，以在已格式化的序列上构建掩码。在这种情况下，我们通过检查元素是否属于 all_special_ids 来计算掩码。
SeamlessM4TFeatureExtractor
class transformers.SeamlessM4TFeatureExtractor
< source >( feature_size = 80sampling_rate = 16000num_mel_bins = 80padding_value = 0.0stride = 2**kwargs )
参数
- feature_size (
int，可选，默认为 80) — 提取特征的维度。 - sampling_rate (
int，可选，默认为 16000) — 音频文件应被数字化时的采样率，以赫兹 (Hz) 为单位。 - num_mel_bins (
int，可选，默认为 80) — Mel 频率带的数量。 - padding_value (
float，可选，默认为 0.0) — 用于填充 padding 向量的值。 - stride (
int，可选，默认为 2) — 用于将音频从形状 (batch_size,num_frames,num_mel_bins) 重塑为 (batch_size,num_frames//stride,num_mel_bins*stride) 的步长。
构建一个 SeamlessM4T 特征提取器。
此特征提取器继承自 SequenceFeatureExtractor，后者包含了大部分主要方法。用户应参考该父类以获取有关这些方法的更多信息。
此类从原始语音中提取梅尔滤波器组特征。
__call__
< source >( raw_speech: numpy.ndarray | list[float] | list[numpy.ndarray] | list[list[float]]padding: bool | str | transformers.utils.generic.PaddingStrategy = Truepad_to_multiple_of: int | None = 2max_length: int | None = Nonetruncation: bool = Falsereturn_tensors: str | transformers.utils.generic.TensorType | None = Nonesampling_rate: int | None = Nonereturn_attention_mask: bool | None = Nonedo_normalize_per_mel_bins: bool | None = True**kwargs )
参数
- 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, 可选, ，默认为 2）— 如果设置，则将序列填充为所提供值的倍数。这在启用 NVIDIA 硬件（计算能力
>= 7.5，即 Volta 架构）上的 Tensor Cores 使用时尤为有用，或者在 TPU 上使用时也特别有益，因为 TPU 在序列长度为 128 的倍数时性能更佳。 - max_length (
int，可选) — 返回列表的最大长度，以及可选的填充长度（见上文）。 - truncation (
bool) — 启用截断，将长度超过 max_length 的输入序列截断为 max_length。 - return_attention_mask (
bool, 可选) — 是否返回注意力掩码。如果保持默认值，则会根据特定 feature_extractor 的默认设置返回注意力掩码。对于 SeamlessM4T 模型，在进行批量推理时，始终应传入
attention_mask，以避免出现细微的 bug。 - return_tensors (
str或 TensorType, 可选) — 如果设置，将返回张量而不是 Python 整数列表。可接受的值为：'pt'：返回 PyTorchtorch.Tensor对象。'np'：返回 Numpynp.ndarray对象。
- sampling_rate (
int, 可选) —raw_speech输入所使用的采样率。强烈建议在 forward 调用时传入sampling_rate，以避免静默错误。 - do_normalize_per_mel_bins (
bool，可选，默认为True) — 是否对输入按每个 mel 通道进行零均值单位方差归一化。 - kwargs (可选) — 将传递给分词器或特征提取器的其余关键字参数字典。
用于对一条或多条序列进行特征化并准备输入模型的主要方法。
SeamlessM4TProcessor
class transformers.SeamlessM4TProcessor
< source >( feature_extractortokenizer )
构建一个 SeamlessM4TProcessor，它将特征提取器和分词器封装为单个处理器。
SeamlessM4TProcessor 提供了 SeamlessM4TFeatureExtractor 和 SeamlessM4TTokenizer 的所有功能。有关更多信息，请参阅 ~SeamlessM4TFeatureExtractor 和 ~SeamlessM4TTokenizer。
__call__
< source >( text: str | list[str] | list[list[str]] | None = Noneaudio: typing.Union[numpy.ndarray, ForwardRef('torch.Tensor'), collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence['torch.Tensor'], NoneType] = None**kwargs: *<class 'transformers.processing_utils.ProcessingKwargs'> ) → BatchEncoding
参数
- text (
Union[str, list[str], list[list[str]]]，可选) — 要编码的序列或序列批次。每个序列可以是字符串或字符串列表（预分词字符串）。如果传入预分词输入，请设置is_split_into_words=True，以避免与批量输入产生歧义。 - audio (
Union[numpy.ndarray, torch.Tensor, collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence[torch.Tensor]], 可选) — 要准备处理的音频或音频批次。每个音频可以是 NumPy 数组或 PyTorch 张量。 如果为 NumPy 数组/PyTorch 张量，每个音频的形状应为 (C, T)，其中 C 为通道数，T 为音频的采样长度。 - return_tensors (
str或 TensorType, 可选) — 如果设置，将返回特定框架的张量。可接受的值为：'pt'：返回 PyTorchtorch.Tensor对象。'np'：返回 NumPynp.ndarray对象。
- **kwargs (ProcessingKwargs，可选) — 每种模态（文本、图像、视频、音频）的额外处理选项。模型特定参数已在上方列出；有关支持参数的完整列表，请参阅 TypedDict 类。
返回值
一个包含以下字段的 BatchEncoding：
- input_ids — 要输入模型的 token id 列表。当
text不为None时返回。 - attention_mask — 一个索引列表，指定模型应关注哪些 token（当
return_attention_mask=True，或当 “attention_mask” 位于self.model_input_names中且text不为None时）。 - input_features — 输入到模型的音频输入特征。当
audios不为None时返回。
SeamlessM4TCodeHifiGan
class transformers.SeamlessM4TCodeHifiGan
< source >( config: SeamlessM4TConfig )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
按照此仓库中的描述，使用代码实现 HiFi-GAN 声码器。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: LongTensorspkr_id: Tensorlang_id: Tensor**kwargs )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列中各 token 在词汇表中的索引。可以使用 SeamlessM4TTextToUnitForConditionalGeneration 获取索引。什么是输入 ID？
- spkr_id (
int, 可选) — 用于语音合成的说话人 ID。必须小于config.vocoder_num_spkrs。 - tgt_lang (
str, 可选) — 用于翻译的目标语言 ID。
SeamlessM4THifiGan
forward
< source >( inputs_embeds: Tensor ) → torch.Tensor
参数
- spectrogram (
torch.Tensor) — 包含对数梅尔频谱图的张量。可以是批处理形式，形状为(batch_size, sequence_length, model_in_dim)，也可以是非批处理形式，形状为(sequence_length, model_in_dim)。请注意，model_in_dim是config.unit_embed_dim、config.lang_embed_dim和config.spkr_embed_dim的总和。
返回值
torch.Tensor
包含语音波形的张量。如果输入频谱图是批处理的，其形状为 (batch_size, num_frames,)。如果未进行批处理，其形状为 (num_frames,)。
将 log-mel 频谱图转换为语音波形。传入一批 log-mel 频谱图将返回一批语音波形。传入单个未批处理的 log-mel 频谱图将返回单个未批处理的语音波形。
SeamlessM4TTextToUnitModel
class transformers.SeamlessM4TTextToUnitModel
< source >( config: SeamlessM4TConfigembed_tokens_decoder: typing.Optional[torch.nn.Embedding] = None )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
- embed_tokens_decoder (
nn.Embedding，可选) — 解码器的输入嵌入。
Transformer 裸文本到单元编码器-解码器。编码器是一个不带嵌入的 SeamlessM4TEncoder，解码器是一个 SeamlessM4TDecoder。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: tuple[tuple[torch.Tensor]] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonedecoder_inputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → Seq2SeqModelOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), ，可选) — 输入序列中各 token 在词汇表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), ，可选) — 解码器输入序列中各 token 在词汇表中的索引。可通过 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。什么是解码器输入 ID？可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- decoder_attention_mask（形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选） — 用于避免对特定 token 索引执行注意力的掩码。默认情况下，会使用因果掩码，以确保模型只能查看之前的输入来预测未来。 - encoder_outputs (
tuple[tuple[torch.Tensor]]，可选) — 元组由 (last_hidden_state，可选：hidden_states，可选：attentions) 组成last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由past_key_values在解码的先前阶段返回，当use_cache=True或config.use_cache=True.仅允许将 Cache 实例作为输入，请参阅我们的 kv cache 指南。 如果未传入
past_key_values，则默认会初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未向该模型提供其过去键值状态的那些），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部input_ids。 - inputs_embeds（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选） — 可选地，您可以选择直接传入嵌入表示，而不是传入input_ids。如果您希望对input_ids索引如何转换为相应向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - decoder_inputs_embeds (
torch.Tensor形状为(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的值。 - use_cache (
bool，可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回值
Seq2SeqModelOutput 或 tuple(torch.Tensor)
一个 Seq2SeqModelOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（SeamlessM4TConfig）和输入。
SeamlessM4TTextToUnitModel 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
last_hidden_state（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor）— 模型解码器最后一层输出的隐藏状态序列。如果使用了
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。past_key_values（
EncoderDecoderCache，可选，在传入use_cache=True或config.use_cache=True时返回）—— 它是一个 EncoderDecoderCache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
decoder_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
cross_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层在注意力 softmax 之后的注意力权重，用于在交叉注意力头中计算加权平均值。
encoder_last_hidden_state（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选）— 模型编码器最后一层输出的隐藏状态序列。encoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。编码器每层输出处的隐藏状态，以及可选的初始嵌入输出。
encoder_attentions（
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回）—— 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
SeamlessM4TTextToUnitForConditionalGeneration
类 transformers.SeamlessM4TTextToUnitForConditionalGeneration
< source >( config: SeamlessM4TConfigembed_tokens_decoder: typing.Optional[torch.nn.Embedding] = None )
参数
- config (SeamlessM4TConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
- embed_tokens_decoder (
nn.Embedding，可选) — 解码器的输入嵌入。
带有语言模型头的 Transformer 文本到单元编码器-解码器。基础编码器-解码器模型是 SeamlessM4TTextToUnit。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.LongTensor] = Noneencoder_outputs: tuple[tuple[torch.Tensor]] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonedecoder_inputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → Seq2SeqLMOutput or tuple(torch.Tensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length), ，可选) — 输入序列中各 token 在词汇表中的索引。默认情况下，填充（padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- decoder_input_ids (
torch.LongTensor形状为(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 向右移位以创建该张量，用于去噪预训练。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
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.Tensor]]，可选) — 元组由 (last_hidden_state，可选：hidden_states，可选：attentions) 组成last_hidden_state的形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由past_key_values在解码的先前阶段返回，当use_cache=True或config.use_cache=True.仅允许将 Cache 实例作为输入，请参阅我们的 kv cache 指南。 如果未传入
past_key_values，则默认会初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未向该模型提供其过去键值状态的那些），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部input_ids。 - inputs_embeds (
torch.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，除了传递input_ids之外，您还可以选择直接传递嵌入表示。如果您希望对input_ids索引如何转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选)： 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids的文档字符串）。索引设置为-100的 token 将被忽略（即被掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的 token 进行计算。 - decoder_inputs_embeds (
torch.Tensor形状为(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)，可选) — 用于计算掩码语言建模损失的标签。索引值应在[0, ..., config.vocab_size]范围内，或为 -100（参见input_ids的文档字符串）。索引值设为-100的 token 将被忽略（即被掩码），损失仅针对标签位于[0, ..., config.vocab_size]范围内的 token 进行计算。 - use_cache (
bool，可选) — 如果设置为True，则会返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回值
Seq2SeqLMOutput 或 tuple(torch.Tensor)
一个 Seq2SeqLMOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（SeamlessM4TConfig）和输入。
SeamlessM4TTextToUnitForConditionalGeneration 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为
(1,)的torch.Tensor，可选，在提供labels时返回）— 语言建模损失。logits（形状为
(batch_size, sequence_length, config.vocab_size)的torch.Tensor）— 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。past_key_values（
EncoderDecoderCache，可选，在传入use_cache=True或config.use_cache=True时返回）—— 它是一个 EncoderDecoderCache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。decoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出处的隐藏状态，以及初始嵌入输出。
decoder_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。
cross_attentions (
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层在注意力 softmax 之后的注意力权重，用于在交叉注意力头中计算加权平均值。
encoder_last_hidden_state（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选）— 模型编码器最后一层输出的隐藏状态序列。encoder_hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层输出的一个张量，以及每个层输出的一个张量），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出处的隐藏状态，以及初始嵌入输出。
encoder_attentions（
tuple(torch.Tensor)，可选，在传入output_attentions=True或config.output_attentions=True时返回）—— 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器在注意力 softmax 之后的注意力权重，用于在自注意力头中计算加权平均值。