Transformers 4.37 中文文档（七十七）（2）

Transformers 4.37 中文文档（七十七）（1）https://developer.aliyun.com/article/1564183

SeamlessM4Tv2ForSpeechToText

class transformers.SeamlessM4Tv2ForSpeechToText

<来源>

( config: SeamlessM4Tv2Config )

参数

• config（~SeamlessM4Tv2Config）- 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。

可用于 S2TT 的语音到文本 SeamlessM4Tv2 模型变压器。此模型是 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有相关信息。

forward

<来源>

( input_features: LongTensor = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None **kwargs )

参数

• input_features（形状为(batch_size, sequence_length, num_banks)的torch.FloatTensor）- 输入音频特征。这应该由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。有关详细信息，请参阅 SeamlessM4TFeatureExtractor.call()。
  
• attention_mask（形状为(batch_size, sequence_length)的torch.FloatTensor，可选）- 用于避免在填充标记索引上执行注意力的掩码。掩码值选在[0, 1]：

• 1 表示未被掩码的标记，
  
• 0 表示被掩码的标记。
  

• 什么是注意力掩码？
  
• decoder_input_ids（形状为(batch_size, target_sequence_length)的torch.LongTensor，可选）- 词汇表中解码器输入序列标记的索引。
  可以使用 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（形状为(batch_size, target_sequence_length)的torch.LongTensor，可选）- 默认行为：生成一个忽略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的元组，每个元组有 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。
  
• inputs_embeds（形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选）- 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望更好地控制如何将input_ids索引转换为相关向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
  
• decoder_inputs_embeds（形状为(batch_size, target_sequence_length, hidden_size)的torch.FloatTensor，可选）- 可选地，您可以选择直接传递嵌入表示，而不是传递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（形状为(batch_size, sequence_length)的torch.LongTensor，可选）- 用于计算掩码语言建模损失的标签。索引应在[-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 而不是普通元组。
  

SeamlessM4Tv2ForSpeechToText 的前向方法覆盖了__call__特殊方法。

虽然前向传递的配方需要在此函数内定义，但应该在此之后调用Module实例，而不是在此处调用，因为前者会负责运行前处理和后处理步骤，而后者会默默地忽略它们。

generate

<来源>

( input_features = None tgt_lang = None generation_config = None logits_processor = None stopping_criteria = None prefix_allowed_tokens_fn = None synced_gpus = False **kwargs ) → export const metadata = 'undefined';ModelOutput or torch.LongTensor

参数

• input_features（形状为(batch_size, sequence_length, num_banks)的torch.FloatTensor）- 输入音频特征。这应该由 SeamlessM4TFeatureExtractor 类或 SeamlessM4TProcessor 类返回。有关详细信息，请参阅 SeamlessM4TFeatureExtractor.call()。
  
• tgt_lang（str，可选）- 用作翻译目标语言的语言。
  
• generation_config（~generation.GenerationConfig，可选）- 用作生成调用的基本参数化的生成配置。传递给生成匹配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]]，可选）—如果提供，此函数将在每个步骤将束搜索限制为仅允许的令牌。如果未提供，则不应用约束。此函数接受 2 个参数：批次 IDbatch_id和input_ids。它必须返回一个列表，其中包含下一代步骤的允许令牌，条件是批次 IDbatch_id和先前生成的令牌inputs_ids。此参数对于基于前缀的约束生成非常有用，如自回归实体检索中所述。
  
• synced_gpus（bool，可选，默认为False）—是否继续运行 while 循环直到 max_length（需要 ZeRO 阶段 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.FloatTensor。可能的 ModelOutput 类型为：

• GenerateEncoderDecoderOutput
  
• GenerateBeamEncoderDecoderOutput
  

生成令牌 id 序列。

大多数生成控制参数都在generation_config中设置，如果未传递，则将设置为模型的默认生成配置。您可以通过将相应的参数传递给 generate()来覆盖任何generation_config，例如.generate(inputs, num_beams=4, do_sample=True)。

有关生成策略和代码示例的概述，请查看以下指南。

SeamlessM4Tv2Config

class transformers.SeamlessM4Tv2Config

<来源>

