Transformers documentation
Wav2Vec2-BERT
该模型于 2023-12-08 在 HF papers 上发布，并于 2024-01-18 贡献至 Hugging Face Transformers。
Wav2Vec2-BERT
概述
Wav2Vec2-BERT 模型由 Meta AI 的 Seamless Communication 团队在 Seamless: Multilingual Expressive and Streaming Speech Translation 中提出。
该模型在涵盖 143 种以上语言的 450 万小时无标签音频数据上进行了预训练。要将其用于自动语音识别（ASR）或音频分类等下游任务，需要进行微调。
该模型的官方结果可在论文的 3.2.1 节中找到。
该论文的摘要如下：
自动语音翻译领域的最新进展极大地扩展了语言覆盖范围，提升了多模态能力，并支持了广泛的任务和功能。然而，与人类之间的对话相比，当前的大规模自动语音翻译系统仍缺乏一些关键特性，这些特性有助于让机器辅助的沟通体验更加流畅自然。在本工作中，我们引入了一系列模型，以流式方式实现端到端的富有表现力的多语言翻译。首先，我们贡献了大规模多语言和多模态模型 SeamlessM4T 的改进版本——SeamlessM4T v2。该新模型整合了更新后的 UnitY2 框架，并在更多低资源语言数据上进行了训练。SeamlessAlign 的扩展版本新增了 114,800 小时的自动对齐数据，总计覆盖 76 种语言。SeamlessM4T v2 为我们最新的两个模型 SeamlessExpressive 和 SeamlessStreaming 奠定了基础。SeamlessExpressive 能够保留语音风格和韵律，从而实现翻译。与以往在富有表现力的语音研究中的工作相比，我们的工作解决了韵律中某些尚未充分探索的方面，例如语速和停顿，同时保留说话者的声音风格。至于 SeamlessStreaming，我们的模型利用 Efficient Monotonic Multihead Attention (EMMA) 机制，在无需等待完整源语句的情况下生成低延迟的目标翻译。作为首个此类模型，SeamlessStreaming 支持多种源语言和目标语言的同步语音到语音/文本翻译。为了评估这些模型的性能，我们结合了新颖的以及经过修改的现有自动指标，以评估韵律、延迟和鲁棒性。对于人工评估，我们调整了现有协议，以衡量在意义保留、自然度和表现力方面最相关的属性。为确保我们的模型能够被安全且负责任地使用，我们实施了首个已知的针对多模态机器翻译的红队测试，一个用于检测和缓解新增毒性的系统，一项针对性别偏见的系统性评估，以及一种旨在降低深度伪造影响的不可听本地化水印机制。因此，我们将 SeamlessExpressive 和 SeamlessStreaming 的主要组件整合在一起，形成了 Seamless，这是首个公开可用的系统，能够实时解锁富有表现力的跨语言沟通。总而言之，Seamless 为我们提供了一个关键的视角，展示了将通用语音翻译器从科幻概念转变为现实技术所需的技术基础。最后，本工作中的贡献——包括模型、代码和水印检测器——均已公开发布，并可通过下方链接访问。
使用技巧
- Wav2Vec2-BERT 遵循与 Wav2Vec2-Conformer 相同的架构，但采用了因果深度卷积层，并使用音频的 mel 频谱图表示作为输入，而非原始波形。
- Wav2Vec2-BERT 可以通过设置正确的
config.position_embeddings_type来使用无相对位置嵌入、Shaw 风格位置嵌入、Transformer-XL 风格位置嵌入或旋转位置嵌入。 - Wav2Vec2-BERT 还引入了基于 Conformer 的适配器网络，以取代简单的卷积网络。
资源
- 您还可以参考这些笔记本：如何微调英语语音识别模型，以及如何微调任意语言的语音识别模型。
- 另请参阅：音频分类任务指南
Wav2Vec2BertConfig
类 transformers.Wav2Vec2BertConfig
< source >( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int | None = Nonehidden_size: int = 1024num_hidden_layers: int = 24num_attention_heads: int = 16intermediate_size: int = 4096feature_projection_input_dim: int = 160hidden_act: str = 'swish'hidden_dropout: float | int = 0.0activation_dropout: float | int = 0.0attention_dropout: float | int = 0.0feat_proj_dropout: float | int = 0.0final_dropout: float | int = 0.1layerdrop: float | int = 0.1initializer_range: float = 0.02layer_norm_eps: float = 1e-05apply_spec_augment: bool = Truemask_time_prob: float | int = 0.05mask_time_length: int = 10mask_time_min_masks: int = 2mask_feature_prob: float | int = 0.0mask_feature_length: int = 10mask_feature_min_masks: int = 0ctc_loss_reduction: str = 'sum'ctc_zero_infinity: bool = Falseuse_weighted_layer_sum: bool = Falseclassifier_proj_size: int = 768tdnn_dim: list[int] | tuple[int, ...] = (512, 512, 512, 512, 1500)tdnn_kernel: list[int] | tuple[int, ...] = (5, 3, 3, 1, 1)tdnn_dilation: list[int] | tuple[int, ...] = (1, 2, 3, 1, 1)xvector_output_dim: int = 512pad_token_id: int | None = 0bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2add_adapter: bool = Falseadapter_kernel_size: int = 3adapter_stride: int = 2num_adapter_layers: int = 1adapter_act: str = 'relu'use_intermediate_ffn_before_adapter: bool = Falseoutput_hidden_size: int | None = Noneposition_embeddings_type: typing.Optional[typing.Literal['rotary', 'relative', 'relative_key']] = 'relative_key'rotary_embedding_base: int = 10000max_source_positions: int = 5000left_max_position_embeddings: int = 64right_max_position_embeddings: int = 8conv_depthwise_kernel_size: int = 31conformer_conv_dropout: float | int = 0.1 )
参数
- vocab_size (
int, 可选) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int，可选，默认为1024) — 隐藏表示的维度。 - num_hidden_layers (
int，可选，默认为24) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int，可选，默认为16) — Transformer 解码器中每个注意力层的注意力头数量。 - intermediate_size (
int，可选，默认为4096) — MLP 表示的维度。 - feature_projection_input_dim (
int, 可选，默认为 160) — 该模型的输入维度，即使用 SeamlessM4TFeatureExtractor 或 Wav2Vec2BertProcessor 处理输入音频后的维度。 - hidden_act (
str，可选，默认为swish) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu"等。 - hidden_dropout (
Union[float, int]，可选，默认为0.0) — 嵌入层、编码器和池化层中所有全连接层的 dropout 概率。 - activation_dropout (
Union[float, int]，可选，默认为0.0) — 全连接层中激活值的 dropout 比率。 - attention_dropout (
Union[float, int]，可选，默认为0.0) — 注意力概率的 dropout 比率。 - feat_proj_dropout (
float, 可选，默认值为 0.0) — 特征投影的 dropout 概率。 - final_dropout (
float，可选，默认值为 0.1) — Wav2Vec2BertForCTC 最终投影层的 dropout 概率。 - layerdrop (
Union[float, int]，可选，默认为0.1) — LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。 - initializer_range (
float，可选，默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float，可选，默认为1e-05) — 层归一化层所使用的 epsilon 值。 - apply_spec_augment (
bool，可选，默认为True) — 是否对特征编码器的输出应用 SpecAugment 数据增强。参考 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition。 - mask_time_prob (
float, optional, defaults to 0.05) — Percentage (between 0 and 1) of all feature vectors along the time axis which will be masked. The masking procedure generatesmask_time_prob*len(time_axis)/mask_time_length ``independent masks over the axis. If reasoning from the probability of each feature vector to be chosen as the start of the vector span to be masked, *mask_time_prob* should beprob_vector_start*mask_time_length. Note that overlap may decrease the actual percentage of masked vectors. This is only relevant ifapply_spec_augment is 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_prob*len(feature_axis)/mask_time_length个独立的掩码。如果从每个特征向量被选为待掩码向量跨度起点的概率来推导，mask_feature_prob 应为prob_vector_start*mask_feature_length。请注意，重叠可能会降低实际被掩码的向量百分比。此参数仅在apply_spec_augment is 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时相关。 - ctc_loss_reduction (
str，可选，默认为sum) — 指定应用于torch.nn.CTCLoss输出的归约方式。仅在训练时相关。 - ctc_zero_infinity (
bool，可选，默认为False) — 是否将torch.nn.CTCLoss的无穷大损失及其相关梯度置零。当输入过短而无法与目标对齐时，主要会产生无穷大损失。仅在训练 Wav2Vec2BertForCTC 实例时相关。 - use_weighted_layer_sum (
bool，可选，默认为False) — 是否使用带学习权重的层输出加权平均。仅在使用 Wav2Vec2BertForSequenceClassification 实例时相关。 - classifier_proj_size (
int，可选，默认为 768) — 用于分类的 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 嵌入向量的维度。 - pad_token_id (
int, 可选，默认为0) — 词表中用于填充的 token id。 - bos_token_id (
int，可选，默认为1) — 词汇表中用于表示流起始的 token id。 - eos_token_id (
Union[int, list[int]]，可选，默认为2) — 词汇表中用于表示流结束（end-of-stream）的 token id。 - add_adapter (
bool，可选，默认为False) — 是否应在 Wav2Vec2Bert Encoder 之上堆叠一个卷积注意力网络。对于为 SpeechEncoderDecoder 模型预热启动 Wav2Vec2Bert 非常有用。 - adapter_kernel_size (
int，可选，默认为 3) — 适配器网络中卷积层的卷积核大小。仅当add_adapter is True时相关。 - adapter_stride (
int，可选，默认为 2) — 适配器网络中卷积层的步长。仅在add_adapter is True时相关。 - num_adapter_layers (
int，可选，默认为 1) — 适配器网络中应使用的卷积层数量。仅在add_adapter is True时相关。 - adapter_act (
str或function，可选，默认为"relu") — 适配器层中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"、"swish"和"gelu_new"。 - use_intermediate_ffn_before_adapter (
bool，可选，默认为False) — 是否应在 Wav2Vec2Bert Encoder 之上、适配器网络之前堆叠一个中间前馈块。 仅当add_adapter is True时相关。 - output_hidden_size (
int, 可选) — 编码器输出层的维度。如果未定义，则默认为 hidden-size。仅在add_adapter is True时相关。 - position_embeddings_type (
str, 可选, 默认为"relative_key") — 可指定为：rotary，用于旋转位置编码。relative，用于相对位置编码。relative_key，用于 Shaw 在 Self-Attention with Relative Position Representations (Shaw et al.) 中定义的相对位置编码。如果保持为 None，则不应用相对位置编码。rotary，用于旋转位置编码。relative，用于相对位置嵌入。relative_key，用于 Shaw 在 Self-Attention with Relative Position Representations (Shaw et al.) 中定义的相对位置嵌入。 如果保留为None，则不应用相对位置嵌入。
- rotary_embedding_base (
int，可选，默认值为 10000) — 如果使用"rotary"位置嵌入，则定义嵌入基数的大小。 - max_source_positions (
int，可选，默认为 5000) — 如果使用"relative"位置嵌入，则定义源输入的最大位置数。 - left_max_position_embeddings (
int，可选，默认为 64) — 如果使用"relative_key"（即 Shaw）位置嵌入，则定义相对位置的左侧截断值。 - right_max_position_embeddings (
int，可选，默认为 8) — 如果使用"relative_key"（即 Shaw）位置嵌入，则定义相对位置的右侧截断值。 - conv_depthwise_kernel_size (
int，可选，默认值为 31) — Conformer 块中卷积深度 1D 层的卷积核大小。 - conformer_conv_dropout (
float，可选，默认值为 0.1) — Conformer 块中所有卷积层的 dropout 概率。
这是用于存储 Wav2Vec2 BertModel 配置的类。它根据指定的参数实例化 Wav2Vec2 Bert 模型，并定义模型架构。使用默认值实例化配置将得到与 facebook/w2v-bert-2.0 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PreTrainedConfig 的文档。
示例：
>>> from transformers import Wav2Vec2BertConfig, Wav2Vec2BertModel
>>> # Initializing a Wav2Vec2Bert facebook/wav2vec2-bert-rel-pos-large style configuration
>>> configuration = Wav2Vec2BertConfig()
>>> # Initializing a model (with random weights) from the facebook/wav2vec2-bert-rel-pos-large style configuration
>>> model = Wav2Vec2BertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configWav2Vec2BertProcessor
类 transformers.Wav2Vec2BertProcessor
< source >( feature_extractortokenizer )
构建一个 Wav2Vec2BertProcessor，它将特征提取器和分词器封装为单个处理器。
Wav2Vec2BertProcessor 提供了 Wav2Vec2FeatureExtractor 和 Wav2Vec2CTCTokenizer 的所有功能。有关更多信息，请参阅 ~Wav2Vec2FeatureExtractor 和 ~Wav2Vec2CTCTokenizer。
__call__
< source >( audio: typing.Union[numpy.ndarray, ForwardRef('torch.Tensor'), list[numpy.ndarray], list['torch.Tensor'], NoneType] = Nonetext: str | list[str] | None = None**kwargs: *<class 'transformers.models.wav2vec2_bert.processing_wav2vec2_bert.Wav2Vec2BertProcessorKwargs'> ) → BatchEncoding
参数
- audio (
Union[numpy.ndarray, torch.Tensor, list[numpy.ndarray], list[torch.Tensor]], 可选) — 要准备处理的音频或音频批次。每个音频可以是 NumPy 数组或 PyTorch 张量。 如果为 NumPy 数组/PyTorch 张量，每个音频的形状应为 (C, T)，其中 C 为通道数，T 为音频的采样长度。 - text (
Union[str, list[str]]，可选) — 要编码的序列或序列批次。每个序列可以是字符串或字符串列表（预分词字符串）。如果传入预分词输入，请设置is_split_into_words=True，以避免与批量输入产生歧义。 - return_tensors (
str或 TensorType, 可选) — 如果设置，将返回特定框架的张量。可接受的值为：'pt'：返回 PyTorchtorch.Tensor对象。'np'：返回 NumPynp.ndarray对象。
- **kwargs (ProcessingKwargs，可选) — 每种模态（文本、图像、视频、音频）的额外处理选项。模型特定参数已在上方列出；有关支持参数的完整列表，请参阅 TypedDict 类。
返回值
一个包含以下字段的 BatchEncoding：
- input_features — 输入到模型的音频输入特征。当
audio不为None时返回。 - attention_mask — 索引列表，指定当
audio不为None时，模型应关注哪些时间戳。 当仅指定text时，返回 token 注意力掩码。 - labels — 要输入模型的 token id 列表。当
text和audio均不为None时返回。 - input_ids — 要输入模型的 token id 列表。当
text不为None且audio为None时返回。
如果 input_features 不是 None，此方法会将 input_features 和 kwargs 参数转发给 SeamlessM4TFeatureExtractor 的 pad()，以填充输入特征。
如果 labels 不是 None，此方法会将 labels 和 kwargs 参数转发给 PreTrainedTokenizer 的 pad()，以填充标签。
有关更多信息，请参阅上述两个方法的文档字符串。
from_pretrained
< source >( pretrained_model_name_or_path: str | os.PathLikecache_dir: str | os.PathLike | None = Noneforce_download: bool = Falselocal_files_only: bool = Falsetoken: str | bool | None = Nonerevision: str = 'main'**kwargs )
参数
- pretrained_model_name_or_path (
str或os.PathLike) — 可以是以下之一：- 一个字符串，即托管在 huggingface.co 上某个模型仓库中的预训练 feature_extractor 的 model id。
- 指向一个目录的路径，该目录包含使用 save_pretrained() 方法保存的特征提取器文件，例如
./my_model_directory/。 - 指向已保存的特征提取器 JSON 文件的路径，例如
./my_model_directory/preprocessor_config.json。
- **kwargs —
同时传递给
from_pretrained() 和
~tokenization_utils_base.PreTrainedTokenizer.from_pretrained的额外关键字参数。
实例化与预训练模型关联的处理器。
此类的该方法只是调用了特征提取器的 from_pretrained()、图像处理器 ImageProcessingMixin 以及分词器的
~tokenization_utils_base.PreTrainedTokenizer.from_pretrained方法。有关更多信息，请参阅上述方法的文档字符串。
save_pretrained
< source >( save_directorypush_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()。有关更多信息，请参阅该方法的文档字符串。
Wav2Vec2BertModel
类 transformers.Wav2Vec2BertModel
< source >( config: Wav2Vec2BertConfig )
参数
- config (Wav2Vec2BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
输出原始隐藏状态且顶部未添加任何特定头部的裸 Wav2Vec2 Bert 模型。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonemask_time_indices: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → Wav2Vec2BaseModelOutput or tuple(torch.Tensor)
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, feature_dim)，可选) — 与输入音频特征对应的张量。可以使用 Wav2Vec2FeatureExtractor 获取音频特征。有关详细信息，请参阅 Wav2Vec2FeatureExtractor.call()（Wav2Vec2BertProcessor 使用 Wav2Vec2FeatureExtractor 来处理音频）。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- mask_time_indices (
torch.BoolTensor，形状为(batch_size, sequence_length)，可选) — 用于对比损失中掩码提取特征的索引。在训练模式下，模型学习在 config.proj_codevector_dim 空间中预测被掩码的提取特征。
返回值
Wav2Vec2BaseModelOutput 或 tuple(torch.Tensor)
一个 Wav2Vec2BaseModelOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（Wav2Vec2BertConfig）和输入。
Wav2Vec2BertModel 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
last_hidden_state（形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor）— 模型最后一层输出的隐藏状态序列。extract_features（形状为
(batch_size, sequence_length, conv_dim[-1])的torch.Tensor）— 模型最后一个卷积层提取的特征向量序列。hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（包含嵌入层的输出以及每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及初始嵌入输出。
attentions (
tuple(torch.Tensor)，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
Wav2Vec2BertForCTC
class transformers.Wav2Vec2BertForCTC
< source >( config: Wav2Vec2BertConfigtarget_lang: str | None = None )
参数
- config (Wav2Vec2BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
- target_lang (
str, 可选) — 适配器权重的语言 ID。适配器权重以 adapter..safetensors 或 adapter. .bin 的格式存储。仅在使用带有适配器的 UniSpeechSatForCTC 实例时相关。默认使用 ‘eng’。
带有 language modeling 头部的 Wav2Vec2Bert 模型，用于连接主义时间分类（CTC）。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → CausalLMOutput or tuple(torch.Tensor)
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, feature_dim)，可选) — 与输入音频特征对应的张量。可以使用 Wav2Vec2FeatureExtractor 获取音频特征。有关详细信息，请参阅 Wav2Vec2FeatureExtractor.call()（Wav2Vec2BertProcessor 使用 Wav2Vec2FeatureExtractor 来处理音频）。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- labels (
torch.LongTensor，形状为(batch_size, target_length)，可选) — 用于连接时序分类的标签。请注意，target_length必须小于或等于输出 logits 的序列长度。索引的取值范围为[-100, 0, ..., config.vocab_size - 1]。 所有设置为-100的标签都会被忽略（即被掩码），损失仅针对[0, ..., config.vocab_size - 1]范围内的标签进行计算。
返回值
CausalLMOutput 或 tuple(torch.Tensor)
一个 CausalLMOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（Wav2Vec2BertConfig）和输入。
Wav2Vec2BertForCTC 的 forward 方法会重写 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss (
torch.Tensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。logits（形状为
(batch_size, sequence_length, config.vocab_size)的torch.Tensor）— 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。hidden_states (
tuple(torch.Tensor)，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层的输出，以及每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple(torch.Tensor)，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoProcessor, Wav2Vec2BertForCTC
>>> 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/w2v-bert-2.0")
>>> model = Wav2Vec2BertForCTC.from_pretrained("facebook/w2v-bert-2.0")
>>> # 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)
...Wav2Vec2BertForSequenceClassification
class transformers.Wav2Vec2BertForSequenceClassification
< source >( config: Wav2Vec2BertConfig )
参数
- config (Wav2Vec2BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
在 Wav2Vec2Bert 模型顶部添加一个序列分类头（在池化输出上应用一个线性层），用于 SUPERB Keyword Spotting 等任务。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → SequenceClassifierOutput or tuple(torch.Tensor)
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, feature_dim)，可选) — 与输入音频特征对应的张量。可以使用 Wav2Vec2FeatureExtractor 获取音频特征。有关详细信息，请参阅 Wav2Vec2FeatureExtractor.call()（Wav2Vec2BertProcessor 使用 Wav2Vec2FeatureExtractor 来处理音频）。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
SequenceClassifierOutput 或 tuple(torch.Tensor)
一个 SequenceClassifierOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（Wav2Vec2BertConfig）和输入。
Wav2Vec2BertForSequenceClassification 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss (
torch.Tensor，形状为(1,)，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。logits（形状为
(batch_size, config.num_labels)的torch.Tensor）— 分类（或当 config.num_labels==1 时为回归）得分（SoftMax 之前）。hidden_states (
tuple(torch.Tensor)，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层的输出，以及每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple(torch.Tensor)，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
单标签分类示例：
>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2BertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/w2v-bert-2.0")
>>> 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 = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/w2v-bert-2.0", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例：
>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2BertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/w2v-bert-2.0", 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 = Wav2Vec2BertForSequenceClassification.from_pretrained(
... "facebook/w2v-bert-2.0", 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).lossWav2Vec2BertForAudioFrameClassification
class transformers.Wav2Vec2BertForAudioFrameClassification
< source >( config: Wav2Vec2BertConfig )
参数
- config (Wav2Vec2BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有帧分类头部的 Wav2Vec2 Bert 模型，用于说话人分离等任务。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → TokenClassifierOutput or tuple(torch.Tensor)
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, feature_dim)，可选) — 与输入音频特征对应的张量。可以使用 Wav2Vec2FeatureExtractor 获取音频特征。有关详细信息，请参阅 Wav2Vec2FeatureExtractor.call()（Wav2Vec2BertProcessor 使用 Wav2Vec2FeatureExtractor 来处理音频）。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
TokenClassifierOutput 或 tuple(torch.Tensor)
一个 TokenClassifierOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（Wav2Vec2BertConfig）和输入。
Wav2Vec2BertForAudioFrameClassification 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为
(1,)的torch.Tensor，可选，在提供labels时返回） — 分类损失。logits（形状为
(batch_size, sequence_length, config.num_labels)的torch.Tensor）— 分类分数（SoftMax 之前）。hidden_states (
tuple(torch.Tensor)，可选，当传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（如果模型具有嵌入层，则包含嵌入层的输出，以及每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
attentions (
tuple(torch.Tensor)，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoFeatureExtractor, Wav2Vec2BertForAudioFrameClassification
>>> 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/w2v-bert-2.0")
>>> model = Wav2Vec2BertForAudioFrameClassification.from_pretrained("facebook/w2v-bert-2.0")
>>> # 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()
...Wav2Vec2BertForXVector
class transformers.Wav2Vec2BertForXVector
< source >( config: Wav2Vec2BertConfig )
参数
- config (Wav2Vec2BertConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化时，不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
Wav2Vec2Bert 模型，顶部带有 XVector 特征提取头，用于说话人验证等任务。
该模型继承自 PreTrainedModel。请查阅父类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 的子类。 请将其作为常规的 PyTorch Module 使用，有关通用用法和行为的所有事项，请参阅 PyTorch 文档。
forward
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → XVectorOutput or tuple(torch.Tensor)
参数
- input_features (
torch.Tensor，形状为(batch_size, sequence_length, feature_dim)，可选) — 与输入音频特征对应的张量。可以使用 Wav2Vec2FeatureExtractor 获取音频特征。有关详细信息，请参阅 Wav2Vec2FeatureExtractor.call()（Wav2Vec2BertProcessor 使用 Wav2Vec2FeatureExtractor 来处理音频）。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), ，可选) — 用于避免对填充 token 索引执行注意力机制的掩码。掩码值取自[0, 1]:- 1 表示未被屏蔽的 token，
- 对于被掩码的 token，值为 0。
- labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
XVectorOutput 或 tuple(torch.Tensor)
一个 XVectorOutput 或 torch.Tensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），其包含的元素取决于配置（Wav2Vec2BertConfig）和输入。
Wav2Vec2BertForXVector 的 forward 方法重写了 __call__ 特殊方法。
尽管前向传播的实现需要在此函数中定义，但之后应调用
Module实例，而不是直接调用此函数，因为前者会负责执行预处理和后处理步骤，而后者则会静默地忽略这些步骤。
loss（形状为
(1,)的torch.Tensor，可选，在提供labels时返回） — 分类损失。logits（形状为
(batch_size, config.xvector_output_dim)的torch.Tensor）— AMSoftmax 之前的分类隐藏状态。嵌入（形状为
(batch_size, config.xvector_output_dim)的torch.Tensor）— 用于基于向量相似性检索的语句嵌入。hidden_states (
tuple(torch.Tensor)，可选，在传入output_hidden_states=True或config.output_hidden_states=True时返回) — 一个torch.Tensor元组（包含嵌入层的输出以及每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及初始嵌入输出。
attentions (
tuple(torch.Tensor)，可选，当传入output_attentions=True或config.output_attentions=True时返回) — 一个torch.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力权重，即经过注意力 softmax 之后的权重，用于在自注意力头中计算加权平均值。
示例：
>>> from transformers import AutoFeatureExtractor, Wav2Vec2BertForXVector
>>> 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/w2v-bert-2.0")
>>> model = Wav2Vec2BertForXVector.from_pretrained("facebook/w2v-bert-2.0")
>>> # 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)
...