Transformers 文档
Wav2Vec2
并获得增强的文档体验
开始使用
Wav2Vec2
概述
Wav2Vec2 模型由 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 在 wav2vec 2.0: 一种自监督学习语音表示的框架 中提出。
论文摘要如下：
我们首次证明，仅从语音音频中学习强大的表示，然后对转录语音进行微调，可以超越最好的半监督方法，同时概念上更简单。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 进行解码。
[!NOTE] 当使用除“eager”之外的所有注意力实现时，`head_mask` 参数将被忽略。如果您有 `head_mask` 并希望其生效，请使用 `XXXModel.from_pretrained(model_id, attn_implementation="eager")` 加载模型。
使用 Flash Attention 2
Flash Attention 2 是一个更快、更优化的模型版本。
安装
首先，检查您的硬件是否与 Flash Attention 2 兼容。兼容硬件的最新列表可在 官方文档 中找到。如果您的硬件与 Flash Attention 2 不兼容，您仍然可以通过 上面 介绍的 Better Transformer 支持，从注意力核优化中受益。
接下来，安装 最新版本的 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（标量点积注意力）版本之间纯推理时间的预期加速图。我们展示了在 `librispeech_asr` `clean` 验证集上获得的平均加速。
资源
一份官方 Hugging Face 和社区（用🌎表示）资源列表，帮助您开始使用 Wav2Vec2。如果您有兴趣提交资源以供收录在此处，请随时打开拉取请求，我们将对其进行审查！资源应理想地展示一些新内容，而不是重复现有资源。
- 一份关于如何利用预训练的 Wav2Vec2 模型进行情感分类的笔记本。🌎
- Wav2Vec2ForCTC 受到此示例脚本和笔记本的支持。
- 音频分类任务指南
- 一篇关于在 🤗 Transformers 中使用 n-gram 提升 Wav2Vec2 的博客文章。
- 一篇关于如何使用 🤗 Transformers 微调 Wav2Vec2 进行英语 ASR 的博客文章。
- 一篇关于使用 🤗 Transformers 微调 XLS-R 进行多语言 ASR 的博客文章。
- 一份关于如何通过 Wav2Vec2 转录音频从任何视频创建 YouTube 字幕的笔记本。🌎
- Wav2Vec2ForCTC 受到一份关于如何在英语中微调语音识别模型以及如何在任何语言中微调语音识别模型的笔记本的支持。
- 自动语音识别任务指南
🚀 部署
- 一篇关于如何使用 Hugging Face 的 Transformers 和 Amazon SageMaker 部署 Wav2Vec2 进行自动语音识别的博客文章。
Wav2Vec2Config
class transformers.Wav2Vec2Config
< 来源 >( 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, 可选, 默认值为 32) — Wav2Vec2 模型的词汇表大小。定义了调用 Wav2Vec2Model 或 TFWav2Vec2Model 时传入的 `inputs_ids` 可以表示的不同 token 数量。模型的词汇表大小。定义了可由传入 Wav2Vec2Model 前向方法的 inputs_ids 表示的不同 token。 - hidden_size (
int, 可选, 默认值为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认值为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认值为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int, 可选, 默认值为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function, 可选, 默认值为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu","relu","selu"和"gelu_new"。 - hidden_dropout (
float, 可选, 默认值为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - activation_dropout (
float, 可选, 默认值为 0.1) — 全连接层内部激活的 dropout 比例。 - attention_dropout (
float, 可选, 默认值为 0.1) — 注意力概率的 dropout 比例。 - final_dropout (
float, 可选, 默认值为 0.1) — Wav2Vec2ForCTC 最终投影层的 dropout 概率。 - layerdrop (
float, 可选, 默认值为 0.1) — LayerDrop 概率。更多详情请参见 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。 - initializer_range (
float, 可选, 默认值为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_eps (
float, 可选, 默认值为 1e-12) — 层归一化层使用的 epsilon 值。 - feat_extract_norm (
str, 可选, 默认值为"group") — 应用于特征编码器中 1D 卷积层的归一化类型。可以是"group"(仅对第一个 1D 卷积层进行组归一化) 或"layer"(对所有 1D 卷积层进行层归一化)。 - feat_proj_dropout (
float, 可选, 默认值为 0.0) — 特征编码器输出的 dropout 概率。 - feat_extract_activation (
str,可选, 默认值为“gelu”) -- 特征提取器中 1D 卷积层的非线性激活函数（函数或字符串）。如果是字符串，支持“gelu”,“relu”,“selu”和“gelu_new”`。 - feat_quantizer_dropout (
float, 可选, 默认值为 0.0) — 量化特征编码器状态的 dropout 概率。 - conv_dim (
tuple[int]或list[int], 可选, 默认值为(512, 512, 512, 512, 512, 512, 512)) — 一个整数元组，定义特征编码器中每个 1D 卷积层的输入和输出通道数。conv_dim 的长度定义了 1D 卷积层的数量。 - conv_stride (
tuple[int]或list[int], 可选, 默认值为(5, 2, 2, 2, 2, 2, 2)) — 一个整数元组，定义特征编码器中每个 1D 卷积层的步长。conv_stride 的长度定义了卷积层的数量，并且必须与 conv_dim 的长度匹配。 - conv_kernel (
tuple[int]或list[int], 可选, 默认值为(10, 3, 3, 3, 3, 3, 3)) — 一个整数元组，定义特征编码器中每个 1D 卷积层的核大小。conv_kernel 的长度定义了卷积层的数量，并且必须与 conv_dim 的长度匹配。 - conv_bias (
bool, 可选, 默认值为False) — 1D 卷积层是否带有偏置。 - num_conv_pos_embeddings (
int, 可选, 默认值为 128) — 卷积位置嵌入的数量。定义了 1D 卷积位置嵌入层的核大小。 - num_conv_pos_embedding_groups (
int, 可选, 默认值为 16) — 1D 卷积位置嵌入层的组数。 - do_stable_layer_norm (
bool, 可选, 默认值为False) — 是否应用 Transformer 编码器的 stable 层归一化架构。do_stable_layer_norm is True对应于在注意力层之前应用层归一化，而do_stable_layer_norm is False对应于在注意力层之后应用层归一化。 - apply_spec_augment (
bool, 可选, 默认值为True) — 是否将 SpecAugment 数据增强应用于特征编码器的输出。参考 SpecAugment: 一种简单的自动语音识别数据增强方法。 - mask_time_prob (
float, 可选, 默认值为 0.05) — 将被遮蔽的沿时间轴的所有特征向量的百分比（介于 0 和 1 之间）。遮蔽过程会在该轴上生成 “mask_time_problen(time_axis)/mask_time_length” 个独立的遮蔽。如果根据每个特征向量被选为要遮蔽的向量范围起始点的概率来推断，则 mask_time_prob 应为 `prob_vector_startmask_time_length。请注意，重叠可能会降低实际被遮蔽向量的百分比。这仅在apply_spec_augment 为 True` 时相关。 - mask_time_length (
int, 可选, 默认值为 10) — 沿时间轴的向量范围长度。 - mask_time_min_masks (
int, 可选, 默认值为 2) — 沿时间轴生成的长度为mask_feature_length的最小遮罩数量，每个时间步都如此，无论mask_feature_prob的值如何。仅在 ”mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks” 时相关。 - mask_feature_prob (
float, 可选, 默认值为 0.0) — 将被遮蔽的沿特征轴的所有特征向量的百分比（介于 0 和 1 之间）。遮蔽过程会在该轴上生成 “mask_feature_problen(feature_axis)/mask_time_length” 个独立的遮蔽。如果根据每个特征向量被选为要遮蔽的向量范围起始点的概率来推断，则 mask_feature_prob 应为 `prob_vector_startmask_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, optional, defaults to 0.0) — 特征编码器输出用于量化器的 dropout 概率。 - num_negatives (
int, optional, defaults to 100) — 对比损失的负样本数量。 - codevector_dim (
int, optional, defaults to 256) — 量化特征向量的维度。 - proj_codevector_dim (
int, optional, defaults to 256) — 量化特征和变换器特征的最终投影维度。 - diversity_loss_weight (
int, optional, defaults to 0.1) — 码本多样性损失分量的权重。 - ctc_loss_reduction (
str, optional, defaults to"sum") — 指定应用于torch.nn.CTCLoss输出的 reduction。仅在训练 Wav2Vec2ForCTC 实例时相关。 - ctc_zero_infinity (
bool, optional, defaults toFalse) — 是否将torch.nn.CTCLoss的无限损失和相关梯度置零。无限损失主要发生在输入太短而无法与目标对齐时。仅在训练 Wav2Vec2ForCTC 实例时相关。 - use_weighted_layer_sum (
bool, optional, defaults toFalse) — 是否使用学习权重对层输出进行加权平均。仅在使用 Wav2Vec2ForSequenceClassification 实例时相关。 - classifier_proj_size (
int, optional, defaults to 256) — 分类前进行 token 均值池化的投影维度。 - tdnn_dim (
tuple[int]或list[int], optional, defaults to(512, 512, 512, 512, 1500)) — 定义 *XVector* 模型 *TDNN* 模块中每个 1D 卷积层的输出通道数的整数元组。*tdnn_dim* 的长度定义了 *TDNN* 层的数量。 - tdnn_kernel (
tuple[int]或list[int], optional, defaults to(5, 3, 3, 1, 1)) — 定义 *XVector* 模型 *TDNN* 模块中每个 1D 卷积层的核大小的整数元组。*tdnn_kernel* 的长度必须与 *tdnn_dim* 的长度匹配。 - tdnn_dilation (
tuple[int]或list[int], optional, defaults to(1, 2, 3, 1, 1)) — 定义 *XVector* 模型 *TDNN* 模块中每个 1D 卷积层的膨胀系数的整数元组。*tdnn_dilation* 的长度必须与 *tdnn_dim* 的长度匹配。 - xvector_output_dim (
int, optional, defaults to 512) — *XVector* 嵌入向量的维度。 - add_adapter (
bool, optional, defaults toFalse) — 是否在 Wav2Vec2 编码器之上堆叠卷积网络。对于 SpeechEncoderDecoder 模型的热启动 Wav2Vec2 非常有用。 - adapter_kernel_size (
int, optional, defaults to 3) — 适配器网络中卷积层的核大小。仅当add_adapter 为 True时相关。 - adapter_stride (
int, optional, defaults to 2) — 适配器网络中卷积层的步长。仅当add_adapter 为 True时相关。 - num_adapter_layers (
int, optional, defaults to 3) — 适配器网络中应使用的卷积层数量。仅当add_adapter 为 True时相关。 - adapter_attn_dim (
int, optional) — 在每个注意力块中使用的注意力适配器权重的维度。使用注意力适配器的模型示例是 facebook/mms-1b-all。 - output_hidden_size (
int, optional) — 编码器输出层的维度。如果未定义，则默认为 *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, optional, defaults to"<s>") — 句子开始标记。 - eos_token (
str, optional, defaults to"</s>") — 句子结束标记。 - unk_token (
str, optional, defaults to"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，而是设置为此标记。 - pad_token (
str, optional, defaults to"<pad>") — 用于填充的标记，例如在批处理不同长度的序列时。 - word_delimiter_token (
str, optional, defaults to"|") — 用于定义单词结尾的标记。 - do_lower_case (
bool, optional, defaults toFalse) — 解码时是否接受小写输入并输出小写。 - target_lang (
str, optional) — 标记器应默认设置的目标语言。对于多语言、嵌套词汇表（例如 facebook/mms-1b-all），必须定义target_lang。 - **kwargs — 额外关键字参数，传递给 PreTrainedTokenizer
构造一个 Wav2Vec2CTC 标记器。
此标记器继承自 PreTrainedTokenizer，其中包含一些主要方法。用户应参考超类以获取有关此类方法的更多信息。
__call__
< source >( text: typing.Union[str, list[str], list[list[str]], NoneType] = None text_pair: typing.Union[str, list[str], list[list[str]], NoneType] = None text_target: typing.Union[str, list[str], list[list[str]], NoneType] = None text_pair_target: typing.Union[str, list[str], list[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, NoneType] = 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]], optional) — 要编码的序列或序列批次。每个序列可以是一个字符串或一个字符串列表（预标记化字符串）。如果序列以字符串列表（预标记化）形式提供，则必须设置is_split_into_words=True（以消除与序列批次的歧义）。 - text_pair (
str,list[str],list[list[str]], optional) — 要编码的序列或序列批次。每个序列可以是一个字符串或一个字符串列表（预标记化字符串）。如果序列以字符串列表（预标记化）形式提供，则必须设置is_split_into_words=True（以消除与序列批次的歧义）。 - text_target (
str,list[str],list[list[str]], optional) — 要编码为目标文本的序列或序列批次。每个序列可以是一个字符串或一个字符串列表（预标记化字符串）。如果序列以字符串列表（预标记化）形式提供，则必须设置is_split_into_words=True（以消除与序列批次的歧义）。 - text_pair_target (
str,list[str],list[list[str]], optional) — 要编码为目标文本的序列或序列批次。每个序列可以是一个字符串或一个字符串列表（预标记化字符串）。如果序列以字符串列表（预标记化）形式提供，则必须设置is_split_into_words=True（以消除与序列批次的歧义）。 - add_special_tokens (
bool, optional, defaults toTrue) — 编码序列时是否添加特殊标记。这将使用底层PretrainedTokenizerBase.build_inputs_with_special_tokens函数，该函数定义哪些标记自动添加到输入 ID。如果您希望自动添加bos或eos标记，这将非常有用。 - padding (
bool,str或 PaddingStrategy, optional, defaults toFalse) — 激活并控制填充。接受以下值：True或'longest'：填充到批次中最长的序列（如果只提供一个序列，则不填充）。'max_length'：填充到用参数max_length指定的最大长度，或者如果未提供该参数，则填充到模型的最大可接受输入长度。False或'do_not_pad'（默认）：不填充（即，可以输出具有不同长度序列的批次）。
- truncation (
bool,str或 TruncationStrategy, optional, defaults toFalse) — 激活并控制截断。接受以下值：True或'longest_first'：截断到由参数max_length指定的最大长度，或者如果未提供该参数，则截断到模型的最大可接受输入长度。如果提供了一对序列（或一批对），则将逐个标记截断，从对中最长的序列中删除一个标记。'only_first'：截断到由参数max_length指定的最大长度，或者如果未提供该参数，则截断到模型的最大可接受输入长度。如果提供了一对序列（或一批对），则只截断第一个序列。'only_second'：截断到由参数max_length指定的最大长度，或者如果未提供该参数，则截断到模型的最大可接受输入长度。如果提供了一对序列（或一批对），则只截断第二个序列。False或'do_not_truncate'（默认）：不截断（即，可以输出序列长度大于模型最大允许输入大小的批次）。
- max_length (
int, optional) — 控制截断/填充参数之一要使用的最大长度。如果未设置或设置为
None，这将使用预定义的模型最大长度（如果截断/填充参数之一需要最大长度）。如果模型没有特定的最大输入长度（如 XLNet），则最大长度的截断/填充将被禁用。 - stride (
int, optional, defaults to 0) — 如果与max_length一起设置为数字，则当return_overflowing_tokens=True时返回的溢出标记将包含截断序列末尾的一些标记，以在截断序列和溢出序列之间提供一些重叠。此参数的值定义了重叠标记的数量。 - is_split_into_words (
bool, optional, defaults toFalse) — 输入是否已预标记化（例如，已拆分为单词）。如果设置为True，则标记器假定输入已拆分为单词（例如，通过在空格处拆分），然后对其进行标记。这对于 NER 或标记分类非常有用。 - pad_to_multiple_of (
int, optional) — 如果设置，将序列填充到所提供值的倍数。需要激活padding。这对于在计算能力>= 7.5(Volta) 的 NVIDIA 硬件上启用 Tensor Core 特别有用。 - padding_side (
str, optional) — 模型应应用填充的一侧。应在 [‘right’, ‘left’] 之间选择。默认值取自同名的类属性。 - return_tensors (
str或 TensorType, optional) — 如果设置，将返回张量而不是 Python 整数列表。可接受的值为：'tf'：返回 TensorFlowtf.constant对象。'pt'：返回 PyTorchtorch.Tensor对象。'np'：返回 Numpynp.ndarray对象。
- return_token_type_ids (
bool, optional) — 是否返回标记类型 ID。如果保留默认值，将根据特定标记器的默认值（由return_outputs属性定义）返回标记类型 ID。 - return_attention_mask (
bool, optional) — 是否返回注意力掩码。如果保留默认值，将根据特定标记器的默认值（由return_outputs属性定义）返回注意力掩码。 - return_overflowing_tokens (
bool, optional, defaults toFalse) — 是否返回溢出标记序列。如果提供了一对输入 ID 序列（或一批对），且truncation_strategy = longest_first或True，则会引发错误，而不是返回溢出标记。 - return_special_tokens_mask (
bool, optional, defaults toFalse) — 是否返回特殊标记掩码信息。 - return_offsets_mapping (
bool, optional, defaults toFalse) — 是否返回每个标记的(char_start, char_end)。这仅在继承自 PreTrainedTokenizerFast 的快速标记器上可用，如果使用 Python 的标记器，此方法将引发
NotImplementedError。 - return_length (
bool, optional, defaults toFalse) — 是否返回编码输入的长度。 - verbose (
bool, optional, defaults toTrue) — 是否打印更多信息和警告。 - **kwargs — 传递给
self.tokenize()方法
一个 BatchEncoding，包含以下字段：
-
input_ids — 要输入到模型中的标记 ID 列表。
-
token_type_ids — 要输入到模型中的标记类型 ID 列表（当
return_token_type_ids=True或如果 *“token_type_ids”* 在self.model_input_names中时）。 -
attention_mask — 指定模型应关注哪些标记的索引列表（当
return_attention_mask=True或如果 *“attention_mask”* 在self.model_input_names中时）。 -
overflowing_tokens — 溢出标记序列列表（当指定
max_length且return_overflowing_tokens=True时）。 -
num_truncated_tokens — 截断标记的数量（当指定
max_length且return_overflowing_tokens=True时）。 -
special_tokens_mask — 0 和 1 的列表，其中 1 表示添加的特殊标记，0 表示常规序列标记（当
add_special_tokens=True且return_special_tokens_mask=True时）。 -
length — 输入的长度（当
return_length=True时）
将一个或多个序列或一对或多对序列标记化并准备用于模型的主要方法。
decode
< source >( token_ids: typing.Union[int, list[int], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), ForwardRef('tf.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: typing.Optional[bool] = None 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]) — 标记化输入 ID 的列表。可以使用__call__方法获取。 - skip_special_tokens (
bool, 可选, 默认为False) — 是否在解码中移除特殊标记。 - clean_up_tokenization_spaces (
bool, 可选) — 是否清理标记化空间。 - output_char_offsets (
bool, 可选, 默认为False) — 是否输出字符偏移。字符偏移可与采样率和模型下采样率结合使用，以计算转录字符的时间戳。请查看以下示例，以更好地理解如何使用
output_char_offsets。 - output_word_offsets (
bool, 可选, 默认为False) — 是否输出单词偏移。单词偏移可与采样率和模型下采样率结合使用，以计算转录单词的时间戳。请查看以下示例，以更好地理解如何使用
output_word_offsets。 - kwargs (附加关键字参数，可选) — 将传递给底层模型特定解码方法。
返回
str 或 Wav2Vec2CTCTokenizerOutput
解码后的句子列表。当 output_char_offsets == True 或 output_word_offsets == True 时，将是一个 Wav2Vec2CTCTokenizerOutput。
使用分词器和词汇表将 ID 序列转换为字符串，可以选择移除特殊标记并清理分词空间。
类似于执行 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)
>>> 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
< 源 >( sequences: typing.Union[list[int], list[list[int]], ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), ForwardRef('tf.Tensor')] skip_special_tokens: bool = False clean_up_tokenization_spaces: typing.Optional[bool] = None 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]) — 标记化输入 ID 的列表。可以使用__call__方法获取。 - skip_special_tokens (
bool, 可选, 默认为False) — 是否在解码中移除特殊标记。 - clean_up_tokenization_spaces (
bool, 可选) — 是否清理标记化空间。 - output_char_offsets (
bool, 可选, 默认为False) — 是否输出字符偏移。字符偏移可与采样率和模型下采样率结合使用，以计算转录字符的时间戳。请查看 decode() 的示例，以更好地理解如何使用
output_char_offsets。 batch_decode() 以相同的方式处理批处理输出。 - output_word_offsets (
bool, 可选, 默认为False) — 是否输出单词偏移。单词偏移可与采样率和模型下采样率结合使用，以计算转录单词的时间戳。请查看 decode() 的示例，以更好地理解如何使用
output_word_offsets。 batch_decode() 以相同的方式处理批处理输出。 - kwargs (附加关键字参数，可选) — 将传递给底层模型特定解码方法。
返回
list[str] 或 Wav2Vec2CTCTokenizerOutput
解码后的句子列表。当 output_char_offsets == True 或 output_word_offsets == True 时，将是一个 Wav2Vec2CTCTokenizerOutput。
通过调用 decode 将标记 ID 列表的列表转换为字符串列表。
设置嵌套多语言字典的目标语言
Wav2Vec2FeatureExtractor
class transformers.Wav2Vec2FeatureExtractor
< 源 >( 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) — 用于填充填充值的值。 - 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__
< 源 >( raw_speech: typing.Union[numpy.ndarray, list[float], list[numpy.ndarray], list[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 硬件上启用 Tensor Core，或在序列长度为 128 倍数时受益的 TPU 上特别有用。 - return_attention_mask (
bool, 可选) — 是否返回注意力掩码。如果保留默认值，将根据特定 feature_extractor 的默认值返回注意力掩码。已设置
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, 可选) — 如果设置，将返回张量而不是 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
< 源 >( feature_extractor tokenizer )
参数
- feature_extractor (
Wav2Vec2FeatureExtractor) — Wav2Vec2FeatureExtractor 的实例。特征提取器是必需的输入。 - tokenizer (PreTrainedTokenizer) — PreTrainedTokenizer 的实例。分词器是必需的输入。
构造 Wav2Vec2 处理器，它将 Wav2Vec2 特征提取器和 Wav2Vec2 CTC 分词器封装在一个处理器中。
Wav2Vec2Processor 提供了 Wav2Vec2FeatureExtractor 和 PreTrainedTokenizer 的所有功能。有关这些方法的更多信息，请参阅 call() 和 decode() 的文档字符串。
__call__
< 源 >( audio: typing.Union[ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), list['np.ndarray'], list['torch.Tensor']] = None text: typing.Union[str, list[str], NoneType] = None images = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.wav2vec2.processing_wav2vec2.Wav2Vec2ProcessorKwargs] )
此方法将其所有参数转发给 Wav2Vec2FeatureExtractor 的 call() 并返回其输出。
save_pretrained
< 源 >( 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()。有关此方法的更多信息，请参阅其文档字符串。
Wav2Vec2ProcessorWithLM
class transformers.Wav2Vec2ProcessorWithLM
< 源 >( 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
< 来源 >( pretrained_model_name_or_path **kwargs )
参数
- pretrained_model_name_or_path (
str或os.PathLike) — 这可以是以下之一：- 一个字符串，即 huggingface.co 上模型仓库中预训练特征提取器的 模型 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
< 来源 >( logits: ndarray pool: typing.Optional[<bound method BaseContext.Pool of <multiprocessing.context.DefaultContext object at 0x7f01077c8ee0>>] = 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[collections.abc.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, 可选) — 如果未设置pool，则并行化函数的进程数。默认为可用 CPU 数量。 - beam_width (
int, 可选) — 解码中每一步的最大 beam 数。默认为 pyctcdecode 的 DEFAULT_BEAM_WIDTH。 - beam_prune_logp (
int, 可选) — 比最佳 beam 差得多的 beam 将被剪枝。默认为 pyctcdecode 的 DEFAULT_PRUNE_LOGP。 - token_min_logp (
int, 可选) — 低于此对数概率的 token 将被跳过，除非它们是帧的 argmax。默认为 pyctcdecode 的 DEFAULT_MIN_TOKEN_LOGP。 - hotwords (
list[str], 可选) — 具有额外重要性的单词列表，可以超出 LM 的词汇表 - hotword_weight (
int, 可选) — 热词重要性的权重因子。默认为 pyctcdecode 的 DEFAULT_HOTWORD_WEIGHT。 - alpha (
float, 可选) — 浅层融合期间语言模型的权重 - beta (
float, 可选) — 评分期间长度分数调整的权重 - unk_score_offset (
float, 可选) — 未知 token 的对数分数偏移量 - lm_score_boundary (
bool, 可选) — Kenlm 是否应在评分时尊重边界 - output_word_offsets (
bool, 可选，默认为False) — 是否输出单词偏移量。单词偏移量可以与采样率和模型下采样率结合使用，以计算转录单词的时间戳。 - n_best (
int, 可选，默认为1) — 返回的最佳假设数量。如果n_best大于 1，则返回的text将是一个字符串列表的列表，logit_score将是一个浮点数列表的列表，lm_score将是一个浮点数列表的列表，其中外部列表的长度将对应于批量大小，内部列表的长度将对应于返回的假设数量。该值应 >= 1。请查看 decode() 的示例，以更好地理解如何使用
output_word_offsets。 batch_decode() 以相同的方式处理批量输出。
批量解码输出 logits，以支持语言模型的音频转录。
此函数使用 Python 的多进程功能。目前，多进程仅在 Unix 系统上可用（请参阅此 问题）。
如果要解码多个批次，请考虑创建一个 Pool 并将其传递给 batch_decode。否则，batch_decode 将非常慢，因为它将为每次调用创建一个新的 Pool。请参见下面的用法示例。
示例：请参阅 解码多个音频。
decode
< 来源 >( 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[collections.abc.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, 可选) — 解码中每一步的最大 beam 数。默认为 pyctcdecode 的 DEFAULT_BEAM_WIDTH。 - beam_prune_logp (
int, 可选) — 剪枝对数概率小于最佳 beam 对数概率 + beam_prune_logp 的 beam。该值应 <= 0。默认为 pyctcdecode 的 DEFAULT_PRUNE_LOGP。 - token_min_logp (
int, 可选) — 除非 token 的对数概率是语音的最高对数概率，否则对数概率低于 token_min_logp 的 token 将被跳过。默认为 pyctcdecode 的 DEFAULT_MIN_TOKEN_LOGP。 - hotwords (
list[str], 可选) — 具有额外重要性的单词列表，可能缺失于 LM 的词汇表，例如 ["huggingface"] - hotword_weight (
int, 可选) — 提升热词分数的权重乘数。默认为 pyctcdecode 的 DEFAULT_HOTWORD_WEIGHT。 - alpha (
float, 可选) — 浅层融合期间语言模型的权重 - beta (
float, 可选) — 评分期间长度分数调整的权重 - unk_score_offset (
float, 可选) — 未知 token 的对数分数偏移量 - lm_score_boundary (
bool, 可选) — Kenlm 是否应在评分时尊重边界 - output_word_offsets (
bool, 可选，默认为False) — 是否输出单词偏移量。单词偏移量可以与采样率和模型下采样率结合使用，以计算转录单词的时间戳。 - n_best (
int, 可选，默认为1) — 返回的最佳假设数量。如果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)
>>> 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
< 来源 >( text: typing.Union[list[list[str]], list[str], str] logit_score: typing.Union[list[list[float]], list[float], float] = None lm_score: typing.Union[list[list[float]], list[float], float] = None word_offsets: typing.Union[list[list[list[dict[str, typing.Union[int, str]]]]], list[list[dict[str, typing.Union[int, str]]]], list[dict[str, typing.Union[int, str]]]] = None )
Wav2Vec2DecoderWithLM 的输出类型，带有转录。
class transformers.modeling_outputs.Wav2Vec2BaseModelOutput
< 来源 >( last_hidden_state: typing.Optional[torch.FloatTensor] = None extract_features: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor, ...]] = None attentions: typing.Optional[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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入输出 + 每个层输出一个）。模型的隐藏状态，包括初始嵌入输出和每个层的输出。
- 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: typing.Optional[torch.FloatTensor] = None projected_quantized_states: typing.Optional[torch.FloatTensor] = None codevector_perplexity: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None contrastive_loss: typing.Optional[torch.FloatTensor] = None diversity_loss: typing.Optional[torch.FloatTensor] = None )
参数
- loss (
*可选*, 当传入sample_negative_indices时返回，torch.FloatTensor形状为(1,)) — 总损失，是对比损失（L_m）和多样性损失（L_d）之和，如官方论文所述。（分类）损失。 - projected_states (
torch.FloatTensor形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 模型投射到 config.proj_codevector_dim 的隐藏状态，可用于预测被掩码的投射量化状态。 - projected_quantized_states (
torch.FloatTensor形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 投射到 config.proj_codevector_dim 的量化提取特征向量，代表对比损失的正目标向量。 - codevector_perplexity (
torch.FloatTensor形状为(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 后的注意力权重，用于计算自注意力头中的加权平均值。
- contrastive_loss (
*可选*, 当传入sample_negative_indices时返回，torch.FloatTensor形状为(1,)) — 对比损失（L_m），如官方论文所述。 - diversity_loss (
*可选*, 当传入sample_negative_indices时返回，torch.FloatTensor形状为(1,)) — 多样性损失（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[tuple[jax.Array]] = None attentions: typing.Optional[tuple[jax.Array]] = None )
参数
- 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), 可选, 当传入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[tuple[jax.Array]] = None attentions: typing.Optional[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 的隐藏状态，可用于预测被掩码的投射量化状态。 - 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 裸模型，输出原始隐藏状态，不带任何特定头部。
此模型继承自 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.Tensor形状为(batch_size, sequence_length), 可选) — 输入原始语音波形的浮点值。可以通过将.flac或.wav音频文件加载到list[float]类型数组或numpy.ndarray中（例如，通过 soundfile 库 (pip install soundfile)）来获取这些值。要将数组准备为input_values，应使用 AutoProcessor 进行填充和转换为torch.FloatTensor类型的张量。有关详细信息，请参阅{processor_class}.__call__。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- mask_time_indices (
torch.BoolTensor形状为(batch_size, sequence_length), 可选) — 用于对比损失的掩码提取特征的索引。在训练模式下，模型学习预测 config.proj_codevector_dim 空间中的被掩码提取特征。 - 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 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
Wav2Vec2ForCTC
class transformers.Wav2Vec2ForCTC
< source >( config target_lang: typing.Optional[str] = None )
参数
- config (Wav2Vec2ForCTC) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。要加载模型权重，请查看 from_pretrained() 方法。
- target_lang (
str, 可选) — 适配器权重的语言 ID。适配器权重以 adapter..safetensors 或 adapter. .bin 格式存储。仅在使用带适配器的 Wav2Vec2ForCTC 实例时相关。默认为“eng”。
Wav2Vec2 模型，顶部带有用于连接主义时间分类（CTC）的 语言建模 头部。
此模型继承自 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.Tensor形状为(batch_size, sequence_length), 可选) — 输入原始语音波形的浮点值。可以通过将.flac或.wav音频文件加载到list[float]类型数组或numpy.ndarray中（例如，通过 soundfile 库 (pip install soundfile)）来获取这些值。要将数组准备为input_values，应使用 AutoProcessor 进行填充和转换为torch.FloatTensor类型的张量。有关详细信息，请参阅{processor_class}.__call__。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (
torch.LongTensor形状为(batch_size, target_length), 可选) — 用于连接主义时间分类的标签。请注意，target_length必须小于或等于输出 logits 的序列长度。索引选择在[-100, 0, ..., config.vocab_size - 1]中。所有设置为-100的标签都将被忽略（被掩码），损失仅针对[0, ..., config.vocab_size - 1]中的标签计算。
返回
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutput 或 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (Wav2Vec2Config) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则为嵌入层输出一个，每个层输出一个）形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForCTC 的前向方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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")
>>> 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]
...
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
...load_adapter
< source >( target_lang: str force_load = True **kwargs )
参数
- target_lang (
str) — 必须是现有适配器权重的语言 ID。适配器权重以 `adapter..safetensors` 或 `adapter. .bin` 格式存储。 - force_load (
bool, 默认为True) — 即使target_lang与self.target_lang匹配，是否也要加载权重。 - cache_dir (
Union[str, os.PathLike], 可选) — 如果不使用标准缓存，则为下载的预训练模型配置应缓存到的目录路径。 - force_download (
bool, 可选, 默认为False) — 是否强制（重新）下载模型权重和配置文件，如果存在缓存版本则覆盖。 - resume_download — 已弃用并忽略。现在所有下载在可能的情况下默认恢复。将在 Transformers v5 中移除。
- proxies (
dict[str, str], 可选) — 要按协议或端点使用的代理服务器字典，例如，{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。代理在每个请求上使用。 - local_files_only(
bool, 可选, 默认为False) — 是否只查看本地文件（即，不尝试下载模型）。 - token (
str或bool, 可选) — 用于远程文件的 HTTP Bearer 授权令牌。如果为True或未指定，将使用运行huggingface-cli login时生成的令牌（存储在~/.huggingface中）。 - revision (
str, 可选, 默认为"main") — 要使用的特定模型版本。它可以是分支名称、标签名称或提交 ID，因为我们使用基于 git 的系统在 huggingface.co 上存储模型和其他工件，因此revision可以是 git 允许的任何标识符。要在 Hub 上测试您创建的拉取请求，您可以传递
revision="refs/pr/<pr_number>"。 - mirror (
str, 可选) — 用于加速在中国下载的镜像源。如果您来自中国且存在访问问题，您可以设置此选项来解决。请注意，我们不保证时效性或安全性。有关更多信息，请参阅镜像站点。
从预训练适配器模型加载语言适配器模型。
启用特殊的 “离线模式” 以在防火墙环境下使用此方法。
示例
>>> 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 (Wav2Vec2ForSequenceClassification) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Wav2Vec2 模型，顶部带有用于 SUPERB 关键词识别等任务的序列分类头（池化输出上的线性层）。
此模型继承自 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.Tensor, 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中:- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (形状为
(batch_size,)的torch.LongTensor, 可选) — 用于计算序列分类/回归损失的标签。索引应在[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 (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则为嵌入层输出一个，每个层输出一个）形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2ForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-base-960h")
>>> model = Wav2Vec2ForSequenceClassification.from_pretrained("facebook/wav2vec2-base-960h")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Wav2Vec2ForSequenceClassification.from_pretrained("facebook/wav2vec2-base-960h", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2ForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-base-960h")
>>> model = Wav2Vec2ForSequenceClassification.from_pretrained("facebook/wav2vec2-base-960h", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Wav2Vec2ForSequenceClassification.from_pretrained(
... "facebook/wav2vec2-base-960h", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossWav2Vec2ForAudioFrameClassification
class transformers.Wav2Vec2ForAudioFrameClassification
< source >( config )
参数
- config (Wav2Vec2ForAudioFrameClassification) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Wav2Vec2 模型，顶部带有用于说话人分离等任务的帧分类头。
此模型继承自 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 (形状为
(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.Tensor, 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中:- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- labels (形状为
(batch_size,)的torch.LongTensor, 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传入 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (Wav2Vec2Config) 和输入的不同元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传入output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有嵌入层，则为嵌入层输出一个，每个层输出一个）形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForAudioFrameClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-base-960h")
>>> model = Wav2Vec2ForAudioFrameClassification.from_pretrained("facebook/wav2vec2-base-960h")
>>> # 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()
...Wav2Vec2ForXVector
class transformers.Wav2Vec2ForXVector
< source >( config )
参数
- config (Wav2Vec2ForXVector) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Wav2Vec2 模型，顶部带有用于说话人验证等任务的 XVector 特征提取头。
此模型继承自 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 (形状为
(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.Tensor, 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中:- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (形状为
(batch_size,)的torch.LongTensor, 可选) — 用于计算序列分类/回归损失的标签。索引应在[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 (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, config.xvector_output_dim)的torch.FloatTensor) — AMSoftmax 之前的分类隐藏状态。 -
embeddings (形状为
(batch_size, config.xvector_output_dim)的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 后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ForXVector 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-base-960h")
>>> model = Wav2Vec2ForXVector.from_pretrained("facebook/wav2vec2-base-960h")
>>> # 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)
...Wav2Vec2ForPreTraining
class transformers.Wav2Vec2ForPreTraining
< source >( config: Wav2Vec2Config )
参数
- config (Wav2Vec2Config) — 模型的配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Wav2Vec2 模型，顶部带有量化器和 VQ 头。
此模型继承自 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.Tensor, 可选) — 输入原始语音波形的浮点值。可以通过将.flac或.wav音频文件加载到list[float]类型数组或numpy.ndarray中获取，例如通过 soundfile 库（pip install soundfile）。要将数组准备为input_values，应使用 AutoProcessor 进行填充和转换为torch.FloatTensor类型张量。详情请参阅{processor_class}.__call__。 - attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中:- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
- mask_time_indices (形状为
(batch_size, sequence_length)的torch.BoolTensor, 可选) — 用于对比损失掩码提取特征的索引。在训练模式下，模型学习预测 config.proj_codevector_dim 空间中被掩码的提取特征。 - sampled_negative_indices (形状为
(batch_size, sequence_length, num_negatives)的torch.BoolTensor, 可选) — 指示哪些量化目标向量在对比损失中用作负采样向量的索引。预训练的必需输入。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是纯元组。
返回
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的隐藏状态，可用于预测掩码的投影量化状态。 -
projected_quantized_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的torch.FloatTensor) — 量化提取的特征向量，投影到config.proj_codevector_dim，表示对比损失的正目标向量。 -
codevector_perplexity (形状为
(1,)的torch.FloatTensor) — 码向量分布的困惑度，用于衡量码本的多样性。 -
hidden_states (
tuple[torch.FloatTensor], 可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入层的输出，加上每个层的输出）。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor], 可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
contrastive_loss (
*可选*，当传递sample_negative_indices时返回，形状为(1,)的torch.FloatTensor) — 官方论文中陈述的对比损失 (L_m) 。 -
diversity_loss (
*可选*，当传递sample_negative_indices时返回，形状为(1,)的torch.FloatTensor) — 官方论文中陈述的多样性损失 (L_d) 。
Wav2Vec2ForPreTraining的前向方法，覆盖了__call__特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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()方法以加载模型权重。
裸露的TFWav2Vec2模型转换器，输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是keras.Model的子类。将其作为常规的TF 2.0 Keras模型使用，并参考TF 2.0文档中与通用用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是Keras方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用model.fit()等方法时，事情应该“顺其自然”——只需以model.fit()支持的任何格式传递您的输入和标签即可！但是，如果您想在fit()和predict()等Keras方法之外使用第二种格式，例如在使用KerasFunctional 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函数一样传递输入！
调用
< 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})) — 词汇表中输入序列标记的索引。索引可以使用AutoTokenizer获得。有关详细信息，请参见PreTrainedTokenizer.call()和PreTrainedTokenizer.encode()。
- attention_mask (形状为
({0})的np.ndarray或tf.Tensor，可选) — 避免对填充标记索引执行注意力的掩码。掩码值选定在[0, 1]：- 1表示标记未被掩码，
- 0表示标记已被掩码。
- token_type_ids (形状为
({0})的np.ndarray或tf.Tensor，可选) — 片段标记索引，用于指示输入的第一个和第二个部分。索引选定在[0, 1]：- 0对应于句子A标记，
- 1对应于句子B标记。
- position_ids (形状为
({0})的np.ndarray或tf.Tensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选定范围为[0, config.max_position_embeddings - 1]。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选定在[0, 1]：- 1表示头部未被掩码，
- 0表示头部已被掩码。
- inputs_embeds (形状为
({0}, hidden_size)的np.ndarray或tf.Tensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_values。如果您希望对如何将input_values索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是纯元组。此参数可在即时模式下使用，在图模式下其值将始终设置为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.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(tf.FloatTensor), 可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入层输出 + 一个用于每个层输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFWav2Vec2Model的前向方法，覆盖了__call__特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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
调用
< 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()方法以加载模型权重。
带有顶部语言建模头部用于连接主义时间分类（CTC）的TFWav2Vec2模型。
此模型继承自TFPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是keras.Model的子类。将其作为常规的TF 2.0 Keras模型使用，并参考TF 2.0文档中与通用用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是Keras方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用model.fit()等方法时，事情应该“顺其自然”——只需以model.fit()支持的任何格式传递您的输入和标签即可！但是，如果您想在fit()和predict()等Keras方法之外使用第二种格式，例如在使用KerasFunctional 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函数一样传递输入！
调用
< 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 (形状为
({0})的np.ndarray或tf.Tensor，可选) — 避免对填充标记索引执行注意力的掩码。掩码值选定在[0, 1]：- 1表示标记未被掩码，
- 0表示标记已被掩码。
- token_type_ids (形状为
({0})的np.ndarray或tf.Tensor，可选) — 片段标记索引，用于指示输入的第一个和第二个部分。索引选定在[0, 1]：- 0对应于句子A标记，
- 1对应于句子B标记。
- position_ids (形状为
({0})的np.ndarray或tf.Tensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选定范围为[0, config.max_position_embeddings - 1]。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选定在[0, 1]：- 1表示头部未被掩码，
- 0表示头部已被掩码。
- inputs_embeds (形状为
({0}, hidden_size)的np.ndarray或tf.Tensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_values。如果您希望对如何将input_values索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是纯元组。此参数可在即时模式下使用，在图模式下其值将始终设置为True。 - training (
bool, 可选，默认为`False“) — 是否在训练模式下使用模型（某些模块（如dropout模块）在训练和评估之间有不同的行为）。 - labels (形状为
(batch_size, sequence_length)的tf.Tensor或np.ndarray，可选) — 用于计算掩码语言建模损失的标签。索引应在[-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 (形状为
(n,)的tf.Tensor，可选，其中n是非掩码标签的数量，当提供了labels时返回) — 语言建模损失（用于下一标记预测）。 -
logits (
tf.Tensorof shape(batch_size, sequence_length, config.vocab_size)) — 语言模型头部的预测分数（SoftMax 之前每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor), 可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的tf.Tensor元组（一个用于嵌入层输出 + 一个用于每个层输出）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFWav2Vec2ForCTC的前向方法，覆盖了__call__特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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: 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执行。请注意，这仅指定计算的数据类型，不影响模型参数的数据类型。
裸露的Wav2Vec2模型转换器，输出原始隐藏状态，顶部没有任何特定头部。Wav2Vec2由Alexei Baevski、Henry Zhou、Abdelrahman Mohamed、Michael Auli在wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations中提出。
此模型继承自FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是Flax Linen flax.nn.Module的子类。将其作为常规的Flax模块使用，并参考Flax文档中与通用用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_values attention_mask = None mask_time_indices = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = 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 or tuple(torch.FloatTensor)
参数
- input_values (
jnp.ndarrayof shape(batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将.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，可选) — 用于避免在填充标记索引上执行卷积和注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示 未掩码 的标记，
- 0 表示 已掩码 的标记。
什么是注意力掩码？.. 警告:: 仅当对应的处理器具有
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.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 (形状为
(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时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 每个层输出一个）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2PreTrainedModel 前向方法，重写了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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
< 源 >( config: Wav2Vec2Config input_shape: 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执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
Wav2Vec2 模型，顶部带有用于连接主义时间分类 (CTC) 的 语言建模 头。Wav2Vec2 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed、Michael Auli 在 wav2vec 2.0: 语音表示自监督学习框架 中提出。
此模型继承自FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是Flax Linen flax.nn.Module的子类。将其作为常规的Flax模块使用，并参考Flax文档中与通用用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 源 >( input_values attention_mask = None mask_time_indices = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = 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 或 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，可选) — 用于避免在填充标记索引上执行卷积和注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示 未掩码 的标记，
- 0 表示 已掩码 的标记。
什么是注意力掩码？.. 警告:: 仅当对应的处理器具有
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)，可选，当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 每个层输出一个）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2PreTrainedModel 前向方法，重写了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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
< 源 >( config: Wav2Vec2Config input_shape: 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执行。请注意，这仅指定了计算的数据类型，不影响模型参数的数据类型。
Wav2Vec2 模型，顶部带有量化器和 VQ 头。Wav2Vec2 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed、Michael Auli 在 wav2vec 2.0: 语音表示自监督学习框架 中提出。
此模型继承自FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是Flax Linen flax.nn.Module的子类。将其作为常规的Flax模块使用，并参考Flax文档中与通用用法和行为相关的所有事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 源 >( input_values attention_mask = None mask_time_indices = None gumbel_temperature: int = 1 params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None gumbel_rng: <function PRNGKey at 0x7effc7ad3a30> = 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 或 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，可选) — 用于避免在填充标记索引上执行卷积和注意力的掩码。掩码值选择范围为[0, 1]：- 1 表示 未掩码 的标记，
- 0 表示 已掩码 的标记。
什么是注意力掩码？.. 警告:: 仅当对应的处理器具有
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)，可选，当传入output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出 + 每个层输出一个）。模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，当传入output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每个层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxWav2Vec2ForPreTraining 前向方法，重写了 __call__ 特殊方法。
尽管前向传播的配方需要在此函数中定义，但之后应该调用 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