( vocab_size = 256102 t2u_vocab_size = 10082 char_vocab_size = 10943 hidden_size = 1024 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True max_position_embeddings = 4096 is_encoder_decoder = True encoder_layerdrop = 0.05 decoder_layerdrop = 0.05 activation_function = 'relu' dropout = 0.1 attention_dropout = 0.1 activation_dropout = 0.0 scale_embedding = True encoder_layers = 24 encoder_ffn_dim = 8192 encoder_attention_heads = 16 decoder_layers = 24 decoder_ffn_dim = 8192 decoder_attention_heads = 16 decoder_start_token_id = 3 max_new_tokens = 256 pad_token_id = 0 bos_token_id = 2 eos_token_id = 3 speech_encoder_layers = 24 speech_encoder_attention_heads = 16 speech_encoder_intermediate_size = 4096 speech_encoder_hidden_act = 'swish' speech_encoder_dropout = 0.0 add_adapter = True speech_encoder_layerdrop = 0.1 feature_projection_input_dim = 160 adaptor_kernel_size = 8 adaptor_stride = 8 adaptor_dropout = 0.1 num_adapter_layers = 1 position_embeddings_type = 'relative_key' conv_depthwise_kernel_size = 31 left_max_position_embeddings = 64 right_max_position_embeddings = 8 speech_encoder_chunk_size = 20000 speech_encoder_left_chunk_num = 128 t2u_bos_token_id = 0 t2u_pad_token_id = 1 t2u_eos_token_id = 2 t2u_encoder_layers = 6 t2u_encoder_ffn_dim = 8192 t2u_encoder_attention_heads = 16 t2u_decoder_layers = 6 t2u_decoder_ffn_dim = 8192 t2u_decoder_attention_heads = 16 t2u_max_position_embeddings = 4096 t2u_variance_predictor_embed_dim = 1024 t2u_variance_predictor_hidden_dim = 256 t2u_variance_predictor_kernel_size = 3 t2u_variance_pred_dropout = 0.5 sampling_rate = 16000 upsample_initial_channel = 512 upsample_rates = [5, 4, 4, 2, 2] upsample_kernel_sizes = [11, 8, 8, 4, 4] resblock_kernel_sizes = [3, 7, 11] resblock_dilation_sizes = [[1, 3, 5], [1, 3, 5], [1, 3, 5]] leaky_relu_slope = 0.1 unit_hifi_gan_vocab_size = 10000 unit_embed_dim = 1280 lang_embed_dim = 256 spkr_embed_dim = 256 vocoder_num_langs = 36 vocoder_num_spkrs = 200 variance_predictor_kernel_size = 3 var_pred_dropout = 0.5 vocoder_offset = 4 **kwargs )

参数

• vocab_size（int，可选，默认为 256102）—SeamlessM4Tv2 模型文本模态的词汇大小。定义了在调用_{SeamlessM4Tv2Model、}SeamlessM4Tv2ForTextToSpeech 或~SeamlessM4Tv2ForTextToText 时传递的不同令牌数量。inputs_ids。
  
• t2u_vocab_size (int, optional, 默认为 10082) — SeamlessM4Tv2 模型的单元词汇量。定义了在调用~SeamlessM4Tv2Model 的 Text-To-Units 子模型时可以表示的不同“单元标记”的数量。
  
• char_vocab_size (int, optional, 默认为 10943) — SeamlessM4Tv2 模型的字符词汇量。定义了在调用~SeamlessM4Tv2Model 的 Text-To-Units 子模型时可以表示的不同字符标记的数量。
  

在子模型之间共享的参数

• hidden_size (int, optional, 默认为 1024) — 架构中“中间”层的维度。
  
• initializer_range (float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  
• layer_norm_eps (float, optional, 默认为 1e-05) — 层归一化层使用的 epsilon。
  
• use_cache (bool, optional, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。
  
• max_position_embeddings (int, optional, 默认为 4096) — 此模型文本编码器和解码器可能会使用的最大序列长度。通常将其设置为较大的值以防万一（例如 512、1024 或 2048）。
  
• is_encoder_decoder (bool, optional, 默认为True) — 模型是否用作编码器/解码器。
  
• encoder_layerdrop (float, optional, 默认为 0.05) — 编码器的 LayerDrop 概率。有关更多详细信息，请参阅 LayerDrop 论文)。
  
• decoder_layerdrop (float, optional, 默认为 0.05) — 解码器的 LayerDrop 概率。有关更多详细信息，请参阅 LayerDrop 论文)。
  
• activation_function (str或function, optional, 默认为"relu") — 解码器和前馈层中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"selu"、"swish"和"gelu_new"。
  
