Transformers 文档
Speech2Text2
并获得增强的文档体验
开始使用
Speech2Text2
此模型仅处于维护模式，我们不接受任何更改其代码的新 PR。如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令进行安装：pip install -U transformers==4.40.2。
概述
Speech2Text2 模型与 Wav2Vec2 一起用于 Changhan Wang、Anne Wu、Juan Pino、Alexei Baevski、Michael Auli 和 Alexis Conneau 在 大规模自监督和半监督语音翻译学习 中提出的语音翻译模型。
Speech2Text2 是一个*仅解码器*转换器模型，可与任何*仅编码器*的语音模型（例如 Wav2Vec2 或 HuBERT）一起用于语音到文本任务。有关如何将 Speech2Text2 与任何*仅编码器*的语音模型结合使用的信息，请参阅 SpeechEncoderDecoder 类。
此模型由 Patrick von Platen 贡献。
原始代码可在此处找到。
使用技巧
- Speech2Text2 在 CoVoST 语音翻译数据集上取得了最先进的结果。有关更多信息，请参阅官方模型。
- Speech2Text2 始终在 SpeechEncoderDecoder 框架内使用。
- Speech2Text2 的分词器基于 fastBPE。
推理
Speech2Text2 的 SpeechEncoderDecoderModel 模型接受来自语音的原始波形输入值，并使用 generate() 自动回归地将输入语音翻译成目标语言。
Wav2Vec2FeatureExtractor 类负责预处理输入语音，而 Speech2Text2Tokenizer 将生成的语言标记解码为目标字符串。Speech2Text2Processor 将 Wav2Vec2FeatureExtractor 和 Speech2Text2Tokenizer 封装成一个实例，以便同时提取输入特征并解码预测的标记 ID。
- 语音翻译分步指南
>>> 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)通过管道进行语音翻译
自动语音识别管道也可以仅用几行代码进行语音翻译
>>> 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 检查点。
资源
Speech2Text2Config
类 transformers.Speech2Text2Config
< 源 >( 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可以表示的不同标记的数量。 - 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) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。https://huggingface.co/papers/1909.11556>`__ 了解更多详情。 - decoder_layerdrop (
float, 可选, 默认值为 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文]（参阅 https://huggingface.co/papers/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.configSpeech2Text 分词器
类 transformers.Speech2Text2Tokenizer
< 源 >( 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>") — 句子起始标记。 - eos_token (
str, 可选, 默认值为"</s>") — 句子结束标记。 - unk_token (
str, 可选, 默认值为"<unk>") — 未知标记。不在词汇表中的标记不能转换为 ID，而是设置为此标记。 - pad_token (
str, 可选, 默认值为"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - **kwargs — 传递给 PreTrainedTokenizer 的其他关键字参数。
构造 Speech2Text2Tokenizer。
此分词器继承自 PreTrainedTokenizer，其中包含一些主要方法。用户应参阅超类以获取有关此类方法的更多信息。
batch_decode
< 源 >( sequences: typing.Union[list[int], list[list[int]], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), ForwardRef('tf.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: typing.Optional[bool] = None **kwargs ) → list[str]
参数
- sequences (
Union[list[int], list[list[int]], np.ndarray, torch.Tensor, tf.Tensor]) — 标记化输入 ID 列表。可以使用__call__方法获取。 - skip_special_tokens (
bool, 可选, 默认值为False) — 是否在解码中移除特殊标记。 - clean_up_tokenization_spaces (
bool, 可选) — 是否清理分词空间。如果为None，将默认为self.clean_up_tokenization_spaces。 - kwargs (附加关键字参数，可选) — 将传递给底层模型特定解码方法。
返回
list[str]
解码后的句子列表。
通过调用 decode 将标记 ID 列表的列表转换为字符串列表。
解码
< 源 >( token_ids: typing.Union[int, list[int], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), ForwardRef('tf.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: typing.Optional[bool] = None **kwargs ) → str
参数
- token_ids (
Union[int, list[int], np.ndarray, torch.Tensor, tf.Tensor]) — 标记化输入 ID 列表。可以使用__call__方法获取。 - skip_special_tokens (
bool, 可选, 默认值为False) — 是否在解码中移除特殊标记。 - clean_up_tokenization_spaces (
bool, 可选) — 是否清理分词空间。如果为None，将默认为self.clean_up_tokenization_spaces。 - kwargs (附加关键字参数，可选) — 将传递给底层模型特定解码方法。
返回
字符串
解码后的句子。
使用分词器和词汇表将 ID 序列转换为字符串，可以选择移除特殊标记并清理分词空间。
类似于执行 self.convert_tokens_to_string(self.convert_ids_to_tokens(token_ids))。
Speech2Text2处理器
类 transformers.Speech2Text2Processor
< 源 >( feature_extractor tokenizer )
参数
- feature_extractor (
AutoFeatureExtractor) — AutoFeatureExtractor 实例。特征提取器是必需输入。 - tokenizer (
Speech2Text2Tokenizer) — Speech2Text2Tokenizer 实例。分词器是必需输入。
构建 Speech2Text2 处理器，它将 Speech2Text2 特征提取器和 Speech2Text2 分词器封装到一个处理器中。
Speech2Text2Processor 提供 AutoFeatureExtractor 和 Speech2Text2Tokenizer 的所有功能。有关更多信息，请参阅 call() 和 decode()。
在正常模式下使用时，此方法将所有参数转发到 AutoFeatureExtractor 的 __call__() 并返回其输出。如果在 as_target_processor() 上下文中使用，此方法会将所有参数转发到 Speech2Text2Tokenizer 的 call()。有关更多信息，请参阅上述两种方法的文档字符串。
from_pretrained
< 源 >( 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()。更多信息请参考上述方法的文档字符串。
此方法将其所有参数转发给 Speech2Text2Tokenizer 的 batch_decode()。有关详细信息，请参阅此方法的文档字符串。
此方法将其所有参数转发给 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[tuple[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)) — 词汇表中输入序列 token 的索引。如果提供了填充，默认情况下将被忽略。索引可以使用 Speech2Text2Tokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 遮罩，用于避免在填充 token 索引上执行注意力。遮罩值在[0, 1]中选择：- 1 表示 token 未被遮罩，
- 0 表示 token 被遮罩。
- encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 遮罩，用于避免在编码器输入填充 token 索引上执行注意力。如果模型被配置为解码器，则此遮罩用于交叉注意力。遮罩值在[0, 1]中选择： - head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 遮罩，用于将注意力模块中选定的头部置空。遮罩值在[0, 1]中选择：- 1 表示头部未被遮罩，
- 0 表示头部被遮罩。
- cross_attn_head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 遮罩，用于将交叉注意力模块中选定的头部置空。遮罩值在[0, 1]中选择：- 1 表示头部未被遮罩，
- 0 表示头部被遮罩。
- 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)，而不是所有decoder_input_ids形状为(batch_size, sequence_length)。 - 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）。- 1 表示 token 未被遮罩，
- 0 表示 token 被遮罩。
- 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时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache，可选，当传递use_cache=True或config.use_cache=True时返回) — 它是 Cache 实例。有关更多详细信息，请参阅我们的 kv cache 指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
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()