Transformers 文档
Hubert
并获得增强的文档体验
开始使用
Hubert
概述
Hubert 模型由 Wei-Ning Hsu、Benjamin Bolte、Yao-Hung Hubert Tsai、Kushal Lakhotia、Ruslan Salakhutdinov 和 Abdelrahman Mohamed 在论文《HuBERT: Self-Supervised Speech Representation Learning by Masked Prediction of Hidden Units》中提出。
论文摘要如下：
用于语音表示学习的自监督方法面临三个独特的问题：（1）每个输入话语中有多个声音单元，（2）在预训练阶段没有输入声音单元的词典，以及（3）声音单元的长度可变且没有明确的分割。为了解决这三个问题，我们提出了用于自监督语音表示学习的 Hidden-Unit BERT (HuBERT) 方法，该方法利用离线聚类步骤为类 BERT 的预测损失提供对齐的目标标签。我们方法的一个关键要素是仅在被掩码的区域上应用预测损失，这迫使模型在连续输入上学习一个组合的声学和语言模型。HuBERT 主要依赖于无监督聚类步骤的一致性，而不是所分配聚类标签的内在质量。从一个包含 100 个聚类的简单 k-means 教师开始，并使用两次聚类迭代，HuBERT 模型在 Librispeech (960h) 和 Libri-light (60,000h) 基准测试中，使用 10 分钟、1 小时、10 小时、100 小时和 960 小时微调子集，其性能与最先进的 wav2vec 2.0 相当或更好。使用一个 1B 参数模型，HuBERT 在更具挑战性的 dev-other 和 test-other 评估子集上显示出高达 19% 和 13% 的相对词错误率（WER）降低。
此模型由 patrickvonplaten 贡献。
使用技巧
- Hubert 是一个语音模型，它接受一个与语音信号原始波形相对应的浮点数组。
- Hubert 模型使用联结主义时间分类 (CTC) 进行微调，因此模型输出必须使用 `Wav2Vec2CTCTokenizer` 进行解码。
- 当使用除“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
用法
下面是一个预期的加速图，比较了 `facebook/hubert-large-ls960-ft` 在 transformers 中的原生实现、flash-attention-2 版本以及 sdpa（scale-dot-product-attention）版本之间的纯推理时间。我们展示了在 `librispeech_asr` `clean` 验证集上获得的平均加速比。
>>> from transformers import HubertModel
>>> import torch
>>> model = HubertModel.from_pretrained("facebook/hubert-large-ls960-ft", torch_dtype=torch.float16, attn_implementation="flash_attention_2").to("cuda")
...预期加速
下面是一个预期的加速图，比较了 `facebook/hubert-large-ls960-ft` 模型在 transformers 中的原生实现、flash-attention-2 版本以及 sdpa（scale-dot-product-attention）版本之间的纯推理时间。我们展示了在 `librispeech_asr` `clean` 验证集上获得的平均加速比。
资源
HubertConfig
class transformers.HubertConfig
< 来源 >( 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_layer_norm = True feat_proj_dropout = 0.0 final_dropout = 0.1 layerdrop = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-05 feat_extract_norm = 'group' feat_extract_activation = 'gelu' conv_dim = (512, 512, 512, 512, 512, 512, 512) conv_stride = (5, 2, 2, 2, 2, 2, 2) conv_kernel = (10, 3, 3, 3, 3, 2, 2) conv_bias = False num_conv_pos_embeddings = 128 num_conv_pos_embedding_groups = 16 conv_pos_batch_norm = False 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 ctc_loss_reduction = 'sum' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 256 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32) — Hubert 模型的词汇表大小。定义了在调用 `HubertModel` 时，`inputs_ids` 可以表示的不同标记的数量。模型的词汇表大小。定义了传递给 `HubertModel` 的 `forward` 方法的 *`inputs_ids`* 可以表示的不同标记。 - 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) — 嵌入层、编码器和池化层中所有全连接层的丢弃概率。 - activation_dropout (
float, 可选, 默认为 0.1) — 全连接层内激活函数的丢弃率。 - attention_dropout(
float, 可选, 默认为 0.1) — 注意力概率的丢弃率。 - final_dropout (
float, 可选, 默认为 0.1) — `Wav2Vec2ForCTC` 最终投影层的丢弃概率。 - layerdrop (
float, 可选, 默认为 0.1) — LayerDrop 概率。更多详情请参阅 [LayerDrop 论文](https://huggingface.co/papers/1909.11556)。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 `truncated_normal_initializer` 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - feat_extract_norm (
str, 可选, 默认为"group") — 应用于特征编码器中 1D 卷积层的归一化方法。`"group"` 表示仅对第一个 1D 卷积层进行组归一化，`"layer"` 表示对所有 1D 卷积层进行层归一化。 - feat_proj_dropout (
float, 可选, 默认为 0.0) — 特征编码器输出的丢弃概率。 - feat_proj_layer_norm (
bool, 可选, 默认为 `True`) — 是否对特征编码器的输出应用层归一化。 - feat_extract_activation (
str, `可选`, 默认为 `“gelu”`) -- 特征提取器中 1D 卷积层的非线性激活函数（函数或字符串）。如果为字符串，支持 `“gelu”`、`“relu”`、`“selu”` 和 `“gelu_new”`。 - conv_dim (
tuple[int], 可选, 默认为 `(512, 512, 512, 512, 512, 512, 512)`) — 定义特征编码器中每个 1D 卷积层的输入和输出通道数的整数元组。*conv_dim* 的长度定义了 1D 卷积层的数量。 - conv_stride (
tuple[int], 可选, 默认为 `(5, 2, 2, 2, 2, 2, 2)`) — 定义特征编码器中每个 1D 卷积层步长的整数元组。*conv_stride* 的长度定义了卷积层的数量，并且必须与 *conv_dim* 的长度相匹配。 - conv_kernel (
tuple[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 卷积位置嵌入层的组数。 - conv_pos_batch_norm (
bool, 可选, 默认为 `False`) — 在 conv_pos 中是否使用批归一化而不是权重归一化。 - do_stable_layer_norm (
bool, 可选, 默认为 `False`) — 是否应用 Transformer 编码器的*稳定*层归一化架构。`do_stable_layer_norm is True` 对应于在注意力层之前应用层归一化，而 `do_stable_layer_norm is False` 对应于在注意力层之后应用层归一化。 - apply_spec_augment (
bool, 可选, 默认为 `True`) — 是否对特征编码器的输出应用 *SpecAugment* 数据增强。参考 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition。 - mask_time_prob (
float, 可选, 默认为 0.05) — 将被掩码的时间轴上所有特征向量的百分比（介于 0 和 1 之间）。掩码过程在时间轴上生成 `mask_time_prob * len(time_axis) / mask_time_length` 个独立的掩码。如果从每个特征向量被选为要掩码的向量跨度起点的概率来推理，*`mask_time_prob`* 应为 `prob_vector_start * mask_time_length`。请注意，重叠可能会减少实际被掩码向量的百分比。仅当 `apply_spec_augment` 为 `True` 时相关。 - mask_time_length (
int, 可选, 默认为 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` 为 `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` 输出的缩减方式。仅在训练 `HubertForCTC` 实例时相关。 - ctc_zero_infinity (
bool, 可选, 默认为 `False`) — 是否将 `torch.nn.CTCLoss` 的无限损失及其相关梯度置零。无限损失主要发生在输入太短而无法与目标对齐时。仅在训练 `HubertForCTC` 实例时相关。 - use_weighted_layer_sum (
bool, 可选, 默认为 `False`) — 是否使用学习到的权重对层输出进行加权平均。仅在使用 `HubertForSequenceClassification` 实例时相关。 - classifier_proj_size (
int, 可选, 默认为 256) — 分类前标记均值池化投影的维度。
这是用于存储 `HubertModel` 配置的配置类。它用于根据指定的参数实例化一个 Hubert 模型，定义模型架构。使用默认值实例化配置将产生与 Hubert `facebook/hubert-base-ls960` 架构类似的配置。
配置对象继承自 `PretrainedConfig`，可用于控制模型输出。有关更多信息，请阅读 `PretrainedConfig` 的文档。
示例
>>> from transformers import HubertModel, HubertConfig
>>> # Initializing a Hubert facebook/hubert-base-ls960 style configuration
>>> configuration = HubertConfig()
>>> # Initializing a model from the facebook/hubert-base-ls960 style configuration
>>> model = HubertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configHubertModel
class transformers.HubertModel
< 来源 >( config: HubertConfig )
参数
- config (HubertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
一个基础的 Hubert 模型，输出原始的隐藏状态（hidden-states），顶部没有任何特定的模型头（head）。
该模型继承自 PreTrainedModel。查阅父类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪模型头等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源文件 >( 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.BaseModelOutput 或 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.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (HubertConfig) 和输入而定的各种元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
HubertModel 的 forward 方法重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, HubertModel
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> processor = AutoProcessor.from_pretrained("facebook/hubert-large-ls960-ft")
>>> model = HubertModel.from_pretrained("facebook/hubert-large-ls960-ft")
>>> 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="pt").input_values # Batch size 1
>>> hidden_states = model(input_values).last_hidden_stateHubertForCTC
class transformers.HubertForCTC
< 源文件 >( config target_lang: typing.Optional[str] = None )
参数
- config (HubertForCTC) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
- target_lang (
str, 可选) — 适配器权重的语言 ID。适配器权重以 `adapter..safetensors` 或 `adapter. .bin` 的格式存储。仅在使用带适配器的 HubertForCTC 实例时相关。默认使用‘eng’。
一个在顶部带有 `语言模型` 头的 Hubert 模型，用于连接时序分类（Connectionist Temporal Classification, CTC）。
该模型继承自 PreTrainedModel。查阅父类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪模型头等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源文件 >( 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），包含根据配置 (HubertConfig) 和输入而定的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
HubertForCTC 的 forward 方法重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, HubertForCTC
>>> 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/hubert-base-ls960")
>>> model = HubertForCTC.from_pretrained("facebook/hubert-base-ls960")
>>> # 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)
...HubertForSequenceClassification
class transformers.HubertForSequenceClassification
< 源文件 >( config )
参数
- config (HubertForSequenceClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Hubert 模型在顶部带有一个序列分类头（在池化输出上加一个线性层），用于像 SUPERB 关键词识别这样的任务。
该模型继承自 PreTrainedModel。查阅父类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪模型头等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像使用常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源文件 >( 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 (
torch.FloatTensor，形状为(batch_size, sequence_length)) — 输入的原始语音波形的浮点数值。可以通过将.flac或.wav音频文件加载到list[float]或numpy.ndarray类型的数组中获得这些值，例如，使用 soundfile 库（pip install soundfile）。为了将数组准备成input_values，应使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。详见HubertProcessor.__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,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[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），包含根据配置 (HubertConfig) 和输入而定的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
HubertForSequenceClassification 的 forward 方法重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, HubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/hubert-base-ls960")
>>> model = HubertForSequenceClassification.from_pretrained("facebook/hubert-base-ls960")
>>> 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 = HubertForSequenceClassification.from_pretrained("facebook/hubert-base-ls960", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, HubertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/hubert-base-ls960")
>>> model = HubertForSequenceClassification.from_pretrained("facebook/hubert-base-ls960", 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 = HubertForSequenceClassification.from_pretrained(
... "facebook/hubert-base-ls960", 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).lossTFHubertModel
class transformers.TFHubertModel
< 源文件 >( config: HubertConfig *inputs **kwargs )
参数
- config (HubertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
一个基础的 TFHubert 模型，输出原始的隐藏状态（hidden-states），顶部没有任何特定的模型头（head）。
该模型继承自 TFPreTrainedModel。查阅父类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪模型头等）。
该模型也是一个 keras.Model 的子类。可以像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更倾向于这种格式。由于这种支持，当使用像 model.fit() 这样的方法时，一切都应该能“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签！然而，如果你想在像 fit() 和 predict() 这样的 Keras 方法之外使用第二种格式，例如在使用 Keras 的 Functional API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_values的张量，没有其他东西：model(input_values) - 一个包含一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序一致：
model([input_values, attention_mask])或model([input_values, attention_mask, token_type_ids]) - 一个包含一个或多个输入张量的字典，与文档字符串中给出的输入名称相关联：
model({"input_values": input_values, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，你无需担心任何这些问题，因为你可以像调用任何其他 Python 函数一样传递输入！
调用
< 源文件 >( 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 (
np.ndarray或tf.Tensor，形状为({0})，可选) — 用于避免在填充的标记索引上执行注意力计算的掩码。掩码值的选择范围为[0, 1]：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
- token_type_ids (
np.ndarray或tf.Tensor，形状为({0})，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引的选择范围为[0, 1]：- 0 对应于 *句子 A* 的标记，
- 1 对应于 *句子 B* 的标记。
- position_ids (
np.ndarray或tf.Tensor，形状为({0})，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值的选择范围为[0, 1]：- 1 表示头未被掩码，
- 0 表示头已被掩码。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为({0}, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_values。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_values索引转换为相关向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回的张量下的attentions。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的hidden_states。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可在 Eager 模式下使用，在图模式下该值将始终设置为 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 时），根据配置（HubertConfig）和输入，包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFHubertModel 的前向方法，重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, TFHubertModel
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> processor = AutoProcessor.from_pretrained("facebook/hubert-large-ls960-ft")
>>> model = TFHubertModel.from_pretrained("facebook/hubert-large-ls960-ft")
>>> 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_stateTFHubertForCTC
class transformers.TFHubertForCTC
< 源码 >( config: HubertConfig *inputs **kwargs )
参数
- config (HubertConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
TFHubert 模型顶部带有一个用于连接时序分类（Connectionist Temporal Classification, CTC）的 `语言建模` 头。
该模型继承自 TFPreTrainedModel。查阅父类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪模型头等）。
该模型也是一个 keras.Model 的子类。可以像使用常规 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更倾向于这种格式。由于这种支持，当使用像 model.fit() 这样的方法时，一切都应该能“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签！然而，如果你想在像 fit() 和 predict() 这样的 Keras 方法之外使用第二种格式，例如在使用 Keras 的 Functional API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_values的张量，没有其他东西：model(input_values) - 一个包含一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序一致：
model([input_values, attention_mask])或model([input_values, attention_mask, token_type_ids]) - 一个包含一个或多个输入张量的字典，与文档字符串中给出的输入名称相关联：
model({"input_values": input_values, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，你无需担心任何这些问题，因为你可以像调用任何其他 Python 函数一样传递输入！
调用
< 源码 >( input_values: tf.Tensor attention_mask: tf.Tensor | None = None token_type_ids: tf.Tensor | None = None position_ids: tf.Tensor | None = None head_mask: tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None labels: tf.Tensor | None = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFCausalLMOutput 或 tuple(tf.Tensor)
参数
- input_values (
np.ndarray、tf.Tensor、list[tf.Tensor]、dict[str, tf.Tensor]或dict[str, np.ndarray]，每个样本的形状必须为({0})) — 词汇表中输入序列词元的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor，形状为({0}), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示词元未被掩码，
- 0 表示词元被掩码。
- token_type_ids (
np.ndarray或tf.Tensor，形状为({0}), 可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引选自[0, 1]：- 0 对应于 *句子 A* 的词元，
- 1 对应于 *句子 B* 的词元。
- position_ids (
np.ndarray或tf.Tensor，形状为({0}), 可选) — 位置嵌入中每个输入序列词元的位置索引。选自范围[0, config.max_position_embeddings - 1]。 - head_mask (
np.ndarray或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值选自[0, 1]：- 1 表示头未被掩码，
- 0 表示头被掩码。
- inputs_embeds (
np.ndarray或tf.Tensor，形状为({0}, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_values。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_values索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可在 Eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为 `False`) — 是否将模型用于训练模式（某些模块如 dropout 在训练和评估之间有不同的行为）。 - labels (
tf.Tensor或np.ndarray，形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在[-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 时），根据配置（HubertConfig）和输入，包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFHubertForCTC 的前向方法，重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数中定义，但之后应调用 Module 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import tensorflow as tf
>>> from transformers import AutoProcessor, TFHubertForCTC
>>> from datasets import load_dataset
>>> import soundfile as sf
>>> processor = AutoProcessor.from_pretrained("facebook/hubert-large-ls960-ft")
>>> model = TFHubertForCTC.from_pretrained("facebook/hubert-large-ls960-ft")
>>> 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 the transcription as text to encode labels
>>> labels = processor(text=transcription, return_tensors="tf").input_values
>>> loss = model(input_values, labels=labels).loss