• dropout (float, optional, 默认为 0.1) — 嵌入层、编码器、解码器和池化器中所有全连接层的 dropout 概率。
  
• attention_dropout (float, optional, 默认为 0.1) — 所有注意力层的 dropout 概率。
  
• activation_dropout (float, optional, 默认为 0.0) — 模型中所有激活层的 dropout 概率。
  
• scale_embedding (bool, optional, 默认为True) — 通过将 d_model 开方来缩放嵌入。
  

文本编码器和文本解码器特定参数

• encoder_layers (int, optional, 默认为 24) — Transformer 文本编码器中的隐藏层数。
  
• encoder_ffn_dim (int, optional, 默认为 8192) — Transformer 文本编码器中“中间”（即前馈）层的维度。
  
• encoder_attention_heads (int, optional, 默认为 16) — Transformer 文本编码器中每个注意力层的注意力头数。
  
• decoder_layers (int, optional, 默认为 24) — Transformer 文本解码器中的隐藏层数。
  
• decoder_ffn_dim (int, optional, defaults to 8192) — Transformer 文本解码器中“中间”（即前馈）层的维度。
  
• decoder_attention_heads (int, optional, defaults to 16) — Transformer 文本解码器中每个注意力层的注意力头数。
  
• decoder_start_token_id (int, optional, defaults to 3) — 如果编码器-解码器模型以与 bos 不同的标记开始解码，则该标记的 id。仅适用于文本解码器。
  
• max_new_tokens (int, optional, defaults to 256) — 要生成的文本标记的最大数量，忽略提示中的标记数量。
  
• pad_token_id (int, optional, defaults to 0) — padding 文本标记的 id。仅适用于文本解码器模型。
  
• bos_token_id (int, optional, defaults to 2) — 流开始 文本标记的 id。仅适用于文本解码器模型。
  
• eos_token_id (int, optional, defaults to 3) — 流结束 文本标记的 id。仅适用于文本解码器模型。
  

语音编码器特定参数

• speech_encoder_layers (int, optional, defaults to 24) — Transformer 语音编码器中的隐藏层数量。
  
• speech_encoder_attention_heads (int, optional, defaults to 16) — Transformer 语音编码器中每个注意力层的注意力头数。
  
• speech_encoder_intermediate_size (int, optional, defaults to 4096) — Transformer 语音编码器中“中间”（即前馈）层的维度。
  
• speech_encoder_hidden_act (str 或 function, optional, defaults to "swish") — 语音编码器中的非线性激活函数（函数或字符串）。如果是字符串，支持 "gelu", "relu", "selu", "swish" 和 "gelu_new"。
  
• speech_encoder_dropout (float, optional, defaults to 0.0) — 语音编码器中所有层的 dropout 概率。
  
• add_adapter (bool, optional, defaults to True) — 在语音编码器顶部添加一个适配器层。
  
• speech_encoder_layerdrop (float, optional, defaults to 0.1) — 语音编码器的 LayerDrop 概率。有关更多详细信息，请参阅 LayerDrop 论文)。
  
• feature_projection_input_dim (int, optional, defaults to 160) — 语音编码器输入特征投影的维度，即使用 SeamlessM4TFeatureExtractor 处理输入音频后的维度。
  
• adaptor_kernel_size (int, optional, defaults to 8) — 适配器网络中卷积层的核大小。仅在 add_adapter 为 True 时相关。
  
• adaptor_stride (int, optional, defaults to 8) — 适配器网络中卷积层的步幅。仅在 add_adapter 为 True 时相关。
  
• adaptor_dropout (float, optional, defaults to 0.1) — 语音适配器中所有层的 dropout 概率。
  
• num_adapter_layers (int, optional, defaults to 1) — 适配器网络中应使用的卷积层数量。仅在 add_adapter 为 True 时相关。
  
• position_embeddings_type (str, optional, defaults to "relative_key") — 可指定为 relative_key。如果保持为 None，则不应用相对位置嵌入。仅适用于语音编码器。有关 "relative_key" 的更多信息，请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。
  
• conv_depthwise_kernel_size (int, optional, defaults to 31) — Conformer 块中深度可分离 1D 卷积层的核大小。仅适用于语音编码器。
  
• left_max_position_embeddings (int, optional, defaults to 64) — 相对位置的左裁剪值。
  
