Transformers 文档
Wav2Vec2
并获得增强的文档体验
开始使用
Wav2Vec2
概述
Wav2Vec2 模型在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 这篇论文中被提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
论文摘要如下：
我们首次证明，仅从语音音频中学习强大的表示，然后对转录的语音进行微调，可以胜过最佳的半监督方法，同时在概念上更简单。wav2vec 2.0 掩盖了潜在空间中的语音输入，并解决了一个在联合学习的潜在表示的量化上定义的对比任务。使用 Librispeech 的所有标记数据进行的实验在 clean/other 测试集上实现了 1.8/3.3 WER。当将标记数据的量降低到一个小时时，wav2vec 2.0 在 100 小时子集上优于之前的最先进水平，同时使用的标记数据减少了 100 倍。仅使用十分钟的标记数据并在 53k 小时的未标记数据上进行预训练，仍然可以实现 4.8/8.2 WER。这证明了在有限数量的标记数据下进行语音识别的可行性。
此模型由 patrickvonplaten 贡献。
注意：Meta (FAIR) 发布了新版本的 Wav2Vec2-BERT 2.0 - 它在 4.5M 小时的音频上进行了预训练。我们特别推荐将其用于微调任务，例如按照 本指南。
使用提示
- Wav2Vec2 是一个语音模型，它接受一个浮点数组，对应于语音信号的原始波形。
- Wav2Vec2 模型使用连接时序分类 (CTC) 进行训练，因此模型输出必须使用 Wav2Vec2CTCTokenizer 进行解码。
使用 Flash Attention 2
Flash Attention 2 是模型的一个更快、更优化的版本。
安装
首先，检查您的硬件是否与 Flash Attention 2 兼容。兼容硬件的最新列表可以在 官方文档 中找到。如果您的硬件与 Flash Attention 2 不兼容，您仍然可以通过 上面 介绍的 Better Transformer 支持中受益于 attention 内核优化。
接下来，安装 最新版本的 Flash Attention 2
pip install -U flash-attn --no-build-isolation
用法
要使用 Flash Attention 2 加载模型，我们可以将参数 attn_implementation="flash_attention_2" 传递给 .from_pretrained。我们还将以半精度 (例如 torch.float16) 加载模型，因为它几乎不会降低音频质量，但会显着降低内存使用量并加快推理速度
>>> from transformers import Wav2Vec2Model
model = Wav2Vec2Model.from_pretrained("facebook/wav2vec2-large-960h-lv60-self", torch_dtype=torch.float16, attn_implementation="flash_attention_2").to(device)
...预期加速
以下是预期加速图表，比较了 facebook/wav2vec2-large-960h-lv60-self 模型的 transformers 中的原生实现与 flash-attention-2 和 sdpa (scale-dot-product-attention) 版本之间的纯推理时间。我们展示了在 librispeech_asr clean 验证集上获得的平均加速。
资源
以下是官方 Hugging Face 和社区（标有 🌎）资源列表，可帮助您开始使用 Wav2Vec2。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！该资源应理想地展示一些新的东西，而不是重复现有资源。
- 一个关于如何利用预训练的 Wav2Vec2 模型进行情感分类 的 notebook。🌎
- Wav2Vec2ForCTC 通过此示例脚本和notebook支持。
- 音频分类任务指南
- 一篇关于在 🤗 Transformers 中使用 n-gram 提升 Wav2Vec2 性能的博文。
- 一篇关于如何使用 🤗 Transformers 微调 Wav2Vec2 以进行英语 ASR的博文。
- 一篇关于使用 🤗 Transformers 微调 XLS-R 以进行多语言 ASR的博文。
- 一个关于如何通过使用 Wav2Vec2 转录音频，从任何视频创建 YouTube 字幕的 notebook。🌎
- Wav2Vec2ForCTC 通过一个关于如何微调英语语音识别模型的 notebook，以及如何微调任何语言的语音识别模型的 notebook 支持。
- 自动语音识别任务指南
🚀 部署
- 一篇关于如何使用 Hugging Face 的 Transformers & Amazon SageMaker 部署 Wav2Vec2 以进行自动语音识别的博文。
Wav2Vec2Config
class transformers.Wav2Vec2Config
< source >( 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 feat_quantizer_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 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 mask_feature_min_masks = 0 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 = 'sum' 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 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 adapter_attn_dim = None **kwargs )
参数
- vocab_size (
int, optional, defaults to 32) — Wav2Vec2 模型的词汇表大小。 定义了在调用 Wav2Vec2Model 或 TFWav2Vec2Model 时，可以通过inputs_ids传递的不同 token 的数量。 模型的词汇表大小。 定义了可以由传递给 Wav2Vec2Model 前向方法的 inputs_ids 表示的不同 token。 - hidden_size (
int, optional, defaults to 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, optional, defaults to 12) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int, optional, defaults to 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int, optional, defaults to 3072) — Transformer 编码器中“中间层”（即，前馈）的维度。 - hidden_act (
str或function, optional, defaults to"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。 如果是字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout (
float, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - activation_dropout (
float, optional, defaults to 0.1) — 全连接层内部激活值的 dropout 比率。 - attention_dropout (
float, optional, defaults to 0.1) — 注意力概率的 dropout 比率。 - final_dropout (
float, optional, defaults to 0.1) — Wav2Vec2ForCTC 的最终投影层的 dropout 概率。 - layerdrop (
float, optional, defaults to 0.1) — LayerDrop 概率。 有关更多详细信息，请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - initializer_range (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-12) — 层归一化层使用的 epsilon 值。 - feat_extract_norm (
str, optional, defaults to"group") — 应用于特征编码器中 1D 卷积层的归一化类型。 可以是"group"，表示仅对第一个 1D 卷积层应用 group normalization；也可以是"layer"，表示对所有 1D 卷积层应用 layer normalization。 - feat_proj_dropout (
float, optional, defaults to 0.0) — 特征编码器输出的 dropout 概率。 - feat_extract_activation (
str, optional, defaults to“gelu”) -- 特征提取器的 1D 卷积层中的非线性激活函数（函数或字符串）。 如果是字符串，则支持“gelu”、“relu”、“selu”和“gelu_new”。 - feat_quantizer_dropout (
float, optional, defaults to 0.0) — 量化特征编码器状态的 dropout 概率。 - conv_dim (
Tuple[int]或List[int], optional, defaults to(512, 512, 512, 512, 512, 512, 512)) — 定义特征编码器中每个 1D 卷积层的输入和输出通道数的整数元组。 conv_dim 的长度定义了 1D 卷积层的数量。 - conv_stride (
Tuple[int]或List[int], optional, defaults to(5, 2, 2, 2, 2, 2, 2)) — 定义特征编码器中每个 1D 卷积层的步幅的整数元组。 conv_stride 的长度定义了卷积层的数量，并且必须与 conv_dim 的长度匹配。 - conv_kernel (
Tuple[int]或List[int], optional, defaults to(10, 3, 3, 3, 3, 3, 3)) — 定义特征编码器中每个 1D 卷积层的卷积核大小的整数元组。 conv_kernel 的长度定义了卷积层的数量，并且必须与 conv_dim 的长度匹配。 - conv_bias (
bool, optional, defaults toFalse) — 1D 卷积层是否具有偏置。 - num_conv_pos_embeddings (
int, optional, defaults to 128) — 卷积位置嵌入的数量。 定义了 1D 卷积位置嵌入层的卷积核大小。 - num_conv_pos_embedding_groups (
int, optional, defaults to 16) — 1D 卷积位置嵌入层的组数。 - do_stable_layer_norm (
bool, optional, defaults toFalse) — 是否应用 Transformer 编码器的稳定层归一化架构。do_stable_layer_norm is True对应于在注意力层之前应用层归一化，而do_stable_layer_norm is False对应于在注意力层之后应用层归一化。 - apply_spec_augment (
bool, optional, defaults toTrue) — 是否将 SpecAugment 数据增强应用于特征编码器的输出。 有关参考，请参阅 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition。 - mask_time_prob (
float, optional, defaults to 0.05) — 沿时间轴将要被 mask 的所有特征向量的百分比（介于 0 和 1 之间）。 Mask 过程在轴上生成 “mask_time_prob*len(time_axis)/mask_time_length” 个独立的 mask。 如果从每个特征向量被选为要 mask 的向量跨度的起点的概率来推断，mask_time_prob 应该为 `prob_vector_start*mask_time_length`。 请注意，重叠可能会降低实际 mask 向量的百分比。 这仅在apply_spec_augment is True时相关。 - mask_time_length (
int, optional, defaults to 10) — 沿时间轴的向量跨度长度。 - mask_time_min_masks (
int, optional, defaults to 2), — 沿时间轴生成的长度为mask_feature_length的最小 mask 数量，每个时间步，与mask_feature_prob无关。 仅当 “mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks” 时相关 - mask_feature_prob (
float, 可选，默认为 0.0) — 沿特征轴将被屏蔽的所有特征向量的百分比（介于 0 和 1 之间）。屏蔽过程会生成 “mask_feature_prob*len(feature_axis)/mask_time_length” 个沿轴独立的掩码。如果从每个特征向量被选为要屏蔽的向量跨度的起点的概率来推断，则 mask_feature_prob 应该为 `prob_vector_start*mask_feature_length`。 请注意，重叠可能会降低实际屏蔽向量的百分比。 这仅在apply_spec_augment 为 True时相关。 - mask_feature_length (
int, 可选，默认为 10) — 沿特征轴的向量跨度长度。 - mask_feature_min_masks (
int, 可选，默认为 0) — 沿特征轴生成的长度为mask_feature_length的最小掩码数，每次时间步，与mask_feature_prob无关。 仅在 “mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks” 时相关 - num_codevectors_per_group (
int, 可选，默认为 320) — 每个量化码本（组）中的条目数。 - num_codevector_groups (
int, 可选，默认为 2) — 用于乘积码本向量量化的码本向量组的数量。 - contrastive_logits_temperature (
float, 可选，默认为 0.1) — 对比损失中的温度系数 kappa。 - feat_quantizer_dropout (
float, 可选，默认为 0.0) — 量化器使用的特征编码器输出的 dropout 概率。 - num_negatives (
int, 可选，默认为 100) — 对比损失的负样本数。 - codevector_dim (
int, 可选，默认为 256) — 量化特征向量的维度。 - proj_codevector_dim (
int, 可选，默认为 256) — 量化特征和 Transformer 特征的最终投影的维度。 - diversity_loss_weight (
int, 可选，默认为 0.1) — 码本多样性损失分量的权重。 - ctc_loss_reduction (
str, 可选，默认为"sum") — 指定应用于torch.nn.CTCLoss输出的缩减方式。 仅在训练 Wav2Vec2ForCTC 的实例时相关。 - ctc_zero_infinity (
bool, 可选，默认为False) — 是否将torch.nn.CTCLoss的无限损失和相关梯度归零。 当输入太短而无法与目标对齐时，主要会发生无限损失。 仅在训练 Wav2Vec2ForCTC 的实例时相关。 - use_weighted_layer_sum (
bool, 可选，默认为False) — 是否使用层输出的加权平均值以及学习的权重。 仅在使用 Wav2Vec2ForSequenceClassification 的实例时相关。 - classifier_proj_size (
int, 可选，默认为 256) — 分类前 token 均值池化之前的投影维度。 - tdnn_dim (
Tuple[int]或List[int], 可选，默认为(512, 512, 512, 512, 1500)) — 定义 XVector 模型的 TDNN 模块中每个一维卷积层的输出通道数的整数元组。 tdnn_dim 的长度定义了 TDNN 层的数量。 - tdnn_kernel (
Tuple[int]或List[int], 可选，默认为(5, 3, 3, 1, 1)) — 定义 XVector 模型的 TDNN 模块中每个一维卷积层的内核大小的整数元组。 tdnn_kernel 的长度必须与 tdnn_dim 的长度匹配。 - tdnn_dilation (
Tuple[int]或List[int], 可选，默认为(1, 2, 3, 1, 1)) — 定义 XVector 模型的 TDNN 模块中每个一维卷积层的扩张因子的整数元组。 tdnn_dilation 的长度必须与 tdnn_dim 的长度匹配。 - xvector_output_dim (
int, 可选，默认为 512) — XVector 嵌入向量的维度。 - add_adapter (
bool, 可选，默认为False) — 是否应在 Wav2Vec2 编码器的顶部堆叠卷积网络。 对于 SpeechEncoderDecoder 模型热启动 Wav2Vec2 非常有用。 - adapter_kernel_size (
int, 可选，默认为 3) — 适配器网络中卷积层的内核大小。 仅当add_adapter 为 True时相关。 - adapter_stride (
int, 可选，默认为 2) — 适配器网络中卷积层的步幅。 仅当add_adapter 为 True时相关。 - num_adapter_layers (
int, 可选，默认为 3) — 适配器网络中应使用的卷积层数。 仅当add_adapter 为 True时相关。 - adapter_attn_dim (
int, 可选) — 在每个注意力模块中使用的注意力适配器权重的维度。 使用注意力适配器的模型的示例是 facebook/mms-1b-all。 - output_hidden_size (
int, 可选) — 编码器输出层的维度。 如果未定义，则默认为 hidden-size。 仅当add_adapter 为 True时相关。
这是用于存储 Wav2Vec2Model 配置的配置类。 它用于根据指定的参数实例化 Wav2Vec2 模型，定义模型架构。 使用默认值实例化配置将产生与 Wav2Vec2 facebook/wav2vec2-base-960h 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。 阅读 PretrainedConfig 中的文档以获取更多信息。
示例
>>> from transformers import Wav2Vec2Config, Wav2Vec2Model
>>> # Initializing a Wav2Vec2 facebook/wav2vec2-base-960h style configuration
>>> configuration = Wav2Vec2Config()
>>> # Initializing a model (with random weights) from the facebook/wav2vec2-base-960h style configuration
>>> model = Wav2Vec2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configWav2Vec2CTCTokenizer
class transformers.Wav2Vec2CTCTokenizer
< source >( vocab_file bos_token = '<s>' eos_token = '</s>' unk_token = '<unk>' pad_token = '<pad>' word_delimiter_token = '|' replace_word_delimiter_char = ' ' do_lower_case = False target_lang = None **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - bos_token (
str, 可选, 默认为"<s>") — 句子的起始标记。 - eos_token (
str, 可选, 默认为"</s>") — 句子的结束标记。 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。词汇表中不存在的标记无法转换为 ID，并将被设置为此标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - word_delimiter_token (
str, 可选, 默认为"|") — 用于定义单词结尾的标记。 - do_lower_case (
bool, 可选, 默认为False) — 是否接受小写输入，并在解码时将输出转换为小写。 - target_lang (
str, 可选) — 分词器应默认设置的目标语言。target_lang必须为多语言、嵌套词汇表定义，例如 facebook/mms-1b-all。 - **kwargs — 传递给 PreTrainedTokenizer 的附加关键字参数。
构建 Wav2Vec2CTC 分词器。
此分词器继承自 PreTrainedTokenizer，其中包含一些主要方法。用户应参考超类以获取有关此类方法的更多信息。
__call__
< source >( text: typing.Union[str, typing.List[str], typing.List[typing.List[str]]] = None text_pair: typing.Union[str, typing.List[str], typing.List[typing.List[str]], NoneType] = None text_target: typing.Union[str, typing.List[str], typing.List[typing.List[str]]] = None text_pair_target: typing.Union[str, typing.List[str], typing.List[typing.List[str]], NoneType] = None add_special_tokens: bool = True padding: typing.Union[bool, str, transformers.utils.generic.PaddingStrategy] = False truncation: typing.Union[bool, str, transformers.tokenization_utils_base.TruncationStrategy] = None max_length: typing.Optional[int] = None stride: int = 0 is_split_into_words: bool = False pad_to_multiple_of: typing.Optional[int] = None padding_side: typing.Optional[str] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None return_token_type_ids: typing.Optional[bool] = None return_attention_mask: typing.Optional[bool] = None return_overflowing_tokens: bool = False return_special_tokens_mask: bool = False return_offsets_mapping: bool = False return_length: bool = False verbose: bool = True **kwargs ) → BatchEncoding
参数
- 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（以消除与序列批次的歧义）。 - add_special_tokens (
bool, 可选, 默认为True) — 是否在编码序列时添加特殊标记。这将使用底层的PretrainedTokenizerBase.build_inputs_with_special_tokens函数，该函数定义了哪些标记会自动添加到 input ids 中。如果您想自动添加bos或eos标记，这将非常有用。 - padding (
bool,str或 PaddingStrategy, 可选, 默认为False) — 激活和控制填充。接受以下值：True或'longest'：填充到批次中最长的序列（如果仅提供单个序列，则不填充）。'max_length'：填充到由参数max_length指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。False或'do_not_pad'(默认)：不填充（即，可以输出具有不同长度序列的批次）。
- truncation (
bool,str或 TruncationStrategy, 可选, 默认为False) — 激活和控制截断。接受以下值：True或'longest_first'：截断为由参数max_length指定的最大长度，或者如果未提供该参数，则截断为模型可接受的最大输入长度。如果提供了一对序列（或一批对），这将逐个标记地截断，从较长序列中删除标记。'only_first'：截断为由参数max_length指定的最大长度，或者如果未提供该参数，则截断为模型可接受的最大输入长度。如果提供了一对序列（或一批对），这将仅截断第一序列。'only_second'：截断为由参数max_length指定的最大长度，或者如果未提供该参数，则截断为模型可接受的最大输入长度。如果提供了一对序列（或一批对），这将仅截断第二序列。False或'do_not_truncate'(默认)：不截断（即，可以输出序列长度大于模型最大允许输入大小的批次）。
- max_length (
int, 可选) — 控制截断/填充参数之一使用的最大长度。如果未设置或设置为
None，如果截断/填充参数之一需要最大长度，则将使用预定义的模型最大长度。如果模型没有特定的最大输入长度（如 XLNet），则将停用截断/填充到最大长度。 - stride (
int, 可选, 默认为 0) — 如果与max_length一起设置为数字，则当return_overflowing_tokens=True时返回的溢出标记将包含来自截断序列末尾的一些标记，以便在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。 - is_split_into_words (
bool, 可选, 默认为False) — 输入是否已预先分词（例如，拆分为单词）。如果设置为True，则分词器假定输入已拆分为单词（例如，通过在空格上拆分），它将对其进行分词。这对于 NER 或标记分类很有用。 - pad_to_multiple_of (
int, 可选) — 如果设置，将序列填充到提供的值的倍数。需要激活padding。这对于在计算能力>= 7.5(Volta) 的 NVIDIA 硬件上启用 Tensor Cores 的使用特别有用。 - padding_side (
str, 可选) — 模型应在其上应用填充的一侧。应在 [‘right’, ‘left’] 之间选择。默认值从同名的类属性中选取。 - return_tensors (
str或 TensorType, 可选) — 如果设置，将返回 tensors 而不是 python 整数列表。可接受的值为：'tf'：返回 TensorFlowtf.constant对象。'pt'：返回 PyTorchtorch.Tensor对象。'np'：返回 Numpynp.ndarray对象。
- return_token_type_ids (
bool, 可选) — 是否返回 token type IDs。如果保留为默认值，将根据特定分词器的默认值返回 token type IDs，由return_outputs属性定义。 - return_attention_mask (
bool, optional) — 是否返回 attention mask。如果保留为默认值，将根据特定 tokenizer 的默认值返回 attention mask，该默认值由return_outputs属性定义。 - return_overflowing_tokens (
bool, optional, defaults toFalse) — 是否返回溢出的 token 序列。如果提供一对输入 id 序列（或一批对），且truncation_strategy = longest_first或True，则会引发错误，而不是返回溢出的 token。 - return_special_tokens_mask (
bool, optional, defaults toFalse) — 是否返回特殊 token 掩码信息。 - return_offsets_mapping (
bool, optional, defaults toFalse) — 是否为每个 token 返回(char_start, char_end)。这仅在继承自 PreTrainedTokenizerFast 的快速 tokenizer 上可用，如果使用 Python 的 tokenizer，此方法将引发
NotImplementedError。 - return_length (
bool, optional, defaults toFalse) — 是否返回编码输入的长度。 - verbose (
bool, optional, defaults toTrue) — 是否打印更多信息和警告。 - **kwargs — 传递给
self.tokenize()方法
返回值
一个 BatchEncoding，包含以下字段
-
input_ids — token id 列表，用于输入到模型中。
-
token_type_ids — token 类型 id 列表，用于输入到模型中（当
return_token_type_ids=True或如果 “token_type_ids” 在self.model_input_names中时）。 -
attention_mask — 索引列表，指定模型应注意哪些 token（当
return_attention_mask=True或如果 “attention_mask” 在self.model_input_names中时）。 -
overflowing_tokens — 溢出的 token 序列列表（当指定了
max_length且return_overflowing_tokens=True时）。 -
num_truncated_tokens — 截断的 token 数量（当指定了
max_length且return_overflowing_tokens=True时）。 -
special_tokens_mask — 0 和 1 的列表，其中 1 指定添加的特殊 token，0 指定常规序列 token（当
add_special_tokens=True且return_special_tokens_mask=True时）。 -
length — 输入的长度（当
return_length=True时）
对一个或多个序列或一对或多对序列进行 tokenization 和模型准备的主要方法。
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 output_char_offsets: bool = False output_word_offsets: bool = False **kwargs ) → str 或 Wav2Vec2CTCTokenizerOutput
参数
- token_ids (
Union[int, List[int], np.ndarray, torch.Tensor, tf.Tensor]) — token 化的输入 id 列表。可以使用__call__方法获得。 - skip_special_tokens (
bool, optional, defaults toFalse) — 是否在解码中删除特殊 token。 - clean_up_tokenization_spaces (
bool, optional) — 是否清理 tokenization 后的空格。 - output_char_offsets (
bool, optional, defaults toFalse) — 是否输出字符偏移量。字符偏移量可以与采样率和模型下采样率结合使用，以计算转录字符的时间戳。请查看下面的示例，以更好地理解如何使用
output_char_offsets。 - output_word_offsets (
bool, optional, defaults toFalse) — 是否输出单词偏移量。单词偏移量可以与采样率和模型下采样率结合使用，以计算转录单词的时间戳。请查看下面的示例，以更好地理解如何使用
output_word_offsets。 - kwargs (附加的关键字参数, optional) — 将传递给底层模型特定的解码方法。
返回值
str 或 Wav2Vec2CTCTokenizerOutput
解码句子的列表。当 output_char_offsets == True 或 output_word_offsets == True 时，将为 Wav2Vec2CTCTokenizerOutput。
使用 tokenizer 和词汇表将 id 序列转换为字符串，可以选择删除特殊 token 和清理 tokenization 后的空格。
类似于执行 self.convert_tokens_to_string(self.convert_ids_to_tokens(token_ids))。
示例
>>> # Let's see how to retrieve time steps for a model
>>> from transformers import AutoTokenizer, AutoFeatureExtractor, AutoModelForCTC
>>> from datasets import load_dataset
>>> import datasets
>>> import torch
>>> # import model, feature extractor, tokenizer
>>> model = AutoModelForCTC.from_pretrained("facebook/wav2vec2-base-960h")
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-base-960h")
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-base-960h")
>>> # load first sample of English common_voice
>>> dataset = load_dataset("mozilla-foundation/common_voice_11_0", "en", split="train", streaming=True, trust_remote_code=True)
>>> dataset = dataset.cast_column("audio", datasets.Audio(sampling_rate=16_000))
>>> dataset_iter = iter(dataset)
>>> sample = next(dataset_iter)
>>> # forward sample through model to get greedily predicted transcription ids
>>> input_values = feature_extractor(sample["audio"]["array"], return_tensors="pt").input_values
>>> logits = model(input_values).logits[0]
>>> pred_ids = torch.argmax(logits, axis=-1)
>>> # retrieve word stamps (analogous commands for `output_char_offsets`)
>>> outputs = tokenizer.decode(pred_ids, output_word_offsets=True)
>>> # compute `time_offset` in seconds as product of downsampling ratio and sampling_rate
>>> time_offset = model.config.inputs_to_logits_ratio / feature_extractor.sampling_rate
>>> word_offsets = [
... {
... "word": d["word"],
... "start_time": round(d["start_offset"] * time_offset, 2),
... "end_time": round(d["end_offset"] * time_offset, 2),
... }
... for d in outputs.word_offsets
... ]
>>> # compare word offsets with audio `en_train_0/common_voice_en_19121553.mp3` online on the dataset viewer:
>>> # https://huggingface.co/datasets/mozilla-foundation/common_voice_11_0/viewer/en
>>> word_offsets[:3]
[{'word': 'THE', 'start_time': 0.7, 'end_time': 0.78}, {'word': 'TRICK', 'start_time': 0.88, 'end_time': 1.08}, {'word': 'APPEARS', 'start_time': 1.2, 'end_time': 1.64}]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 output_char_offsets: bool = False output_word_offsets: bool = False **kwargs ) → List[str] 或 Wav2Vec2CTCTokenizerOutput
参数
- sequences (
Union[List[int], List[List[int]], np.ndarray, torch.Tensor, tf.Tensor]) — token 化的输入 id 列表。可以使用__call__方法获得。 - skip_special_tokens (
bool, optional, defaults toFalse) — 是否在解码中删除特殊 token。 - clean_up_tokenization_spaces (
bool, optional) — 是否清理 tokenization 后的空格。 - output_char_offsets (
bool, optional, defaults toFalse) — 是否输出字符偏移量。字符偏移量可以与采样率和模型下采样率结合使用，以计算转录字符的时间戳。请查看 decode() 的示例，以更好地理解如何使用
output_char_offsets。batch_decode() 的工作方式与批量输出相同。 - output_word_offsets (
bool, optional, defaults toFalse) — 是否输出单词偏移量。单词偏移量可以与采样率和模型下采样率结合使用，以计算转录单词的时间戳。请查看 decode() 的示例，以更好地理解如何使用
output_word_offsets。batch_decode() 的工作方式与批量输出相同。 - kwargs (附加的关键字参数, optional) — 将传递给底层模型特定的解码方法。
返回值
List[str] 或 Wav2Vec2CTCTokenizerOutput
解码句子的列表。当 output_char_offsets == True 或 output_word_offsets == True 时，将为 Wav2Vec2CTCTokenizerOutput。
通过调用 decode，将 token id 列表的列表转换为字符串列表。
设置嵌套多语言字典的目标语言
Wav2Vec2FeatureExtractor
class transformers.Wav2Vec2FeatureExtractor
< source >( feature_size = 1 sampling_rate = 16000 padding_value = 0.0 return_attention_mask = False do_normalize = True **kwargs )
参数
- feature_size (
int, 可选, 默认为 1) — 提取特征的特征维度。 - sampling_rate (
int, 可选, 默认为 16000) — 音频文件应数字化的采样率，以赫兹 (Hz) 表示。 - padding_value (
float, 可选, 默认为 0.0) — 用于填充 padding 值的数值。 - do_normalize (
bool, 可选, 默认为True) — 是否对输入进行零均值单位方差归一化。归一化可以显著提高某些模型的性能，例如，wav2vec2-lv60。 - return_attention_mask (
bool, 可选, 默认为False) — 是否 call() 应该返回attention_mask。已设置
config.feat_extract_norm == "group"的 Wav2Vec2 模型，例如 wav2vec2-base，没有使用attention_mask进行训练。对于此类模型，input_values应该简单地用 0 填充，并且不应传递attention_mask。对于已设置
config.feat_extract_norm == "layer"的 Wav2Vec2 模型，例如 wav2vec2-lv60，应该为批量推理传递attention_mask。
构建 Wav2Vec2 特征提取器。
此特征提取器继承自 SequenceFeatureExtractor，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
__call__
< source >( raw_speech: typing.Union[numpy.ndarray, typing.List[float], typing.List[numpy.ndarray], typing.List[typing.List[float]]] padding: typing.Union[bool, str, transformers.utils.generic.PaddingStrategy] = False max_length: typing.Optional[int] = None truncation: bool = False pad_to_multiple_of: typing.Optional[int] = None return_attention_mask: typing.Optional[bool] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None sampling_rate: typing.Optional[int] = None **kwargs )
参数
- raw_speech (
np.ndarray,List[float],List[np.ndarray],List[List[float]]) — 要填充的序列或序列批次。每个序列可以是 numpy 数组、浮点值列表、numpy 数组列表或浮点值列表的列表。必须是单声道音频，而不是立体声，即每个时间步单个浮点数。 - padding (
bool,str或 PaddingStrategy, 可选, 默认为False) — 选择一种策略来填充返回的序列（根据模型的填充侧和填充索引）：True或'longest'：填充到批次中最长的序列（如果仅提供单个序列，则不填充）。'max_length'：填充到使用参数max_length指定的最大长度，或者如果未提供该参数，则填充到模型可接受的最大输入长度。False或'do_not_pad'（默认）：不填充（即，可以输出具有不同长度序列的批次）。
- max_length (
int, 可选) — 返回列表的最大长度，以及可选的填充长度（见上文）。 - truncation (
bool) — 激活截断，以将长于 max_length 的输入序列截断为 max_length。 - pad_to_multiple_of (
int, 可选) — 如果设置，则将序列填充为所提供值的倍数。这对于在计算能力
>= 7.5(Volta) 的 NVIDIA 硬件或受益于序列长度为 128 的倍数的 TPU 上启用 Tensor Cores 的使用尤其有用。 - return_attention_mask (
bool, 可选) — 是否返回 attention mask。如果保留为默认值，将根据特定 feature_extractor 的默认值返回 attention mask。已设置
config.feat_extract_norm == "group"的 Wav2Vec2 模型，例如 wav2vec2-base，没有使用attention_mask进行训练。对于此类模型，input_values应该简单地用 0 填充，并且不应传递attention_mask。对于已设置
config.feat_extract_norm == "layer"的 Wav2Vec2 模型，例如 wav2vec2-lv60，应该为批量推理传递attention_mask。 - return_tensors (
str或 TensorType, 可选) — 如果设置，将返回 tensors 而不是 python 整数列表。可接受的值为：'tf'：返回 TensorFlowtf.constant对象。'pt'：返回 PyTorchtorch.Tensor对象。'np'：返回 Numpynp.ndarray对象。
- sampling_rate (
int, 可选) — 对raw_speech输入进行采样的采样率。强烈建议在前向调用时传递sampling_rate以防止静默错误。 - padding_value (
float, 可选, 默认为 0.0) —
对一个或多个序列进行特征化和模型准备的主要方法。
Wav2Vec2Processor
class transformers.Wav2Vec2Processor
< source >( feature_extractor tokenizer )
参数
- feature_extractor (
Wav2Vec2FeatureExtractor) — Wav2Vec2FeatureExtractor 的实例。特征提取器是必需的输入。 - tokenizer (PreTrainedTokenizer) — PreTrainedTokenizer 的实例。tokenizer 是必需的输入。
构建 Wav2Vec2 processor，它将 Wav2Vec2 特征提取器和 Wav2Vec2 CTC tokenizer 包装到单个 processor 中。
Wav2Vec2Processor 提供了 Wav2Vec2FeatureExtractor 和 PreTrainedTokenizer 的所有功能。 有关更多信息，请参阅 call() 和 decode() 的文档字符串。
__call__
< source >( audio: typing.Union[ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), typing.List[ForwardRef('np.ndarray')], typing.List[ForwardRef('torch.Tensor')]] = None text: typing.Union[str, typing.List[str], NoneType] = None images = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.wav2vec2.processing_wav2vec2.Wav2Vec2ProcessorKwargs] )
在正常模式下使用时，此方法将其所有参数转发到 Wav2Vec2FeatureExtractor 的 call() 并返回其输出。 如果在 as_target_processor() 上下文中使用，此方法将其所有参数转发到 PreTrainedTokenizer 的 call()。 有关更多信息，请参阅上述两种方法的文档字符串。
在正常模式下使用时，此方法将其所有参数转发到 Wav2Vec2FeatureExtractor 的 pad() 并返回其输出。 如果在 as_target_processor() 上下文中使用，此方法将其所有参数转发到 PreTrainedTokenizer 的 pad()。 有关更多信息，请参阅上述两种方法的文档字符串。
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()。 有关更多信息，请参阅上述方法的文档字符串。
此方法将其所有参数转发到 PreTrainedTokenizer 的 batch_decode()。 有关更多信息，请参阅此方法的文档字符串。
此方法将其所有参数转发到 PreTrainedTokenizer 的 decode()。 有关更多信息，请参阅此方法的文档字符串。
Wav2Vec2ProcessorWithLM
class transformers.Wav2Vec2ProcessorWithLM
< source >( feature_extractor: FeatureExtractionMixin tokenizer: PreTrainedTokenizerBase decoder: BeamSearchDecoderCTC )
参数
- feature_extractor (Wav2Vec2FeatureExtractor 或 SeamlessM4TFeatureExtractor) — Wav2Vec2FeatureExtractor 或 SeamlessM4TFeatureExtractor 的实例。 特征提取器是必需的输入。
- tokenizer (Wav2Vec2CTCTokenizer) — Wav2Vec2CTCTokenizer 的实例。 分词器是必需的输入。
- decoder (
pyctcdecode.BeamSearchDecoderCTC) —pyctcdecode.BeamSearchDecoderCTC的实例。 解码器是必需的输入。
构建一个 Wav2Vec2 处理器，它将 Wav2Vec2 特征提取器、Wav2Vec2 CTC 分词器和一个支持语言模型的解码器包装到单个处理器中，用于语言模型增强的语音识别解码。
在正常模式下使用时，此方法将其所有参数转发到特征提取器的 __call__() 并返回其输出。 如果在 as_target_processor() 上下文中使用，此方法将其所有参数转发到 Wav2Vec2CTCTokenizer 的 call()。 有关更多信息，请参阅上述两种方法的文档字符串。
在正常模式下使用时，此方法将其所有参数转发到特征提取器的 ~FeatureExtractionMixin.pad 并返回其输出。 如果在 as_target_processor() 上下文中使用，此方法将其所有参数转发到 Wav2Vec2CTCTokenizer 的 pad()。 有关更多信息，请参阅上述两种方法的文档字符串。
from_pretrained
< source >( pretrained_model_name_or_path **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 — 传递给 SequenceFeatureExtractor 和 PreTrainedTokenizer 的其他关键字参数
从预训练的 Wav2Vec2 处理器实例化 Wav2Vec2ProcessorWithLM。
此类方法只是调用特征提取器的 from_pretrained()、Wav2Vec2CTCTokenizer 的 from_pretrained() 和 pyctcdecode.BeamSearchDecoderCTC.load_from_hf_hub。
有关更多信息，请参阅上述方法的文档字符串。
batch_decode
< source >( logits: ndarray pool: typing.Optional[<bound method BaseContext.Pool of <multiprocessing.context.DefaultContext object at 0x7f79c4609360>>] = None num_processes: typing.Optional[int] = None beam_width: typing.Optional[int] = None beam_prune_logp: typing.Optional[float] = None token_min_logp: typing.Optional[float] = None hotwords: typing.Optional[typing.Iterable[str]] = None hotword_weight: typing.Optional[float] = None alpha: typing.Optional[float] = None beta: typing.Optional[float] = None unk_score_offset: typing.Optional[float] = None lm_score_boundary: typing.Optional[bool] = None output_word_offsets: bool = False n_best: int = 1 )
参数
- logits (
np.ndarray) — 模型的 logits 输出向量，表示每个 token 的对数概率。 - pool (
multiprocessing.Pool, 可选) — 可选的用户管理的池。 如果未设置，将自动创建和关闭一个池。 池应在Wav2Vec2ProcessorWithLM之后实例化。 否则，LM 将不可用于池的子进程。目前，仅可以使用使用“fork”上下文创建的池。 如果传递了“spawn”池，则会忽略它，而改用顺序解码。
- num_processes (
int, optional) — 如果未设置pool，则该函数应并行化的进程数。 默认为可用 CPU 的数量。 - beam_width (
int, optional) — 解码每一步的最大束数量。 默认为 pyctcdecode 的 DEFAULT_BEAM_WIDTH。 - beam_prune_logp (
int, optional) — 比最佳束差很多的束将被剪枝。 默认为 pyctcdecode 的 DEFAULT_PRUNE_LOGP。 - token_min_logp (
int, optional) — 低于此 logp 的 tokens 将被跳过，除非它们是帧的 argmax。 默认为 pyctcdecode 的 DEFAULT_MIN_TOKEN_LOGP。 - hotwords (
List[str], optional) — 具有额外重要性的单词列表，可以是 LM 的 OOV - hotword_weight (
int, optional) — 热词重要性的权重因子。 默认为 pyctcdecode 的 DEFAULT_HOTWORD_WEIGHT。 - alpha (
float, optional) — 浅层融合期间语言模型的权重 - beta (
float, optional) — 用于评分期间长度分数调整的权重 - unk_score_offset (
float, optional) — 未知 tokens 的对数分数偏移量 - lm_score_boundary (
bool, optional) — 是否让 kenlm 在评分时考虑边界 - output_word_offsets (
bool, optional, defaults toFalse) — 是否输出单词偏移量。 单词偏移量可以与采样率和模型下采样率结合使用，以计算转录单词的时间戳。 - n_best (
int, optional, defaults to1) — 要返回的最佳假设数。 如果n_best大于 1，则返回的text将是字符串列表的列表，logit_score将是浮点数列表的列表，而lm_score将是浮点数列表的列表，其中外部列表的长度将对应于批次大小，内部列表的长度将对应于返回的假设数。 该值应 >= 1。请查看 decode() 的示例，以更好地理解如何使用
output_word_offsets。 batch_decode() 的工作方式与批量输出相同。
使用语言模型支持批量解码输出 logits 为音频转录。
此函数使用 Python 的多进程处理。 目前，多进程处理仅在 Unix 系统上可用（请参阅此 issue）。
如果要解码多个批次，请考虑创建 Pool 并将其传递给 batch_decode。 否则，batch_decode 将非常慢，因为它会为每次调用创建一个新的 Pool。 请参阅下面的用法示例。
示例：请参阅 解码多个音频。
decode
< source >( logits: ndarray beam_width: typing.Optional[int] = None beam_prune_logp: typing.Optional[float] = None token_min_logp: typing.Optional[float] = None hotwords: typing.Optional[typing.Iterable[str]] = None hotword_weight: typing.Optional[float] = None alpha: typing.Optional[float] = None beta: typing.Optional[float] = None unk_score_offset: typing.Optional[float] = None lm_score_boundary: typing.Optional[bool] = None output_word_offsets: bool = False n_best: int = 1 )
参数
- logits (
np.ndarray) — 模型的 logits 输出向量，表示每个 token 的对数概率。 - beam_width (
int, optional) — 解码每一步的最大束数量。 默认为 pyctcdecode 的 DEFAULT_BEAM_WIDTH。 - beam_prune_logp (
int, optional) — 用于剪枝的阈值，将对数概率小于 best_beam_logp + beam_prune_logp 的束剪枝。 该值应 <= 0。 默认为 pyctcdecode 的 DEFAULT_PRUNE_LOGP。 - token_min_logp (
int, optional) — 对数概率低于 token_min_logp 的 tokens 将被跳过，除非它们是 utterance 的最大对数概率。 默认为 pyctcdecode 的 DEFAULT_MIN_TOKEN_LOGP。 - hotwords (
List[str], optional) — 具有额外重要性的单词列表，可以从 LM 的词汇表中缺失，例如 [“huggingface”] - hotword_weight (
int, optional) — 提升热词分数的权重乘数。 默认为 pyctcdecode 的 DEFAULT_HOTWORD_WEIGHT。 - alpha (
float, optional) — 浅层融合期间语言模型的权重 - beta (
float, optional) — 用于评分期间长度分数调整的权重 - unk_score_offset (
float, optional) — 未知 tokens 的对数分数偏移量 - lm_score_boundary (
bool, optional) — 是否让 kenlm 在评分时考虑边界 - output_word_offsets (
bool, optional, defaults toFalse) — 是否输出单词偏移量。 单词偏移量可以与采样率和模型下采样率结合使用，以计算转录单词的时间戳。 - n_best (
int, optional, defaults to1) — 要返回的最佳假设数。 如果n_best大于 1，则返回的text将是字符串列表，logit_score将是浮点数列表，而lm_score将是浮点数列表，其中这些列表的长度将对应于返回的假设数。 该值应 >= 1。请查看下面的示例，以更好地理解如何使用
output_word_offsets。
使用语言模型支持解码输出 logits 为音频转录。
示例
>>> # Let's see how to retrieve time steps for a model
>>> from transformers import AutoTokenizer, AutoProcessor, AutoModelForCTC
>>> from datasets import load_dataset
>>> import datasets
>>> import torch
>>> # import model, feature extractor, tokenizer
>>> model = AutoModelForCTC.from_pretrained("patrickvonplaten/wav2vec2-base-100h-with-lm")
>>> processor = AutoProcessor.from_pretrained("patrickvonplaten/wav2vec2-base-100h-with-lm")
>>> # load first sample of English common_voice
>>> dataset = load_dataset("mozilla-foundation/common_voice_11_0", "en", split="train", streaming=True, trust_remote_code=True)
>>> dataset = dataset.cast_column("audio", datasets.Audio(sampling_rate=16_000))
>>> dataset_iter = iter(dataset)
>>> sample = next(dataset_iter)
>>> # forward sample through model to get greedily predicted transcription ids
>>> input_values = processor(sample["audio"]["array"], return_tensors="pt").input_values
>>> with torch.no_grad():
... logits = model(input_values).logits[0].cpu().numpy()
>>> # retrieve word stamps (analogous commands for `output_char_offsets`)
>>> outputs = processor.decode(logits, output_word_offsets=True)
>>> # compute `time_offset` in seconds as product of downsampling ratio and sampling_rate
>>> time_offset = model.config.inputs_to_logits_ratio / processor.feature_extractor.sampling_rate
>>> word_offsets = [
... {
... "word": d["word"],
... "start_time": round(d["start_offset"] * time_offset, 2),
... "end_time": round(d["end_offset"] * time_offset, 2),
... }
... for d in outputs.word_offsets
... ]
>>> # compare word offsets with audio `en_train_0/common_voice_en_19121553.mp3` online on the dataset viewer:
>>> # https://huggingface.co/datasets/mozilla-foundation/common_voice_11_0/viewer/en
>>> word_offsets[:4]
[{'word': 'THE', 'start_time': 0.68, 'end_time': 0.78}, {'word': 'TRACK', 'start_time': 0.88, 'end_time': 1.1}, {'word': 'APPEARS', 'start_time': 1.18, 'end_time': 1.66}, {'word': 'ON', 'start_time': 1.86, 'end_time': 1.92}]解码多个音频
如果您计划解码多个批次的音频，则应考虑使用 batch_decode() 并传递实例化的 multiprocessing.Pool。 否则，batch_decode() 的性能将比单独为每个音频调用 decode() 慢，因为它会在每次调用内部实例化一个新的 Pool。 请参阅下面的示例
>>> # Let's see how to use a user-managed pool for batch decoding multiple audios
>>> from multiprocessing import get_context
>>> from transformers import AutoTokenizer, AutoProcessor, AutoModelForCTC
>>> from datasets import load_dataset
>>> import datasets
>>> import torch
>>> # import model, feature extractor, tokenizer
>>> model = AutoModelForCTC.from_pretrained("patrickvonplaten/wav2vec2-base-100h-with-lm").to("cuda")
>>> processor = AutoProcessor.from_pretrained("patrickvonplaten/wav2vec2-base-100h-with-lm")
>>> # load example dataset
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> dataset = dataset.cast_column("audio", datasets.Audio(sampling_rate=16_000))
>>> def map_to_array(batch):
... batch["speech"] = batch["audio"]["array"]
... return batch
>>> # prepare speech data for batch inference
>>> dataset = dataset.map(map_to_array, remove_columns=["audio"])
>>> def map_to_pred(batch, pool):
... inputs = processor(batch["speech"], sampling_rate=16_000, padding=True, return_tensors="pt")
... inputs = {k: v.to("cuda") for k, v in inputs.items()}
... with torch.no_grad():
... logits = model(**inputs).logits
... transcription = processor.batch_decode(logits.cpu().numpy(), pool).text
... batch["transcription"] = transcription
... return batch
>>> # note: pool should be instantiated *after* `Wav2Vec2ProcessorWithLM`.
>>> # otherwise, the LM won't be available to the pool's sub-processes
>>> # select number of processes and batch_size based on number of CPU cores available and on dataset size
>>> with get_context("fork").Pool(processes=2) as pool:
... result = dataset.map(
... map_to_pred, batched=True, batch_size=2, fn_kwargs={"pool": pool}, remove_columns=["speech"]
... )
>>> result["transcription"][:2]
['MISTER QUILTER IS THE APOSTLE OF THE MIDDLE CLASSES AND WE ARE GLAD TO WELCOME HIS GOSPEL', "NOR IS MISTER COULTER'S MANNER LESS INTERESTING THAN HIS MATTER"]Wav2Vec2 特定输出
class transformers.models.wav2vec2_with_lm.processing_wav2vec2_with_lm.Wav2Vec2DecoderWithLMOutput
< source >( text: typing.Union[typing.List[typing.List[str]], typing.List[str], str] logit_score: typing.Union[typing.List[typing.List[float]], typing.List[float], float] = None lm_score: typing.Union[typing.List[typing.List[float]], typing.List[float], float] = None word_offsets: typing.Union[typing.List[typing.List[typing.List[typing.Dict[str, typing.Union[int, str]]]]], typing.List[typing.List[typing.Dict[str, typing.Union[int, str]]]], typing.List[typing.Dict[str, typing.Union[int, str]]]] = None )
Wav2Vec2DecoderWithLM 的输出类型，带有转录。
class transformers.modeling_outputs.Wav2Vec2BaseModelOutput
< source >( last_hidden_state: FloatTensor = None extract_features: FloatTensor = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None attentions: typing.Optional[typing.Tuple[torch.FloatTensor, ...]] = None )
参数
- last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层的输出处的隐藏状态序列。 - extract_features (形状为
(batch_size, sequence_length, conv_dim[-1])的torch.FloatTensor) — 模型最后一个卷积层的提取特征向量序列。 - 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
已使用 Wav2Vec2 损失目标训练的模型的基类。
class transformers.models.wav2vec2.modeling_wav2vec2.Wav2Vec2ForPreTrainingOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None projected_states: FloatTensor = None projected_quantized_states: FloatTensor = None codevector_perplexity: FloatTensor = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None contrastive_loss: typing.Optional[torch.FloatTensor] = None diversity_loss: typing.Optional[torch.FloatTensor] = None )
参数
- loss (可选, 当传递
sample_negative_indices时返回, 形状为(1,)的torch.FloatTensor) — 总损失，为对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。（分类）损失。 - projected_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的torch.FloatTensor) — 模型隐藏状态投影到 config.proj_codevector_dim，可用于预测被掩码的投影量化状态。 - projected_quantized_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的torch.FloatTensor) — 量化的提取特征向量投影到 config.proj_codevector_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 之后的注意力权重，用于计算自注意力头中的加权平均值。
- contrastive_loss (可选, 当传递
sample_negative_indices时返回, 形状为(1,)的torch.FloatTensor) — 对比损失 (L_m)，如 官方论文 中所述。 - diversity_loss (可选, 当传递
sample_negative_indices时返回, 形状为(1,)的torch.FloatTensor) — 多样性损失 (L_d)，如 官方论文 中所述。
Wav2Vec2ForPreTraining 的输出类型，具有潜在的隐藏状态和注意力。
class transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2BaseModelOutput
< source >( last_hidden_state: Array = None extract_features: Array = None hidden_states: typing.Optional[typing.Tuple[jax.Array]] = None attentions: typing.Optional[typing.Tuple[jax.Array]] = None )
参数
- last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最后一层的输出处的隐藏状态序列。 - extract_features (形状为
(batch_size, sequence_length, last_conv_dim)的jnp.ndarray) — 模型最后一个卷积层的提取特征向量序列，其中last_conv_dim是最后一个卷积层的维度。 - hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray的元组（每个嵌入输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出端的隐藏状态，加上初始嵌入输出。
- attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2BaseModelOutput 的输出类型，具有潜在的隐藏状态和注意力。
“返回一个新对象，该对象使用新值替换指定的字段。
class transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2ForPreTrainingOutput
< source >( projected_states: Array = None projected_quantized_states: Array = None codevector_perplexity: Array = None hidden_states: typing.Optional[typing.Tuple[jax.Array]] = None attentions: typing.Optional[typing.Tuple[jax.Array]] = None )
参数
- loss (可选, 模型在训练模式下返回,
jnp.ndarray形状为(1,)) — 总损失，为对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。(分类) 损失。 - projected_states (
jnp.ndarray形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 模型隐藏状态投影到 config.proj_codevector_dim 维度，可用于预测 masked projected quantized states。 - projected_quantized_states (
jnp.ndarray形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 量化的提取特征向量投影到 config.proj_codevector_dim 维度，表示对比损失的正目标向量。 - hidden_states (
tuple(jnp.ndarray), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray的元组 (每个层的输出以及初始嵌入输出各一个)，形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上初始嵌入输出。
- attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray的元组 (每层一个)，形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2ForPreTrainingOutput 的输出类型，可能包含隐藏状态和注意力。
“返回一个新对象，该对象使用新值替换指定的字段。
Wav2Vec2Model
class transformers.Wav2Vec2Model
< source >( config: Wav2Vec2Config )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法加载模型权重。
裸 Wav2Vec2 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。Wav2Vec2 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法 (例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None mask_time_indices: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 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), 可选) — 掩码，以避免在 padding 标记索引上执行卷积和注意力机制。掩码值在[0, 1]中选择：- 1 表示 未被掩盖 的标记，
- 0 表示 被掩盖 的标记。
只有当对应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应 传递attention_mask，以避免在执行批量推理时性能下降。对于此类模型，input_values应该简单地用 0 填充并传递，而无需attention_mask。请注意，这些模型的结果也会略有不同，具体取决于input_values是否填充。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。
返回值
transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 torch.FloatTensor 元组 (如果传递 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。 -
extract_features (
torch.FloatTensor形状为(batch_size, sequence_length, conv_dim[-1])) — 模型最后一层卷积层的提取特征向量序列。 -
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 之后的权重，用于计算自注意力头中的加权平均值。
Wav2Vec2Model forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, Wav2Vec2Model
>>> 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("facebook/wav2vec2-base-960h")
>>> model = Wav2Vec2Model.from_pretrained("facebook/wav2vec2-base-960h")
>>> # 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]Wav2Vec2ForCTC
class transformers.Wav2Vec2ForCTC
< source >( config target_lang: typing.Optional[str] = None )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法加载模型权重。
- target_lang (
str, 可选) — 适配器权重的语言 ID。适配器权重以 adapter.<lang>.safetensors 或 adapter.<lang>.bin 格式存储。仅在使用带有适配器的 Wav2Vec2ForCTC 实例时相关。默认使用 ‘eng’。
带有用于 Connectionist Temporal Classification (CTC) 的 语言建模 head 的 Wav2Vec2 模型。Wav2Vec2 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法 (例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = 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), 可选) — 掩码，以避免在 padding 标记索引上执行卷积和注意力机制。掩码值在[0, 1]中选择：- 1 表示 未被掩盖 的标记，
- 0 表示 被掩盖 的标记。
只有当对应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应 传递attention_mask，以避免在执行批量推理时性能下降。对于此类模型，input_values应该简单地用 0 填充并传递，而无需attention_mask。请注意，这些模型的结果也会略有不同，具体取决于input_values是否填充。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。详见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。详见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。 - labels (形状为
(batch_size, target_length)的torch.LongTensor, optional) — 用于连接时序分类的标签。请注意，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 时），包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
loss (形状为
(1,)的torch.FloatTensor, optional, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递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 之后的权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForCTC 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, Wav2Vec2ForCTC
>>> 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("facebook/wav2vec2-base-960h")
>>> model = Wav2Vec2ForCTC.from_pretrained("facebook/wav2vec2-base-960h")
>>> # 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 APOSTLE 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)
53.48load_adapter
< source >( target_lang: str force_load = True **kwargs )
参数
- target_lang (
str) — 必须是现有适配器权重的语言 ID。适配器权重以adapter.<lang>.safetensors或adapter.<lang>.bin格式存储 - force_load (
bool, 默认为True) — 即使target_lang与self.target_lang匹配，是否仍应加载权重。 - cache_dir (
Union[str, os.PathLike], optional) — 下载的预训练模型配置应缓存到的目录路径，如果不想使用标准缓存。 - force_download (
bool, optional, 默认为False) — 是否强制（重新）下载模型权重和配置文件，覆盖已存在的缓存版本。 - resume_download — 已弃用并忽略。现在所有下载在可能的情况下默认恢复。将在 Transformers v5 中移除。
- proxies (
Dict[str, str], optional) — 要按协议或端点使用的代理服务器字典，例如，{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。代理用于每个请求。 - local_files_only(
bool, optional, 默认为False) — 是否仅查看本地文件（即，不尝试下载模型）。 - token (
str或bool, optional) — 用作远程文件 HTTP Bearer 授权的 token。如果为True或未指定，将使用运行huggingface-cli login时生成的 token（存储在~/.huggingface中）。 - revision (
str, optional, 默认为"main") — 要使用的特定模型版本。它可以是分支名称、标签名称或提交 ID，因为我们使用基于 git 的系统在 huggingface.co 上存储模型和其他工件，因此revision可以是 git 允许的任何标识符。要测试您在 Hub 上创建的拉取请求，您可以传递
revision="refs/pr/<pr_number>"。 - mirror (
str, optional) — 镜像源以加速在中国的下载。如果您来自中国并且遇到访问问题，您可以设置此选项来解决它。请注意，我们不保证及时性或安全性。有关更多信息，请参阅镜像站点。
从预训练的适配器模型加载语言适配器模型。
激活特殊的 “离线模式” 以在防火墙环境中使用此方法。
示例
>>> from transformers import Wav2Vec2ForCTC, AutoProcessor
>>> ckpt = "facebook/mms-1b-all"
>>> processor = AutoProcessor.from_pretrained(ckpt)
>>> model = Wav2Vec2ForCTC.from_pretrained(ckpt, target_lang="eng")
>>> # set specific language
>>> processor.tokenizer.set_target_lang("spa")
>>> model.load_adapter("spa")Wav2Vec2ForSequenceClassification
class transformers.Wav2Vec2ForSequenceClassification
< source >( config )
参数
- config (Wav2Vec2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
Wav2Vec2 模型，顶部带有序列分类头（池化输出之上的线性层），用于诸如 SUPERB 关键词识别之类的任务。
Wav2Vec2 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed 和 Michael Auli 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法 (例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_values (形状为
(batch_size, sequence_length)的torch.FloatTensor) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型的数组中获得，例如通过 soundfile 库（pip install soundfile）。要将数组准备为input_values，应使用 AutoProcessor 进行填充和转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.__call__()。 - attention_mask (形状为
(batch_size, sequence_length)的torch.LongTensor, optional) — 用于避免对填充 token 索引执行卷积和注意力的掩码。掩码值在[0, 1]中选择:- 1 表示未掩码的 token，
- 0 表示已掩码的 token。
只有当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应传递attention_mask，以避免在进行批量推理时性能下降。对于此类模型，input_values应简单地用 0 填充并在没有attention_mask的情况下传递。请注意，这些模型也会根据input_values是否填充而产生略微不同的结果。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。详见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。详见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。 - labels (形状为
(batch_size,)的torch.LongTensor, optional) — 用于计算序列分类/回归损失的标签。索引应在[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 时），包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
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), optional, 当传递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 之后的权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForSequenceClassification 的 forward 方法，重写了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, Wav2Vec2ForSequenceClassification
>>> 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("superb/wav2vec2-base-superb-ks")
>>> model = Wav2Vec2ForSequenceClassification.from_pretrained("superb/wav2vec2-base-superb-ks")
>>> # 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]
>>> predicted_label
'_unknown_'
>>> # 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).loss
>>> round(loss.item(), 2)
6.54Wav2Vec2ForAudioFrameClassification
class transformers.Wav2Vec2ForAudioFrameClassification
< source >( config )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有帧分类头的 Wav2Vec2 模型，用于诸如说话人日志之类的任务。
Wav2Vec2 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed 和 Michael Auli 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法 (例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = 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 表示被掩盖的标记。
只有当相应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应传递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 时），包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.num_labels)) — 分类得分（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递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 之后的权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForAudioFrameClassification 的 forward 方法，重写了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, Wav2Vec2ForAudioFrameClassification
>>> 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("anton-l/wav2vec2-base-superb-sd")
>>> model = Wav2Vec2ForAudioFrameClassification.from_pretrained("anton-l/wav2vec2-base-superb-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]Wav2Vec2ForXVector
class transformers.Wav2Vec2ForXVector
< source >( config )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有 XVector 特征提取头的 Wav2Vec2 模型，用于诸如说话人验证之类的任务。
Wav2Vec2 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed 和 Michael Auli 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法 (例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = 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类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.__call__()。 - attention_mask (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在填充标记索引上执行卷积和注意力。掩码值在[0, 1]中选择：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
只有当相应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应传递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 时)，包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, config.xvector_output_dim)的torch.FloatTensor) — AMSoftmax 之前的分类隐藏状态。 -
embeddings (形状为
(batch_size, config.xvector_output_dim)的torch.FloatTensor) — 用于基于向量相似度检索的 utterance embeddings（话语嵌入）。 -
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 之后的权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForXVector 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, Wav2Vec2ForXVector
>>> 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("anton-l/wav2vec2-base-superb-sv")
>>> model = Wav2Vec2ForXVector.from_pretrained("anton-l/wav2vec2-base-superb-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.98Wav2Vec2ForPreTraining
class transformers.Wav2Vec2ForPreTraining
< source >( config: Wav2Vec2Config )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有量化器和 VQ 头的 Wav2Vec2 模型。Wav2Vec2 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法 (例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None mask_time_indices: typing.Optional[torch.BoolTensor] = None sampled_negative_indices: typing.Optional[torch.BoolTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.wav2vec2.modeling_wav2vec2.Wav2Vec2ForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_values (形状为
(batch_size, sequence_length)的torch.FloatTensor) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]类型的数组或numpy.ndarray中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备成input_values，应该使用 AutoProcessor 进行填充和转换为torch.FloatTensor类型的张量。 有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 用于避免在 padding token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
只有当对应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应传递attention_mask，以避免在进行批量推理时性能下降。对于此类模型，input_values应简单地用 0 填充并在不使用attention_mask的情况下传递。请注意，这些模型的结果也会因input_values是否填充而略有不同。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的 attentions 张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。 - mask_time_indices (形状为
(batch_size, sequence_length)的torch.BoolTensor, 可选) — 用于对比损失的掩码提取特征的索引。当处于训练模式时，模型学习预测 config.proj_codevector_dim 空间中被掩码的提取特征。 - sampled_negative_indices (形状为
(batch_size, sequence_length, num_negatives)的torch.BoolTensor, 可选) — 指示哪些量化的目标向量在对比损失中用作负采样的向量的索引。 预训练的必需输入。
返回值
transformers.models.wav2vec2.modeling_wav2vec2.Wav2Vec2ForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.wav2vec2.modeling_wav2vec2.Wav2Vec2ForPreTrainingOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
loss (可选, 当传递
sample_negative_indices时返回, 形状为(1,)的torch.FloatTensor) — 总损失，为对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。(分类) 损失。 -
projected_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的torch.FloatTensor) — 模型投影到 config.proj_codevector_dim 的 hidden-states，可用于预测被掩码的投影量化状态。 -
projected_quantized_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的torch.FloatTensor) — 投影到 config.proj_codevector_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 之后的权重，用于计算自注意力头中的加权平均值。
-
contrastive_loss (可选, 当传递
sample_negative_indices时返回, 形状为(1,)的torch.FloatTensor) — 对比损失 (L_m)，如 官方论文 中所述。 -
diversity_loss (可选, 当传递
sample_negative_indices时返回, 形状为(1,)的torch.FloatTensor) — 多样性损失 (L_d)，如 官方论文 中所述。
Wav2Vec2ForPreTraining 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoFeatureExtractor, Wav2Vec2ForPreTraining
>>> from transformers.models.wav2vec2.modeling_wav2vec2 import _compute_mask_indices, _sample_negative_indices
>>> from datasets import load_dataset
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-base")
>>> model = Wav2Vec2ForPreTraining.from_pretrained("facebook/wav2vec2-base")
>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> input_values = feature_extractor(ds[0]["audio"]["array"], return_tensors="pt").input_values # Batch size 1
>>> # compute masked indices
>>> batch_size, raw_sequence_length = input_values.shape
>>> sequence_length = model._get_feat_extract_output_lengths(raw_sequence_length).item()
>>> mask_time_indices = _compute_mask_indices(
... shape=(batch_size, sequence_length), mask_prob=0.2, mask_length=2
... )
>>> sampled_negative_indices = _sample_negative_indices(
... features_shape=(batch_size, sequence_length),
... num_negatives=model.config.num_negatives,
... mask_time_indices=mask_time_indices,
... )
>>> mask_time_indices = torch.tensor(data=mask_time_indices, device=input_values.device, dtype=torch.long)
>>> sampled_negative_indices = torch.tensor(
... data=sampled_negative_indices, device=input_values.device, dtype=torch.long
... )
>>> with torch.no_grad():
... outputs = model(input_values, mask_time_indices=mask_time_indices)
>>> # compute cosine similarity between predicted (=projected_states) and target (=projected_quantized_states)
>>> cosine_sim = torch.cosine_similarity(outputs.projected_states, outputs.projected_quantized_states, dim=-1)
>>> # show that cosine similarity is much higher than random
>>> cosine_sim[mask_time_indices.to(torch.bool)].mean() > 0.5
tensor(True)
>>> # for contrastive loss training model should be put into train mode
>>> model = model.train()
>>> loss = model(
... input_values, mask_time_indices=mask_time_indices, sampled_negative_indices=sampled_negative_indices
... ).lossTFWav2Vec2Model
class transformers.TFWav2Vec2Model
< source >( config: Wav2Vec2Config *inputs **kwargs )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
Bare TFWav2Vec2 Model transformer，输出原始 hidden-states，顶部没有任何特定的 head。
此模型继承自 TFPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与通用用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或者
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，您应该可以“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用三种可能性来收集第一个位置参数中的所有输入张量
- 一个仅包含
input_values且不包含其他内容的单个张量：model(input_values) - 一个长度可变的列表，其中包含一个或多个输入张量，顺序与文档字符串中给出的顺序相同：
model([input_values, attention_mask])或model([input_values, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个输入张量，与文档字符串中给出的输入名称相关联：
model({"input_values": input_values, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_values: tf.Tensor attention_mask: tf.Tensor | None = None token_type_ids: tf.Tensor | None = None position_ids: tf.Tensor | None = None head_mask: tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
参数
- input_values (
np.ndarray,tf.Tensor,List[tf.Tensor]Dict[str, tf.Tensor]或Dict[str, np.ndarray]并且每个示例都必须具有形状({0})) — 词汇表中输入序列 tokens 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
({0})的np.ndarray或tf.Tensor, 可选) — 用于避免在 padding token 索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
- token_type_ids (形状为
({0})的np.ndarray或tf.Tensor, 可选) — Segment token indices（段 token 索引）用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
np.ndarray或tf.Tensor，形状为({0})，可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头是未被掩蔽的，
- 0 表示头是被掩蔽的。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为({0}, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_values。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_values索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通元组。此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。
返回值
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
last_hidden_state (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。 -
hidden_states (
tuple(tf.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的元组（embeddings 的输出一个，每层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的权重，用于计算自注意力头中的加权平均值。
TFWav2Vec2Model forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, TFWav2Vec2Model
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> processor = AutoProcessor.from_pretrained("facebook/wav2vec2-base-960h")
>>> model = TFWav2Vec2Model.from_pretrained("facebook/wav2vec2-base-960h")
>>> 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)
>>> input_values = processor(ds["speech"][0], return_tensors="tf").input_values # Batch size 1
>>> hidden_states = model(input_values).last_hidden_stateTFWav2Vec2ForSequenceClassification
call
< source >( input_values: tf.Tensor attention_mask: tf.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None labels: tf.Tensor | None = None training: bool = False )
TFWav2Vec2ForCTC
class transformers.TFWav2Vec2ForCTC
< source >( config: Wav2Vec2Config *inputs **kwargs )
参数
- config (Wav2Vec2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 language modeling 头的 TFWav2Vec2 模型，用于 Connectionist Temporal Classification (CTC)。
此模型继承自 TFPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝 head 等）。
此模型也是 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与通用用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或者
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用 model.fit() 等方法时，您应该可以“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用三种可能性来收集第一个位置参数中的所有输入张量
- 一个仅包含
input_values且不包含其他内容的单个张量：model(input_values) - 一个长度可变的列表，其中包含一个或多个输入张量，顺序与文档字符串中给出的顺序相同：
model([input_values, attention_mask])或model([input_values, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个输入张量，与文档字符串中给出的输入名称相关联：
model({"input_values": input_values, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_values: tf.Tensor attention_mask: tf.Tensor | None = None token_type_ids: tf.Tensor | None = None position_ids: tf.Tensor | None = None head_mask: tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None labels: tf.Tensor | None = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFCausalLMOutput 或 tuple(tf.Tensor)
参数
- input_values (
np.ndarray,tf.Tensor,List[tf.Tensor]Dict[str, tf.Tensor]或Dict[str, np.ndarray]，并且每个示例都必须具有形状({0})) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形状为({0})，可选) — 掩码，以避免对填充标记索引执行注意力机制。掩码值在[0, 1]中选择：- 1 表示标记未被掩蔽，
- 0 表示标记被掩蔽。
- token_type_ids (
np.ndarray或tf.Tensor，形状为({0})，可选) — 段落标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
np.ndarray或tf.Tensor，形状为({0})，可选) — 位置嵌入中每个输入序列标记的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头是未被掩蔽的，
- 0 表示头是被掩蔽的。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为({0}, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_values。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_values索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为 `False`) — 是否在训练模式下使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor或np.ndarray，形状为(batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_values文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。
返回值
transformers.modeling_tf_outputs.TFCausalLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutput 或 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。
-
loss (
tf.Tensor，形状为(n,), optional, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测得分（SoftMax 之前每个词汇表 token 的得分）。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（embeddings 输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的权重，用于计算自注意力头中的加权平均值。
TFWav2Vec2ForCTC 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import tensorflow as tf
>>> from transformers import AutoProcessor, TFWav2Vec2ForCTC
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> processor = AutoProcessor.from_pretrained("facebook/wav2vec2-base-960h")
>>> model = TFWav2Vec2ForCTC.from_pretrained("facebook/wav2vec2-base-960h")
>>> 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)
>>> input_values = processor(ds["speech"][0], return_tensors="tf").input_values # Batch size 1
>>> logits = model(input_values).logits
>>> predicted_ids = tf.argmax(logits, axis=-1)
>>> transcription = processor.decode(predicted_ids[0])
>>> # compute loss
>>> target_transcription = "A MAN SAID TO THE UNIVERSE SIR I EXIST"
>>> # Pass transcription as `text` to encode labels
>>> labels = processor(text=transcription, return_tensors="tf").input_ids
>>> loss = model(input_values, labels=labels).lossFlaxWav2Vec2Model
class transformers.FlaxWav2Vec2Model
< source >( config: Wav2Vec2Config input_shape: typing.Tuple = (1, 1024) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, optional, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 之一。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
裸 Wav2Vec2 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。Wav2Vec2 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
此模型继承自 FlaxPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝头等）。
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参考 Flax 文档了解与通用用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 特性，例如
__call__
< source >( input_values attention_mask = None mask_time_indices = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None freeze_feature_encoder: bool = False return_dict: typing.Optional[bool] = None ) → transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
jnp.ndarray，形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]类型数组或numpy.ndarray中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备为input_values，应使用 AutoProcessor 进行填充并转换为jnp.ndarray类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.__call__()。 - attention_mask (
jnp.ndarray，形状为(batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
什么是注意力掩码？ .. warning:: 只有当相应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应 传递attention_mask，以避免在进行批量推理时性能下降。对于此类模型，input_values应简单地用 0 填充并传递，而无需attention_mask。请注意，这些模型也会产生略有不同的结果，具体取决于input_values是否填充。 - mask_time_indices (
jnp.ndarray，形状为(batch_size, sequence_length), optional) — 用于掩码提取特征以进行对比损失的索引。在训练模式下，模型学习预测 config.proj_codevector_dim 空间中被掩码的提取特征。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。
返回值
transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2BaseModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (<class 'transformers.models.wav2vec2.configuration_wav2vec2.Wav2Vec2Config'>) 和输入。
-
last_hidden_state (
jnp.ndarray，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出端的隐藏状态序列。 -
extract_features (
jnp.ndarray，形状为(batch_size, sequence_length, last_conv_dim)) — 模型最后一层卷积层提取的特征向量序列，其中last_conv_dim是最后一层卷积层的维度。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2PreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, FlaxWav2Vec2Model
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> processor = AutoProcessor.from_pretrained("facebook/wav2vec2-large-lv60")
>>> model = FlaxWav2Vec2Model.from_pretrained("facebook/wav2vec2-large-lv60")
>>> 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)
>>> input_values = processor(
... ds["speech"][0], sampling_rate=16_000, return_tensors="np"
... ).input_values # Batch size 1
>>> hidden_states = model(input_values).last_hidden_stateFlaxWav2Vec2ForCTC
class transformers.FlaxWav2Vec2ForCTC
< source >( config: Wav2Vec2Config input_shape: typing.Tuple = (1, 1024) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, optional, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 之一。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。请注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
带有用于 Connectionist Temporal Classification (CTC) 的 语言建模 head 的 Wav2Vec2 模型。Wav2Vec2 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
此模型继承自 FlaxPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝头等）。
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参考 Flax 文档了解与通用用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 特性，例如
__call__
< source >( input_values attention_mask = None mask_time_indices = None params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None freeze_feature_encoder: bool = False return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput or tuple(torch.FloatTensor)
参数
- input_values (形状为
(batch_size, sequence_length)的jnp.ndarray) — 输入原始语音波形的浮点数值。这些值可以通过将.flac或.wav音频文件加载到List[float]类型或numpy.ndarray类型的数组中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备为input_values，应该使用 AutoProcessor 进行填充并转换为jnp.ndarray类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (形状为
(batch_size, sequence_length)的jnp.ndarray, 可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
什么是注意力掩码？ .. warning:: 只有当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应 传递attention_mask，以避免在进行批量推理时性能下降。对于此类模型，input_values应该简单地用 0 填充，并在不使用attention_mask的情况下传递。请注意，这些模型也会根据input_values是否填充而产生略有不同的结果。 - mask_time_indices (形状为
(batch_size, sequence_length)的jnp.ndarray, 可选) — 用于掩码提取特征以进行对比损失的索引。当处于训练模式时，模型学习预测 config.proj_codevector_dim 空间中被掩码的提取特征。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。
返回值
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (<class 'transformers.models.wav2vec2.configuration_wav2vec2.Wav2Vec2Config'>) 和输入。
-
logits (形状为
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2PreTrainedModel 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import jax.numpy as jnp
>>> from transformers import AutoProcessor, FlaxWav2Vec2ForCTC
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> processor = AutoProcessor.from_pretrained("facebook/wav2vec2-large-960h-lv60")
>>> model = FlaxWav2Vec2ForCTC.from_pretrained("facebook/wav2vec2-large-960h-lv60")
>>> 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)
>>> input_values = processor(
... ds["speech"][0], sampling_rate=16_000, return_tensors="np"
... ).input_values # Batch size 1
>>> logits = model(input_values).logits
>>> predicted_ids = jnp.argmax(logits, axis=-1)
>>> transcription = processor.decode(predicted_ids[0])
>>> # should give: "A MAN SAID TO THE UNIVERSE SIR I EXIST"FlaxWav2Vec2ForPreTraining
class transformers.FlaxWav2Vec2ForPreTraining
< source >( config: Wav2Vec2Config input_shape: typing.Tuple = (1, 1024) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (Wav2Vec2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 之一。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，则所有计算将使用给定的
dtype执行。请注意，这仅指定计算的 dtype，不会影响模型参数的 dtype。
带有量化器和 VQ 头的 Wav2Vec2 模型。Wav2Vec2 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
此模型继承自 FlaxPreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入 embeddings 大小、剪枝头等）。
此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参考 Flax 文档了解与通用用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 特性，例如
__call__
< source >( input_values attention_mask = None mask_time_indices = None gumbel_temperature: int = 1 params: dict = None dropout_rng: <function PRNGKey at 0x7f787eb14310> = None gumbel_rng: <function PRNGKey at 0x7f787eb14310> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None freeze_feature_encoder: bool = False return_dict: typing.Optional[bool] = None ) → transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2ForPreTrainingOutput or tuple(torch.FloatTensor)
参数
- input_values (形状为
(batch_size, sequence_length)的jnp.ndarray) — 输入原始语音波形的浮点数值。这些值可以通过将.flac或.wav音频文件加载到List[float]类型或numpy.ndarray类型的数组中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备为input_values，应该使用 AutoProcessor 进行填充并转换为jnp.ndarray类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (形状为
(batch_size, sequence_length)的jnp.ndarray, 可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
什么是注意力掩码？ .. warning:: 只有当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有config.return_attention_mask == False的模型，例如 wav2vec2-base，不应 传递attention_mask，以避免在进行批量推理时性能下降。对于此类模型，input_values应该简单地用 0 填充，并在不使用attention_mask的情况下传递。请注意，这些模型也会根据input_values是否填充而产生略有不同的结果。 - mask_time_indices (形状为
(batch_size, sequence_length)的jnp.ndarray, 可选) — 用于掩码提取特征以进行对比损失的索引。当处于训练模式时，模型学习预测 config.proj_codevector_dim 空间中被掩码的提取特征。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是纯元组。
返回值
transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2ForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2ForPreTrainingOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (<class 'transformers.models.wav2vec2.configuration_wav2vec2.Wav2Vec2Config'>) 和输入。
-
loss (可选, 当模型处于训练模式时返回, 形状为
(1,)的jnp.ndarray) — 总损失，为对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。（分类）损失。 -
projected_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的jnp.ndarray) — 模型投影到 config.proj_codevector_dim 的隐藏状态，可用于预测被掩码的投影量化状态。 -
projected_quantized_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的jnp.ndarray) — 投影到 config.proj_codevector_dim 的量化提取特征向量，表示对比损失的正目标向量。 -
hidden_states (
tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（embeddings 输出一个，每层输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2ForPreTraining 前向方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import optax
>>> import numpy as np
>>> import jax.numpy as jnp
>>> from transformers import AutoFeatureExtractor, FlaxWav2Vec2ForPreTraining
>>> from transformers.models.wav2vec2.modeling_flax_wav2vec2 import _compute_mask_indices
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-large-lv60")
>>> model = FlaxWav2Vec2ForPreTraining.from_pretrained("facebook/wav2vec2-large-lv60")
>>> 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)
>>> input_values = feature_extractor(ds["speech"][0], return_tensors="np").input_values # Batch size 1
>>> # compute masked indices
>>> batch_size, raw_sequence_length = input_values.shape
>>> sequence_length = model._get_feat_extract_output_lengths(raw_sequence_length)
>>> mask_time_indices = _compute_mask_indices((batch_size, sequence_length), mask_prob=0.2, mask_length=2)
>>> outputs = model(input_values, mask_time_indices=mask_time_indices)
>>> # compute cosine similarity between predicted (=projected_states) and target (=projected_quantized_states)
>>> cosine_sim = optax.cosine_similarity(outputs.projected_states, outputs.projected_quantized_states)
>>> # show that cosine similarity is much higher than random
>>> assert np.asarray(cosine_sim)[mask_time_indices].mean() > 0.5