WavLM
概述
WavLM 模型是在 WavLM: 用于全栈语音处理的大规模自监督预训练 中由 陈三元、王成义、陈政阳、吴宇、刘树杰、陈卓、李金玉、神田直之、吉冈拓哉、肖雄、吴健、周龙、任硕、钱艳敏、钱瑶、吴健、曾迈克尔、魏福如 提出的。
论文中的摘要如下
自监督学习 (SSL) 在语音识别方面取得了巨大成功，而对其他语音处理任务的探索有限。由于语音信号包含多方面的信息，包括说话人身份、副语言学、语音内容等，学习适用于所有语音任务的通用表示是一个挑战。在本文中，我们提出了一种新的预训练模型 WavLM，以解决全栈下游语音任务。WavLM 基于 HuBERT 框架构建，重点关注语音内容建模和说话人身份保留。我们首先为 Transformer 结构配备了门控相对位置偏差，以提高其在识别任务中的能力。为了更好地进行说话人区分，我们提出了一种话语混合训练策略，其中额外重叠的话语被无监督地创建，并在模型训练期间被合并。最后，我们将训练数据集从 60k 小时扩展到 94k 小时。WavLM 大型在 SUPERB 基准测试中取得了最先进的性能，并在其代表性基准测试中为各种语音处理任务带来了显著的改进。
相关检查点可在 https://huggingface.co/models?other=wavlm 下找到。
该模型由 patrickvonplaten 贡献。作者的代码可在 此处 找到。
使用技巧
- WavLM 是一个语音模型，它接受一个浮点数组，该数组对应于语音信号的原始波形。请使用 Wav2Vec2Processor 进行特征提取。
- WavLM 模型可以使用连接时序分类 (CTC) 进行微调，因此模型输出必须使用 Wav2Vec2CTCTokenizer 解码。
- WavLM 在说话人验证、说话人识别和说话人分离任务上表现尤为出色。
资源
WavLMConfig
class transformers.WavLMConfig
< 源代码 >( vocab_size = 32 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 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 = (512, 512, 512, 512, 512, 512, 512) conv_stride = (5, 2, 2, 2, 2, 2, 2) conv_kernel = (10, 3, 3, 3, 3, 2, 2) conv_bias = False num_conv_pos_embeddings = 128 num_conv_pos_embedding_groups = 16 num_buckets = 320 max_bucket_distance = 800 do_stable_layer_norm = False 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 num_codevectors_per_group = 320 num_codevector_groups = 2 contrastive_logits_temperature = 0.1 num_negatives = 100 codevector_dim = 256 proj_codevector_dim = 256 diversity_loss_weight = 0.1 ctc_loss_reduction = 'mean' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 256 tdnn_dim = (512, 512, 512, 512, 1500) tdnn_kernel = (5, 3, 3, 1, 1) tdnn_dilation = (1, 2, 3, 1, 1) xvector_output_dim = 512 num_ctc_classes = 80 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 add_adapter = False adapter_kernel_size = 3 adapter_stride = 2 num_adapter_layers = 3 output_hidden_size = None **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32) — WavLM 模型的词汇量大小。定义调用 WavLMModel 时传递的inputs_ids可以表示的不同 token 数量。模型的词汇量大小。定义调用 WavLMModel 前向方法时传递的 inputs_ids 可以表示的不同 token。 - hidden_size (
int, 可选, 默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int, 可选, 默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout (
float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - activation_dropout (
float, 可选, 默认为 0.1) — 全连接层内部激活的 dropout 比例。 - attention_dropout (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比例。 - final_dropout (
float, 可选, 默认为 0.1) — WavLMForCTC 的最终投影层的 dropout 概率。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - feat_extract_norm (
str, 可选, 默认为"group") — 应用于特征编码器中一维卷积层的规范。可以是"group"表示仅对第一层一维卷积层进行组规范化，或者"layer"表示对所有一维卷积层进行层归一化。 - feat_proj_dropout (
float, 可选, 默认为 0.0) — 特征编码器输出的丢弃概率。 - feat_extract_activation (
str,可选, 默认为“gelu”) -- 特征提取器中一维卷积层的非线性激活函数（函数或字符串）。如果为字符串，则支持“gelu”,“relu”,“selu”和“gelu_new”`。 - conv_dim (
Tuple[int]或List[int], 可选, 默认为(512, 512, 512, 512, 512, 512, 512)) — 一个整数元组，定义特征编码器中每个一维卷积层的输入和输出通道数。conv_dim 的长度定义了一维卷积层的数量。 - conv_stride (
Tuple[int]或List[int], 可选, 默认为(5, 2, 2, 2, 2, 2, 2)) — 一个整数元组，定义特征编码器中每个一维卷积层的步长。conv_stride 的长度定义了卷积层的数量，必须与 conv_dim 的长度匹配。 - conv_kernel (
Tuple[int]或List[int], 可选, 默认为(10, 3, 3, 3, 3, 3, 3)) — 一个整数元组，定义特征编码器中每个一维卷积层的核大小。conv_kernel 的长度定义了卷积层的数量，必须与 conv_dim 的长度匹配。 - conv_bias (
bool, 可选, 默认为False) — 一维卷积层是否带偏置。 - num_conv_pos_embeddings (
int, 可选, 默认为 128) — 卷积位置嵌入的数量。定义一维卷积位置嵌入层的核大小。 - apply_spec_augment (
bool, 可选, 默认值为True) — 是否将SpecAugment 数据增强应用于特征编码器的输出。 作为参考，请参阅 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition。 - mask_time_prob (
float, 可选, 默认值为 0.05) — 沿时间轴被选为要掩盖的向量跨度的起始位置的每个特征向量的概率。 大致mask_time_prob * sequence_length // mask_time_length个特征向量将沿时间轴被掩盖。 这仅在apply_spec_augment 为 True时相关。 - mask_time_length (
int, 可选, 默认值为 10) — 沿时间轴的向量跨度的长度。 - mask_time_min_masks (
int, 可选, 默认值为 2), — 沿时间轴生成的长度为mask_feature_length的最小掩盖数量，每次，不考虑mask_feature_prob。 仅在 ”mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks” 时相关。 - mask_feature_prob (
float, 可选, 默认值为 0.0) — 沿特征轴被选为要掩盖的向量跨度的起始位置的每个特征向量的概率。 大致mask_time_prob * hidden_size // mask_time_length个特征向量将沿时间轴被掩盖。 这仅在apply_spec_augment 为 True时相关。 - mask_feature_length (
int, 可选, 默认值为 10) — 沿特征轴的向量跨度的长度。 - num_codevectors_per_group (
int, 可选, 默认值为 320) — 每个量化码本（组）中的条目数。 - num_codevector_groups (
int, 可选, 默认值为 2) — 产品码向量量化的码向量组数。 - contrastive_logits_temperature (
float, 可选, 默认值为 0.1) — 对比损失中的温度 kappa。 - proj_codevector_dim (
int, 可选, 默认为 256) — 量化特征和 Transformer 特征的最终投影维度。 - diversity_loss_weight (
int, 可选, 默认为 0.1) — 代码本多样性损失组件的权重。 - ctc_loss_reduction (
str, 可选, 默认为"mean") — 指定对torch.nn.CTCLoss输出应用的缩减。仅当训练 WavLMForCTC 实例时才相关。 - ctc_zero_infinity (
bool, 可选, 默认为False) — 是否将torch.nn.CTCLoss的无限损失和相关梯度置零。无限损失主要发生在输入太短而无法与目标对齐时。仅当训练 WavLMForCTC 实例时才相关。 - use_weighted_layer_sum (
bool, 可选, 默认为False) — 是否使用带有学习权重的层输出的加权平均值。仅当使用 WavLMForSequenceClassification 实例时才相关。 - classifier_proj_size (
int, 可选, 默认为 256) — 用于分类的 Token 平均池化之前的投影维度。 - tdnn_dim (
Tuple[int]或List[int], 可选, 默认为(512, 512, 512, 512, 1500)) — 定义 XVector 模型 TDNN 模块中每个 1D 卷积层的输出通道数的整数元组。tdnn_dim 的长度定义 TDNN 层的数量。 - tdnn_kernel (
Tuple[int]或List[int], 可选, 默认为(5, 3, 3, 1, 1)) — 定义 XVector 模型 TDNN 模块中每个 1D 卷积层的内核大小的整数元组。tdnn_kernel 的长度必须与 tdnn_dim 的长度匹配。 - tdnn_dilation (
Tuple[int]或List[int], 可选, 默认为(1, 2, 3, 1, 1)) — 定义 XVector 模型 TDNN 模块中每个 1D 卷积层的膨胀系数的整数元组。tdnn_dilation 的长度必须与 tdnn_dim 的长度匹配。 - adapter_kernel_size (
int, 可选, 默认值为 3) — 适配器网络中卷积层的核大小。仅当add_adapter 为 True时有效。 - adapter_stride (
int, 可选, 默认值为 2) — 适配器网络中卷积层的步长。仅当add_adapter 为 True时有效。 - num_adapter_layers (
int, 可选, 默认值为 3) — 适配器网络中应使用的卷积层数。仅当add_adapter 为 True时有效。 - output_hidden_size (
int, 可选) — 编码器输出层的维度。如果没有定义，则默认为 hidden-size。仅当add_adapter 为 True时有效。
这是用于存储 WavLMModel 配置的配置类。它用于根据指定的参数实例化 WavLM 模型，定义模型架构。使用默认值实例化配置将产生与 WavLM microsoft/wavlm-base 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import WavLMConfig, WavLMModel
>>> # Initializing a WavLM facebook/wavlm-base-960h style configuration
>>> configuration = WavLMConfig()
>>> # Initializing a model (with random weights) from the facebook/wavlm-base-960h style configuration
>>> model = WavLMModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configWavLMModel
class transformers.WavLMModel
< 源代码 >( config: WavLMConfig )
参数
- config (WavLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
WavLM 模型的裸transformer，输出原始隐藏状态，没有在其上添加任何特定头部。WavLM 在 WavLM：使用标记和未标记数据的统一语音表示学习 中提出，由 Sanyuan Chen、Chengyi Wang、Zhengyang Chen、Yu Wu、Shujie Liu、Zhuo Chen、Jinyu Li、Naoyuki Kanda、Takuya Yoshioka、Xiong Xiao、Jian Wu、Long Zhou、Shuo Ren、Yanmin Qian、Yao Qian、Jian Wu、Michael Zeng、Xiangzhan Yu 和 Furu Wei 撰写。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。
正向
< 源代码 >( 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 ) → 参数 仅当相应的处理器具有 返回 transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或
一个 transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 last_hidden_state ( extract_features ( hidden_states ( 每一层输出处的模型隐藏状态加上初始嵌入输出。 attentions ( 注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。torch.FloatTensor 形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将 .flac 或 .wav 音频文件加载到 List[float] 或 numpy.ndarray 类型的数组中来获取值，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备成 input_values，应使用 AutoProcessor 进行填充并将它们转换为 torch.FloatTensor 类型的张量。有关详细信息，请参见 Wav2Vec2Processor.call()。 torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充令牌索引执行卷积和注意的掩码。掩码值选择在 [0, 1] 中：
config.return_attention_mask == True 时，才应传递 attention_mask。对于所有处理器具有 config.return_attention_mask == False 的模型，在执行批处理推理时应不传递 attention_mask，以避免性能下降。对于此类模型，input_values 应该简单地用 0 填充，并在没有 attention_mask 的情况下传递。请注意，这些模型还将产生略微不同的结果，具体取决于 input_values 是否已填充。bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的 attentions。 bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的 hidden_states。 bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 tuple(torch.FloatTensor)torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (WavLMConfig) 和输入的各种元素。
torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。torch.FloatTensor 形状为 (batch_size, sequence_length, conv_dim[-1])) — 模型最后一层卷积层的提取特征向量序列。tuple(torch.FloatTensor), 可选, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入的输出，一个用于每一层的输出），形状为 (batch_size, sequence_length, hidden_size)。tuple(torch.FloatTensor), 可选, 当传递了 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每一层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。
The WavLMModel forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, WavLMModel
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("patrickvonplaten/wavlm-libri-clean-100h-base-plus")
>>> model = WavLMModel.from_pretrained("patrickvonplaten/wavlm-libri-clean-100h-base-plus")
>>> # 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, 768]WavLMForCTC
class transformers.WavLMForCTC
< 源代码 >( config target_lang: Optional = None )
参数
- config (WavLMConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
WavLM 模型，顶部带有用于连接时序分类 (CTC) 的语言建模头。WavLM 在 WavLM: 使用带标签和无标签数据的统一语音表示学习 中由陈三元、王成义、陈正阳、吴宇、刘树杰、陈卓、李金玉、神田直之、吉冈拓哉、肖雄、吴健、周龙、任硕、钱艳敏、钱耀、吴健、曾迈克尔、于翔展、魏福如提出。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。
正向
< 源代码 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(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形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行卷积和注意力的掩码。在[0, 1]中选择掩码值：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
仅当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有config.return_attention_mask == False的模型，不应将attention_mask传递给模型，以避免在进行批处理推理时性能下降。对于此类模型，input_values应简单地用 0 填充并传递，无需attention_mask。请注意，这些模型也会产生略微不同的结果，具体取决于input_values是否填充。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, target_length), 可选) — 用于连接时序分类的标签。请注意，target_length必须小于或等于输出 logits 的序列长度。索引在[-100, 0, ..., config.vocab_size - 1]中选择。所有设置为-100的标签都被忽略（屏蔽），仅针对[0, ..., config.vocab_size - 1]中的标签计算损失。
返回
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (WavLMConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个词预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 之后的注意力权重，用于计算自注意力头中的加权平均值。
WavLMForCTC 的前向方法覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, WavLMForCTC
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("patrickvonplaten/wavlm-libri-clean-100h-base-plus")
>>> model = WavLMForCTC.from_pretrained("patrickvonplaten/wavlm-libri-clean-100h-base-plus")
>>> # 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]
'mister quilter is the aposle of the middle classes and we are glad to welcome his gospel'
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
12.51WavLMForSequenceClassification
class transformers.WavLMForSequenceClassification
< 源代码 >( config )
参数
- config (WavLMConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型相关的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
WavLM 模型，顶部带有一个序列分类头（在池化输出上的线性层），用于像 SUPERB Keyword Spotting 这样的任务。
WavLM 由 Sanyuan Chen、Chengyi Wang、Zhengyang Chen、Yu Wu、Shujie Liu、Zhuo Chen、Jinyu Li、Naoyuki Kanda、Takuya Yoshioka、Xiong Xiao、Jian Wu、Long Zhou、Shuo Ren、Yanmin Qian、Yao Qian、Jian Wu、Michael Zeng、Xiangzhan Yu、Furu Wei 在 WavLM: Unified Speech Representation Learning with Labeled and Unlabeled Data 中提出。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。
正向
< 源代码 >( input_values: Optional attention_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None labels: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput or tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensorof 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.LongTensorof shape(batch_size, sequence_length), optional) — 掩码，以避免对填充标记索引执行卷积和注意力。 掩码值选择在[0, 1]中：- 1 代表 不掩码 的标记，
- 0 代表 掩码 的标记。
仅当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。 对于所有处理器具有config.return_attention_mask == False的模型，应 不 将attention_mask传递，以避免在进行批处理推理时性能下降。 对于此类模型，input_values应简单地用 0 填充，并在没有attention_mask的情况下传递。 请注意，这些模型也会根据input_values是否填充而产生略有不同的结果。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。 查看返回张量中的attentions了解更多信息。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 查看返回张量中的hidden_states了解更多信息。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包括根据配置 (WavLMConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选，在提供labels时返回) — 分类（如果config.num_labels==1则为回归）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（如果config.num_labels==1则为回归）分数（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The WavLMForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, WavLMForSequenceClassification
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("patrickvonplaten/wavlm-libri-clean-100h-base-plus")
>>> model = WavLMForSequenceClassification.from_pretrained("patrickvonplaten/wavlm-libri-clean-100h-base-plus")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.argmax(logits, dim=-1).item()
>>> predicted_label = model.config.id2label[predicted_class_ids]
>>> # compute loss - target_label is e.g. "down"
>>> target_label = model.config.id2label[0]
>>> inputs["labels"] = torch.tensor([model.config.label2id[target_label]])
>>> loss = model(**inputs).lossWavLMForAudioFrameClassification
class transformers.WavLMForAudioFrameClassification
< 源代码 >( config )
参数
- config (WavLMConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法加载模型权重。
在顶部具有帧分类头的 WavLM 模型，用于扬声器识别等任务。
WavLM 由 Sanyuan Chen、Chengyi Wang、Zhengyang Chen、Yu Wu、Shujie Liu、Zhuo Chen、Jinyu Li、Naoyuki Kanda、Takuya Yoshioka、Xiong Xiao、Jian Wu、Long Zhou、Shuo Ren、Yanmin Qian、Yao Qian、Jian Wu、Michael Zeng、Xiangzhan Yu、Furu Wei 在 WavLM: Unified Speech Representation Learning with Labeled and Unlabeled Data 中提出。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。
正向
< 源代码 >( input_values: 可选 attention_mask: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(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形状为(batch_size, sequence_length), 可选) — 掩码，以避免在填充标记索引上执行卷积和注意力。在[0, 1]中选择掩码值：- 1 表示 **未屏蔽** 的标记，
- 0 表示 **屏蔽** 的标记。
仅当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有config.return_attention_mask == False的模型，应 **不** 将attention_mask传递给模型，以避免在进行批处理推理时性能下降。对于此类模型，input_values应简单地用 0 填充并传递而无需attention_mask。请注意，这些模型还会根据input_values是否填充而产生略微不同的结果。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含根据配置 (WavLMConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.num_labels)) — 分类得分（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The WavLMForAudioFrameClassification 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, WavLMForAudioFrameClassification
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/wavlm-base-plus-sd")
>>> model = WavLMForAudioFrameClassification.from_pretrained("microsoft/wavlm-base-plus-sd")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], return_tensors="pt", sampling_rate=sampling_rate)
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> probabilities = torch.sigmoid(logits[0])
>>> # labels is a one-hot array of shape (num_frames, num_speakers)
>>> labels = (probabilities > 0.5).long()
>>> labels[0].tolist()
[0, 0]WavLMForXVector
class transformers.WavLMForXVector
< 源代码 >( config )
参数
- config (WavLMConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
带有一个 XVector 特征提取头的 WavLM 模型，用于扬声器验证等任务。
WavLM 由 Sanyuan Chen、Chengyi Wang、Zhengyang Chen、Yu Wu、Shujie Liu、Zhuo Chen、Jinyu Li、Naoyuki Kanda、Takuya Yoshioka、Xiong Xiao、Jian Wu、Long Zhou、Shuo Ren、Yanmin Qian、Yao Qian、Jian Wu、Michael Zeng、Xiangzhan Yu、Furu Wei 在 WavLM: Unified Speech Representation Learning with Labeled and Unlabeled Data 中提出。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。
正向
< 源代码 >( input_values: Optional attention_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None labels: Optional = None ) → transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型的数组中来获得值，例如 通过 soundfile 库 (pip install soundfile)。要将数组准备为input_values，应使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的 token，
- 0 表示屏蔽的 token。
只有在相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有config.return_attention_mask == False的模型，应不将attention_mask传递给模型，以避免在进行批处理推理时性能下降。对于此类模型，input_values应简单地用 0 填充并传递，而不带attention_mask。请注意，这些模型的输出结果也略有不同，具体取决于input_values是否填充。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.XVectorOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含取决于配置 (WavLMConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.xvector_output_dim)) — AMSoftmax 之前的分类隐藏状态。 -
embeddings (
torch.FloatTensor形状为(batch_size, config.xvector_output_dim)) — 用于基于向量相似度的检索的语句嵌入。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The WavLMForXVector 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但应该在之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则会静默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, WavLMForXVector
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/wavlm-base-plus-sv")
>>> model = WavLMForXVector.from_pretrained("microsoft/wavlm-base-plus-sv")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(
... [d["array"] for d in dataset[:2]["audio"]], sampling_rate=sampling_rate, return_tensors="pt", padding=True
... )
>>> with torch.no_grad():
... embeddings = model(**inputs).embeddings
>>> embeddings = torch.nn.functional.normalize(embeddings, dim=-1).cpu()
>>> # the resulting embeddings can be used for cosine similarity-based retrieval
>>> cosine_sim = torch.nn.CosineSimilarity(dim=-1)
>>> similarity = cosine_sim(embeddings[0], embeddings[1])
>>> threshold = 0.7 # the optimal threshold is dataset-dependent
>>> if similarity < threshold:
... print("Speakers are not the same!")
>>> round(similarity.item(), 2)
0.97