• right_max_position_embeddings (int, optional, defaults to 8) — 相对位置的右裁剪值。
  
• speech_encoder_chunk_size (int, optional, 默认为 20000) — 每个注意力块的大小。
  
• speech_encoder_left_chunk_num (int, optional, 默认为 128) — 允许向左查看的块数。
  

文本到单元（t2u）模型特定参数

• t2u_bos_token_id (int, optional, 默认为 0) — 流开始 单元标记的 id。仅适用于文本到单元的 seq2seq 模型。
  
• t2u_pad_token_id (int, optional, 默认为 1) — 填充 单元标记的 id。仅适用于文本到单元的 seq2seq 模型。
  
• t2u_eos_token_id (int, optional, 默认为 2) — 流结束 单元标记的 id。仅适用于文本到单元的 seq2seq 模型。
  
• t2u_encoder_layers (int, optional, 默认为 6) — Transformer 文本到单元编码器中的隐藏层数量。
  
• t2u_encoder_ffn_dim (int, optional, 默认为 8192) — Transformer 文本到单元编码器中“中间”（即前馈）层的维度。
  
• t2u_encoder_attention_heads (int, optional, 默认为 16) — Transformer 文本到单元编码器中每个注意力层的注意力头数量。
  
• t2u_decoder_layers (int, optional, 默认为 6) — Transformer 文本到单元解码器中的隐藏层数量。
  
• t2u_decoder_ffn_dim (int, optional, 默认为 8192) — Transformer 文本到单元解码器中“中间”（即前馈）层的维度。
  
• t2u_decoder_attention_heads (int, optional, 默认为 16) — Transformer 文本到单元解码器中每个注意力层的注意力头数量。
  
• t2u_max_position_embeddings (int, optional, 默认为 4096) — 该模型文本到单元组件可能被使用的最大序列长度。通常设置为较大的值以防万一（例如 512、1024 或 2048）。
  
• t2u_variance_predictor_embed_dim (int, optional, 默认为 1024) — 文本到单元的持续时间预测器的投影维度。
  
• t2u_variance_predictor_hidden_dim (int, optional, 默认为 256) — 文本到单元的持续时间预测器的内部维度。
  
• t2u_variance_predictor_kernel_size (int, optional, 默认为 3) — 文本到单元的持续时间预测器的卷积层的内核大小。
  
• t2u_variance_pred_dropout (float, optional, 默认为 0.5) — 文本到单元的持续时间预测器的 dropout 概率。

Hifi-Gan 声码器特定参数

• sampling_rate (int, optional, 默认为 16000) — 生成输出音频的采样率，以赫兹（Hz）表示。
  
• upsample_initial_channel (int, optional, 默认为 512) — hifi-gan 上采样网络的输入通道数。仅适用于声码器。
  
• upsample_rates (Tuple[int] 或 List[int], optional, 默认为[5, 4, 4, 2, 2]) — 一个整数元组，定义声码器上采样网络中每个 1D 卷积层的步幅。upsample_rates的长度定义了卷积层的数量，并且必须与upsample_kernel_sizes的长度匹配。仅适用于声码器。
  
• upsample_kernel_sizes (Tuple[int] 或 List[int], optional, 默认为[11, 8, 8, 4, 4]) — 一个整数元组，定义声码器上采样网络中每个 1D 卷积层的内核大小。upsample_kernel_sizes的长度定义了卷积层的数量，并且必须与upsample_rates的长度匹配。仅适用于声码器。
  
• resblock_kernel_sizes (Tuple[int] 或 List[int], optional, 默认为[3, 7, 11]) — 一个整数元组，定义多接受域融合（MRF）模块中声码器 1D 卷积层的内核大小。仅适用于声码器。
  
• resblock_dilation_sizes (Tuple[Tuple[int]] 或 List[List[int]], optional, 默认为 [[1, 3, 5], [1, 3, 5], [1, 3, 5]]) — 一个嵌套的整数元组，定义了多接受域融合（MRF）模块中语音编码器膨胀 1D 卷积层的扩张率。仅适用于语音编码器。
  
• leaky_relu_slope (float, optional, 默认为 0.1) — 语音编码器中 leaky ReLU 激活使用的负斜率的角度。仅适用于语音编码器。
  
• unit_hifi_gan_vocab_size (int, optional, 默认为 10000) — SeamlessM4Tv2 语音编码器的词汇表大小。定义了在调用 _{SeamlessM4Tv2Model、}SeamlessM4Tv2ForSpeechToSpeech 或 ~SeamlessM4Tv2ForTextToSpeech 时可以表示的不同单元标记数量。
  
