Speech2Text2

此模型仅处于维护模式，我们不接受任何更改其代码的新 PR。如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令来执行此操作：pip install -U transformers==4.40.2。

概述

Speech2Text2 模型与 Wav2Vec2 一起用于语音翻译模型，这些模型在 Large-Scale Self- and Semi-Supervised Learning for Speech Translation 中提出，作者是 Changhan Wang、Anne Wu、Juan Pino、Alexei Baevski、Michael Auli、Alexis Conneau。

Speech2Text2 是一个仅解码器 Transformer 模型，可以与任何语音仅编码器模型（例如 Wav2Vec2 或 HuBERT）一起用于语音到文本任务。请参阅 SpeechEncoderDecoder 类，了解如何将 Speech2Text2 与任何语音仅编码器模型结合使用。

此模型由 Patrick von Platen 贡献。

原始代码可以在这里找到。

使用技巧

Speech2Text2 在 CoVoST 语音翻译数据集上取得了最先进的结果。有关更多信息，请参阅官方模型。
Speech2Text2 始终在 SpeechEncoderDecoder 框架内使用。
Speech2Text2 的分词器基于 fastBPE。

推理

Speech2Text2 的 SpeechEncoderDecoderModel 模型接受来自语音的原始波形输入值，并使用 generate() 将输入语音自回归地翻译成目标语言。

Wav2Vec2FeatureExtractor 类负责预处理输入语音，Speech2Text2Tokenizer 将生成的目标 tokens 解码为目标字符串。Speech2Text2Processor 将 Wav2Vec2FeatureExtractor 和 Speech2Text2Tokenizer 包装到一个实例中，以同时提取输入特征并解码预测的 token IDs。

逐步语音翻译

>>> import torch
>>> from transformers import Speech2Text2Processor, SpeechEncoderDecoderModel
>>> from datasets import load_dataset
>>> import soundfile as sf

>>> model = SpeechEncoderDecoderModel.from_pretrained("facebook/s2t-wav2vec2-large-en-de")
>>> processor = Speech2Text2Processor.from_pretrained("facebook/s2t-wav2vec2-large-en-de")


>>> def map_to_array(batch):
...     speech, _ = sf.read(batch["file"])
...     batch["speech"] = speech
...     return batch


>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> ds = ds.map(map_to_array)

>>> inputs = processor(ds["speech"][0], sampling_rate=16_000, return_tensors="pt")
>>> generated_ids = model.generate(inputs=inputs["input_values"], attention_mask=inputs["attention_mask"])

>>> transcription = processor.batch_decode(generated_ids)

通过 Pipelines 进行语音翻译

自动语音识别 pipeline 也可用于翻译语音，只需几行代码

>>> from datasets import load_dataset
>>> from transformers import pipeline

>>> librispeech_en = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> asr = pipeline(
...     "automatic-speech-recognition",
...     model="facebook/s2t-wav2vec2-large-en-de",
...     feature_extractor="facebook/s2t-wav2vec2-large-en-de",
... )

>>> translation_de = asr(librispeech_en[0]["file"])

请参阅模型中心以查找 Speech2Text2 checkpoints。

资源

因果语言建模任务指南

Speech2Text2Config

class transformers.Speech2Text2Config

< source >

( vocab_size = 10000 decoder_layers = 6 decoder_ffn_dim = 2048 decoder_attention_heads = 4 decoder_layerdrop = 0.0 use_cache = True activation_function = 'relu' d_model = 256 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 decoder_start_token_id = 2 scale_embedding = True pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 max_target_positions = 1024 **kwargs )

参数