• unit_embed_dim (int, optional, 默认为 1280) — 给予 hifi-gan 语音编码器的输入 id 的投影维度。仅适用于语音编码器。
  
• lang_embed_dim (int, optional, 默认为 256) — 给予 hifi-gan 语音编码器的目标语言的投影维度。仅适用于语音编码器。
  
• spkr_embed_dim (int, optional, 默认为 256) — 给予 hifi-gan 语音编码器的说话者 id 的投影维度。仅适用于语音编码器。
  
• vocoder_num_langs (int, optional, 默认为 36) — 语音编码器支持的语言数量。可能与 t2u_num_langs 不同。
  
• vocoder_num_spkrs (int, optional, 默认为 200) — 语音编码器支持的说话者数量。
  
• variance_predictor_kernel_size (int, optional, 默认为 3) — 持续时间预测器的核大小。仅适用于语音编码器。
  
• var_pred_dropout (float, optional, 默认为 0.5) — 持续时间预测器的 dropout 概率。仅适用于语音编码器。
  
• vocoder_offset (int, optional, 默认为 4) — 将单元标记的 id 偏移此数字以考虑符号标记。仅适用于语音编码器。
  

这是用于存储 ~SeamlessM4Tv2Model 配置的配置类。根据指定的参数实例化一个 SeamlessM4Tv2 模型，定义模型架构。使用默认值实例化配置将产生类似于 SeamlessM4Tv2 “” 架构的配置。

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

>>> from transformers import SeamlessM4Tv2Model, SeamlessM4Tv2Config
>>> # Initializing a SeamlessM4Tv2 "" style configuration
>>> configuration = SeamlessM4Tv2Config()
>>> # Initializing a model from the "" style configuration
>>> model = SeamlessM4Tv2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

SEW

原文链接: huggingface.co/docs/transformers/v4.37.2/en/model_doc/sew

概述

SEW（Squeezed and Efficient Wav2Vec）是由 Felix Wu, Kwangyoun Kim, Jing Pan, Kyu Han, Kilian Q. Weinberger, Yoav Artzi 在Performance-Efficiency Trade-offs in Unsupervised Pre-training for Speech Recognition中提出的。

该论文的摘要如下：

这篇论文研究了预训练模型在自动语音识别（ASR）中的性能效率权衡。我们关注 wav2vec  2.0，并形式化了几种影响模型性能和效率的架构设计。综合我们所有的观察，我们引入了 SEW（Squeezed and Efficient  Wav2vec），这是一个预训练模型架构，在各种训练设置中在性能和效率两个维度上都有显著改进。例如，在 LibriSpeech 的  100h-960h 半监督设置下，SEW 相对于 wav2vec 2.0 实现了 1.9 倍的推理加速，词错误率相对减少了  13.5%。在类似的推理时间下，SEW 在不同模型大小上将词错误率降低了 25-50%。

这个模型是由anton-l贡献的。

使用提示

• SEW 是一个接受与语音信号的原始波形对应的浮点数组的语音模型。
  
• SEWForCTC 是使用连接主义时间分类（CTC）进行微调的，因此模型输出必须使用 Wav2Vec2CTCTokenizer 进行解码。
  

资源

• 音频分类任务指南
  
• 自动语音识别任务指南
  

SEWConfig

class transformers.SEWConfig

<来源>

( vocab_size = 32 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 squeeze_factor = 2 hidden_act = 'gelu' hidden_dropout = 0.1 activation_dropout = 0.1 attention_dropout = 0.1 feat_proj_dropout = 0.0 final_dropout = 0.1 layerdrop = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-05 feat_extract_norm = 'group' feat_extract_activation = 'gelu' conv_dim = (64, 128, 128, 128, 128, 256, 256, 256, 256, 512, 512, 512, 512) conv_stride = (5, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1) conv_kernel = (10, 3, 1, 3, 1, 3, 1, 3, 1, 2, 1, 2, 1) conv_bias = False num_conv_pos_embeddings = 128 num_conv_pos_embedding_groups = 16 apply_spec_augment = True mask_time_prob = 0.05 mask_time_length = 10 mask_time_min_masks = 2 mask_feature_prob = 0.0 mask_feature_length = 10 mask_feature_min_masks = 0 ctc_loss_reduction = 'mean' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 256 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 **kwargs )