vocab_size (int, 可选, 默认为 50265) — Speech2Text 模型的词汇表大小。定义了在调用 Speech2TextModel 时传递的 inputs_ids 可以表示的不同 tokens 的数量
d_model (int, 可选, 默认为 1024) — 层和池化器层的维度。
decoder_layers (int, 可选, 默认为 12) — 解码器层数。
decoder_attention_heads (int, 可选, 默认为 16) — Transformer 解码器中每个注意力层的注意力头数。
decoder_ffn_dim (int, 可选, 默认为 4096) — 解码器中“中间”（通常称为前馈）层的维度。
activation_function (str 或 function, 可选, 默认为 "gelu") — 池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu", "relu", "silu" 和 "gelu_new" 。
dropout (float, 可选, 默认为 0.1) — 嵌入层和池化器中所有全连接层的 dropout 概率。
attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。
activation_dropout (float, 可选, 默认为 0.0) — 全连接层内部激活的 dropout 比率。
init_std (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。更多详情请参考 https://arxiv.org/abs/1909.11556>`__。
decoder_layerdrop (float, 可选, 默认为 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。
use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后的键/值注意力机制（并非所有模型都使用）。
max_target_positions (int, 可选, 默认为 1024) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。

这是用于存储 Speech2Text2ForCausalLM 配置的配置类。它用于根据指定的参数实例化 Speech2Text2 模型，定义模型架构。使用默认值实例化配置将产生与 Speech2Text2 facebook/s2t-wav2vec2-large-en-de 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。

示例

>>> from transformers import Speech2Text2Config, Speech2Text2ForCausalLM

>>> # Initializing a Speech2Text2 s2t_transformer_s style configuration
>>> configuration = Speech2Text2Config()

>>> # Initializing a model (with random weights) from the s2t_transformer_s style configuration
>>> model = Speech2Text2ForCausalLM(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

Speech2TextTokenizer

class transformers.Speech2Text2Tokenizer

< source >

( vocab_file bos_token = '<s>' pad_token = '<pad>' eos_token = '</s>' unk_token = '<unk>' do_lower_case = False merges_file = None **kwargs )

参数

vocab_file (str) — 包含词汇表的文件。
bos_token (str, 可选, 默认为 "<s>") — 句子开始 token。
eos_token (str, 可选, 默认为 "</s>") — 句子结束 token。
unk_token (str, 可选, 默认为 "<unk>") — 未知 token。词汇表中不存在的 token 无法转换为 ID，而是设置为此 token。
pad_token (str, 可选, 默认为 "<pad>") — 用于填充的 token，例如在对不同长度的序列进行批处理时。
**kwargs — 传递给 PreTrainedTokenizer 的附加关键字参数

构建 Speech2Text2Tokenizer。

此 tokenizer 继承自 PreTrainedTokenizer，其中包含一些主要方法。用户应参考超类以获取有关此类方法的更多信息。

batch_decode

< source >

( sequences: typing.Union[typing.List[int], typing.List[typing.List[int]], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), ForwardRef('tf.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: bool = None **kwargs ) → List[str]

参数

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

List[str]

解码后的句子列表。

通过调用 decode 将 token id 列表转换为字符串列表。

decode

< source >

( token_ids: typing.Union[int, typing.List[int], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), ForwardRef('tf.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: bool = None **kwargs ) → str

参数

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

str

解码后的句子。

使用 tokenizer 和词汇表将 id 序列转换为字符串，并可以选择删除特殊 token 和清理 token 化空格。

类似于执行 self.convert_tokens_to_string(self.convert_ids_to_tokens(token_ids))。

save_vocabulary

< source >

( save_directory: str filename_prefix: typing.Optional[str] = None )

Speech2Text2Processor

class transformers.Speech2Text2Processor

< source >

( feature_extractor tokenizer )

参数

feature_extractor (AutoFeatureExtractor) — AutoFeatureExtractor 的一个实例。特征提取器是必需的输入。
tokenizer (Speech2Text2Tokenizer) — Speech2Text2Tokenizer 的一个实例。分词器是必需的输入。

构建一个 Speech2Text2 处理器，它将 Speech2Text2 特征提取器和 Speech2Text2 分词器包装成一个单独的处理器。

Speech2Text2Processor 提供了 AutoFeatureExtractor 和 Speech2Text2Tokenizer 的所有功能。有关更多信息，请参阅 call() 和 decode()。

call

< source >

( *args **kwargs )

在正常模式下使用时，此方法将其所有参数转发到 AutoFeatureExtractor 的 __call__() 并返回其输出。如果在 as_target_processor() 上下文中使用，此方法将其所有参数转发到 Speech2Text2Tokenizer 的 call()。有关更多信息，请参阅上述两种方法的文档字符串。

from_pretrained

< source >

( pretrained_model_name_or_path: typing.Union[str, os.PathLike] cache_dir: typing.Union[str, os.PathLike, NoneType] = None force_download: bool = False local_files_only: bool = False token: typing.Union[str, bool, NoneType] = None revision: str = 'main' **kwargs )

参数

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

实例化与预训练模型关联的处理器。

这个类方法只是调用特征提取器 from_pretrained()、图像处理器 ImageProcessingMixin 和分词器 ~tokenization_utils_base.PreTrainedTokenizer.from_pretrained 方法。有关更多信息，请参阅上述方法的文档字符串。

save_pretrained

< source >

( save_directory push_to_hub: bool = False **kwargs )

参数

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

将此处理器（特征提取器、分词器…）的属性保存在指定目录中，以便可以使用 from_pretrained() 方法重新加载它。

这个类方法只是调用 save_pretrained() 和 save_pretrained()。有关更多信息，请参阅上述方法的文档字符串。

batch_decode

< source >

( *args **kwargs )

此方法将其所有参数转发到 Speech2Text2Tokenizer 的 batch_decode()。有关更多信息，请参阅此方法的文档字符串。

decode

< source >

( *args **kwargs )

此方法将其所有参数转发到 Speech2Text2Tokenizer 的 decode()。有关更多信息，请参阅此方法的文档字符串。

Speech2Text2ForCausalLM

class transformers.Speech2Text2ForCausalLM

< source >

( config )

参数

config (Speech2Text2Config) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

带有语言建模头的 Speech2Text2 解码器。可以用作 EncoderDecoderModel 和 SpeechEncoderDecoder 的解码器部分。此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。

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

什么是输入 ID？
attention_mask (torch.Tensor，形状为 (batch_size, sequence_length), 可选) — 掩码，以避免对填充标记索引执行注意力机制。掩码值在 [0, 1] 中选择：
- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
什么是注意力掩码？
encoder_hidden_states (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力机制中使用。
encoder_attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在编码器输入的填充标记索引上执行注意力机制的掩码。如果模型配置为解码器，则此掩码在交叉注意力机制中使用。掩码值选自 [0, 1]：
head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于 nullify （置零）注意力模块中选定 head 的掩码。掩码值选自 [0, 1]：
- 1 表示 head 不被掩蔽，
- 0 表示 head 被掩蔽。
cross_attn_head_mask (torch.Tensor，形状为 (decoder_layers, decoder_attention_heads)，可选) — 用于 nullify （置零）交叉注意力模块中选定 head 的掩码。掩码值选自 [0, 1]：
- 1 表示 head 不被掩蔽，
- 0 表示 head 被掩蔽。
past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。仅当模型在序列到序列模型中用作解码器时，才需要这两个额外的张量。

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

如果使用 past_key_values，用户可以选择仅输入最后一部分 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的输入），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应为 [0, ..., config.vocab_size] 或 -100（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩蔽），损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
- 1 表示标记不被掩蔽，
- 0 表示标记被掩蔽。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (Speech2Text2Config) 和输入。

loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个标记预测）。
logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表标记的分数）。
hidden_states (tuple(torch.FloatTensor)，可选，当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（如果模型具有嵌入层，则为嵌入输出，+ 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 之后的注意力权重，用于计算自注意力 head 中的加权平均值。
cross_attentions (tuple(torch.FloatTensor)，可选，当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

交叉注意力 softmax 之后的注意力权重，用于计算交叉注意力 head 中的加权平均值。
past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — torch.FloatTensor 元组的元组，长度为 config.n_layers，每个元组包含自注意力和交叉注意力层的缓存键、值状态（如果模型在编码器-解码器设置中使用）。仅当 config.is_decoder = True 时相关。

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

示例

>>> from transformers import (
...     SpeechEncoderDecoderModel,
...     Speech2Text2ForCausalLM,
...     Wav2Vec2Model,
...     Speech2Text2Config,
...     Wav2Vec2Config,
...     Wav2Vec2FeatureExtractor,
...     Speech2Text2Tokenizer,
... )
>>> from datasets import load_dataset

>>> feature_extractor = Wav2Vec2FeatureExtractor()
>>> tokenizer = Speech2Text2Tokenizer.from_pretrained("facebook/s2t-wav2vec2-large-en-de")

>>> encoder = Wav2Vec2Model(Wav2Vec2Config())
>>> decoder = Speech2Text2ForCausalLM(Speech2Text2Config())
>>> # init random speech2text model

>>> model = SpeechEncoderDecoderModel(encoder=encoder, decoder=decoder)
>>> model.config.pad_token_id = tokenizer.pad_token_id
>>> model.config.decoder_start_token_id = tokenizer.bos_token_id
>>> # pre-process inputs and labels

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> inputs = feature_extractor(
...     ds[0]["audio"]["array"], sampling_rate=ds[0]["audio"]["sampling_rate"], return_tensors="pt"
... )
>>> input_values = inputs.input_values
>>> decoder_input_ids = tokenizer(ds[0]["text"], return_tensors="pt").input_ids
>>> # compute loss

>>> loss = model(inputs=input_values, labels=decoder_input_ids).loss
>>> # backprop loss

>>> loss.backward()

< > 在 GitHub 上更新

Transformers

Speech2Text2

概述

使用技巧

推理

资源

Speech2Text2Config

class transformers.Speech2Text2Config

Speech2TextTokenizer

class transformers.Speech2Text2Tokenizer

batch_decode

decode

save_vocabulary

Speech2Text2Processor

class transformers.Speech2Text2Processor

__call__

from_pretrained

save_pretrained

batch_decode

decode

Speech2Text2ForCausalLM

class transformers.Speech2Text2ForCausalLM

forward

call