参数

• vocab_size (int, 可选, 默认为 32) — SEW 模型的词汇表大小。定义了在调用SEW时可以表示的不同标记的数量。
  
• hidden_size (int, 可选, 默认为 768) — 编码器层和池化层的维度。
  
• num_hidden_layers (int, 可选, 默认为 12) — 变压器编码器中的隐藏层数量。
  
• num_attention_heads (int, 可选, 默认为 12) — 变压器编码器中每个注意力层的注意力头数。
  
• intermediate_size (int, 可选, 默认为 3072) — 变压器编码器中“中间”（即前馈）层的维度。
  
• squeeze_factor (int, 可选, 默认为 2) — 编码器后的序列长度下采样因子和变压器后的上采样因子。
  
• hidden_act (str或function, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu", "relu", "selu"和"gelu_new"。
  
• hidden_dropout (float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。
  
• activation_dropout (float, 可选, 默认为 0.1) — 全连接层内部激活的丢弃比率。
  
• attention_dropout (float, 可选, 默认为 0.1) — 注意力概率的丢弃比率。
  
• final_dropout (float, 可选, 默认为 0.1) — SEWForCTC 的最终投影层的丢弃概率。
  
• layerdrop (float, 可选, 默认为 0.1) — LayerDrop 概率。更多细节请参阅 LayerDrop paper)。
  
• initializer_range (float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  
• layer_norm_eps (float, optional, 默认为 1e-12) — 层归一化层使用的 epsilon。
  
• feat_extract_norm (str, optional, 默认为"group") — 应用于特征编码器中 1D 卷积层的规范化方式。"group"表示仅对第一个 1D 卷积层进行组归一化，"layer"表示对所有 1D 卷积层进行层归一化。
  
• feat_proj_dropout (float, optional, 默认为 0.0) — 特征编码器输出的丢弃概率。
  
• feat_extract_activation (str, optional, 默认为“gelu”) -- 特征提取器中 1D 卷积层的非线性激活函数（函数或字符串）。如果是字符串，支持“gelu”、“relu”、“selu”和“gelu_new”`。
  
• conv_dim (Tuple[int] 或 List[int], optional, 默认为(64, 128, 128, 128, 128, 256, 256, 256, 256, 512, 512, 512, 512)) — 一个整数元组，定义了特征编码器中每个 1D 卷积层的输入和输出通道数。conv_dim的长度定义了 1D 卷积层的数量。
  
• conv_stride (Tuple[int] 或 List[int], optional, 默认为(5, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1)) — 一个整数元组，定义了特征编码器中每个 1D 卷积层的步幅。conv_stride的长度定义了卷积层的数量，并且必须与conv_dim的长度匹配。
  
• conv_kernel (Tuple[int] 或 List[int], optional, 默认为(10, 3, 1, 3, 1, 3, 1, 3, 1, 2, 1, 2, 1)) — 一个整数元组，定义了特征编码器中每个 1D 卷积层的内核大小。conv_kernel的长度定义了卷积层的数量，并且必须与conv_dim的长度匹配。
  
• conv_bias (bool, optional, 默认为False) — 1D 卷积层是否具有偏置。
  
• num_conv_pos_embeddings (int, optional, 默认为 128) — 卷积位置嵌入的数量。定义了 1D 卷积位置嵌入层的内核大小。
  
• num_conv_pos_embedding_groups (int, optional, 默认为 16) — 1D 卷积位置嵌入层的组数。
  
• apply_spec_augment (bool, optional, 默认为True) — 是否对特征编码器的输出应用SpecAugment数据增强。参考SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition。
  
• mask_time_prob (float, optional,  默认为 0.05) — 沿时间轴的所有特征向量中将被掩盖的百分比（介于 0 和 1  之间）。掩盖过程在该轴上生成”mask_time_prob*len(time_axis)/mask_time_length”个独立的掩码。如果从每个特征向量被选择为掩盖向量跨度起始的概率推理，mask_time_prob应该是prob_vector_start*mask_time_length。请注意，重叠可能会降低掩盖向量的实际百分比。只有在apply_spec_augment 为 True时才相关。
  
• mask_time_length (int, optional, 默认为 10) — 沿时间轴的向量跨度长度。
  
• mask_time_min_masks (int, optional, 默认为 2) — 沿时间轴生成的长度为mask_feature_length的掩码的最小数量，每个时间步，与mask_feature_prob无关。只有在”mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks”时才相关。
  
• mask_feature_prob (float, optional, defaults to 0.0) — 沿特征轴的所有特征向量中将被掩码的百分比（介于 0 和 1 之间）。掩码过程在轴上生成”mask_feature_problen(feature_axis)/mask_time_length”个独立掩码。如果从每个特征向量被选择为要掩码的向量跨度的起始的概率推理， mask_feature_prob *应为prob_vector_start*mask_feature_length。请注意，重叠可能会降低实际掩码向量的百分比。仅在apply_spec_augment为 True 时相关。
  
• mask_feature_length (int, optional, defaults to 10) — 沿特征轴的向量跨度长度。
  
• mask_feature_min_masks (int, optional, defaults to 0), — 沿特征轴生成的长度为mask_feature_length的最小掩码数量，每个时间步，与mask_feature_prob无关。仅在”mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks”时相关
  
• ctc_loss_reduction (str, optional, defaults to "sum") — 指定应用于torch.nn.CTCLoss输出的减少。仅在训练 SEWForCTC 的实例时相关。
  
• ctc_zero_infinity (bool, optional, defaults to False) — 是否将torch.nn.CTCLoss的无限损失和相关梯度置零。当输入太短无法与目标对齐时，主要会出现无限损失。仅在训练 SEWForCTC 的实例时相关。
  
• use_weighted_layer_sum (bool, optional, defaults to False) — 是否使用学习权重的层输出的加权平均。仅在使用 Wav2Vec2ForSequenceClassification 的实例时相关。
  
• classifier_proj_size (int, optional, defaults to 256) — 分类前的投影维度。
  

这是用于存储 SEWModel 配置的配置类。根据指定的参数实例化 SEW 模型，定义模型架构。使用默认值实例化配置将产生类似于 SEW asapp/sew-tiny-100k架构的配置。

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

示例：

>>> from transformers import SEWConfig, SEWModel
>>> # Initializing a SEW asapp/sew-tiny-100k style configuration
>>> configuration = SEWConfig()
>>> # Initializing a model (with random weights) from the asapp/sew-tiny-100k style configuration
>>> model = SEWModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

SEWModel

class transformers.SEWModel

<来源>

( config: SEWConfig )

参数

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

裸 SEW 模型变压器输出原始隐藏状态，没有特定的顶部头。SEW 是由 Felix Wu、Kwangyoun Kim、Jing Pan、Kyu Han、Kilian Q. Weinberger、Yoav Artzi 在Performance-Efficiency Trade-offs in Unsupervised Pre-training for Speech Recognition中提出的。

该模型继承自 PreTrainedModel。查看超类文档以了解库实现的通用方法（如下载或保存等）。

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

forward

<来源>

( input_values: Optional attention_mask: Optional = None mask_time_indices: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.BaseModelOutput or tuple(torch.FloatTensor)

参数

• input_values (torch.FloatTensor of shape (batch_size, sequence_length)) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]类型的数组或numpy.ndarray中获得，例如通过 soundfile 库（pip install soundfile）。为了准备input_values数组，应使用 AutoProcessor 进行填充和转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。
  
• attention_mask (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于避免在填充标记索引上执行卷积和注意力的掩码。选择的掩码值在[0, 1]中：

• 1 代表未被掩盖的标记，
  
• 0 代表被掩盖的标记。
  

• 什么是注意力掩码？
  
• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。
  
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。
  
• return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  

返回

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

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

• last_hidden_state (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列。
  
• hidden_states (tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则为嵌入的输出+每层的输出）。
  模型在每一层输出的隐藏状态以及可选的初始嵌入输出。
  
• attentions (tuple(torch.FloatTensor), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每层一个）。
  注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
  

SEWModel 的前向方法，覆盖了__call__特殊方法。

尽管需要在此函数内定义前向传递的配方，但应该在之后调用Module实例，而不是在此处调用，因为前者会负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoProcessor, SEWModel
>>> import torch
>>> from datasets import load_dataset
>>> 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("asapp/sew-tiny-100k-ft-ls100h")
>>> model = SEWModel.from_pretrained("asapp/sew-tiny-100k-ft-ls100h")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 292, 512]

Transformers 4.37 中文文档（七十七）（3）https://developer.aliyun.com/article/1564186