Transformers 文档
SEW-D
并获得增强的文档体验
开始
SEW-D
概述
SEW-D (Squeezed and Efficient Wav2Vec with Disentangled attention) 由 Felix Wu, Kwangyoun Kim, Jing Pan, Kyu Han, Kilian Q. Weinberger, Yoav Artzi 在 Performance-Efficiency Trade-offs in Unsupervised Pre-training for Speech Recognition 中提出。
论文摘要如下:
本文研究了用于自动语音识别(ASR)的预训练模型中的性能-效率权衡。我们专注于 wav2vec 2.0,并形式化了几个影响模型性能及其效率的架构设计。结合我们所有的观察结果,我们推出了 SEW (Squeezed and Efficient Wav2vec),这是一种预训练模型架构,在各种训练设置中,在性能和效率维度上都有显着改进。例如,在 LibriSpeech 上的 100h-960h 半监督设置下,与 wav2vec 2.0 相比,SEW 实现了 1.9 倍的推理加速,并且词错误率相对降低了 13.5%。在相似的推理时间下,SEW 在不同的模型尺寸下将词错误率降低了 25-50%。
此模型由 anton-l 贡献。
使用技巧
- SEW-D 是一个语音模型,它接受对应于语音信号原始波形的浮点数组。
- SEWDForCTC 使用连接时序分类 (CTC) 进行微调,因此模型输出必须使用 Wav2Vec2CTCTokenizer 进行解码。
资源
SEWDConfig
class transformers.SEWDConfig
< source >( vocab_size = 32 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 squeeze_factor = 2 max_position_embeddings = 512 position_buckets = 256 share_att_key = True relative_attention = True pos_att_type = ('p2c', 'c2p') norm_rel_ebd = 'layer_norm' hidden_act = 'gelu_python' hidden_dropout = 0.1 activation_dropout = 0.1 attention_dropout = 0.1 feat_proj_dropout = 0.0 final_dropout = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-07 feature_layer_norm_eps = 1e-05 feat_extract_norm = 'group' feat_extract_activation = 'gelu' conv_dim = (64, 128, 128, 128, 128, 256, 256, 256, 256, 512, 512, 512, 512) conv_stride = (5, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1) conv_kernel = (10, 3, 1, 3, 1, 3, 1, 3, 1, 2, 1, 2, 1) conv_bias = False num_conv_pos_embeddings = 128 num_conv_pos_embedding_groups = 16 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 = 'mean' 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
, optional, defaults to 32) — SEW-D 模型的词汇表大小。定义了调用SEWD
时传递的inputs_ids
可以表示的不同标记的数量。 - hidden_size (
int
, optional, defaults to 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int
, optional, defaults to 12) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int
, optional, defaults to 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int
, optional, defaults to 3072) — Transformer 编码器中“中间”(即,前馈)层的维度。 - squeeze_factor (
int
, optional, defaults to 2) — 编码器后的序列长度下采样因子和 Transformer 后的上采样因子。 - max_position_embeddings (
int
, optional, defaults to 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一(例如,512 或 1024 或 2048)。 - position_buckets (
int
, optional, defaults to 256) — 相对位置嵌入的最大尺寸。 - share_att_key (
bool
, optional, defaults toTrue
) — 是否与 c2p 和 p2c 共享注意力键。 - relative_attention (
bool
, optional, defaults toTrue
) — 是否使用相对位置编码。 - pos_att_type (
Tuple[str]
, optional, defaults to("p2c", "c2p")
) — 相对位置注意力的类型,可以是("p2c", "c2p")
的组合,例如("p2c")
,("p2c", "c2p")
,("p2c", "c2p")
。 - norm_rel_ebd (
str
, optional, defaults to"layer_norm"
) — 是否在相对嵌入中使用层归一化(如果是,则为"layer_norm"
)。 - hidden_act (
str
或function
, optional, defaults to"gelu_python"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持"gelu"
,"relu"
,"selu"
,"gelu_python"
和"gelu_new"
。 - hidden_dropout (
float
, optional, defaults to 0.1) — 已弃用。模型未使用,将在未来版本中移除。 - activation_dropout (
float
, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float
, optional, defaults to 0.1) — 注意力概率的 dropout 比率。 - final_dropout (
float
, optional, defaults to 0.1) — SEWDForCTC 的最终投影层的 dropout 概率。 - initializer_range (
float
, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float
, optional, defaults to 1e-7) — Transformer 编码器中层归一化层使用的 epsilon 值。 - feature_layer_norm_eps (
float
, optional, defaults to 1e-5) — 特征编码器后的层归一化使用的 epsilon 值。 - feat_extract_norm (
str
, optional, defaults to"group"
) — 应用于特征编码器中 1D 卷积层的归一化方法。可以是"group"
(仅对第一个 1D 卷积层进行组归一化)或"layer"
(对所有 1D 卷积层进行层归一化)。 - feat_proj_dropout (
float
, optional, defaults to 0.0) — 特征编码器输出的 dropout 概率。 - feat_extract_activation (
str,
optional, defaults to
“gelu”) -- 特征提取器 1D 卷积层中的非线性激活函数(函数或字符串)。如果为字符串,则支持
“gelu”,
“relu”,
“selu”和
“gelu_new”`。 - conv_dim (
Tuple[int]
或List[int]
, optional, defaults to(64, 128, 128, 128, 128, 256, 256, 256, 256, 512, 512, 512, 512)
) — 定义特征编码器中每个 1D 卷积层的输入和输出通道数的整数元组。conv_dim 的长度定义了 1D 卷积层的数量。 - conv_stride (
Tuple[int]
或List[int]
, optional, defaults to(5, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1)
) — 定义特征编码器中每个 1D 卷积层的步长的整数元组。conv_stride 的长度定义了卷积层的数量,并且必须与 conv_dim 的长度匹配。 - conv_kernel (
Tuple[int]
或List[int]
, optional, defaults to(10, 3, 1, 3, 1, 3, 1, 3, 1, 2, 1, 2, 1)
) — 定义特征编码器中每个 1D 卷积层的内核大小的整数元组。conv_kernel 的长度定义了卷积层的数量,并且必须与 conv_dim 的长度匹配。 - conv_bias (
bool
, optional, defaults toFalse
) — 1D 卷积层是否具有偏置。 - num_conv_pos_embeddings (
int
, optional, defaults to 128) — 卷积位置嵌入的数量。定义 1D 卷积位置嵌入层的内核大小。 - num_conv_pos_embedding_groups (
int
, optional, defaults to 16) — 1D 卷积位置嵌入层的组数。 - apply_spec_augment (
bool
, optional, defaults toTrue
) — 是否对特征编码器的输出应用 SpecAugment 数据增强。有关参考,请参阅 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition。 - mask_time_prob (
float
, optional, defaults to 0.05) — 沿时间轴的所有特征向量将被屏蔽的百分比(介于 0 和 1 之间)。屏蔽过程生成 “mask_time_problen(time_axis)/mask_time_length” 个轴上的独立掩码。如果从每个特征向量被选为要屏蔽的向量跨度的起点的概率来推断,mask_time_prob* 应该是prob_vector_start*mask_time_length
。请注意,重叠可能会降低实际屏蔽向量的百分比。这仅在apply_spec_augment is True
时相关。 - mask_time_length (
int
, optional, defaults to 10) — 沿时间轴的向量跨度长度。 - mask_time_min_masks (
int
, optional, defaults to 2), — 沿时间轴生成的长度为mask_feature_length
的最小掩码数,每个时间步,与mask_feature_prob
无关。仅在 “mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks” 时相关。 - mask_feature_prob (
float
, optional, defaults to 0.0) — 沿特征轴的所有特征向量将被屏蔽的百分比(介于 0 和 1 之间)。屏蔽过程生成 “mask_feature_problen(feature_axis)/mask_time_length” 个轴上的独立掩码。如果从每个特征向量被选为要屏蔽的向量跨度的起点的概率来推断,mask_feature_prob* 应该是prob_vector_start*mask_feature_length
。请注意,重叠可能会降低实际屏蔽向量的百分比。这仅在apply_spec_augment is True
时相关。 - mask_feature_length (
int
, optional, defaults to 10) — 沿特征轴的向量跨度长度。 - mask_feature_min_masks (
int
, optional, defaults to 0), — 沿特征轴生成的长度为mask_feature_length
的最小掩码数,每个时间步,与mask_feature_prob
无关。仅在 “mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks” 时相关。 - diversity_loss_weight (
int
, optional, defaults to 0.1) — 代码本多样性损失分量的权重。 - ctc_loss_reduction (
str
, optional, defaults to"sum"
) — 指定应用于torch.nn.CTCLoss
输出的缩减方法。仅在训练 SEWDForCTC 实例时相关。 - ctc_zero_infinity (
bool
, optional, defaults toFalse
) — 是否将torch.nn.CTCLoss
的无限损失及其相关梯度置零。当输入太短而无法与目标对齐时,主要会发生无限损失。仅在训练 SEWDForCTC 实例时相关。 - use_weighted_layer_sum (
bool
, optional, defaults toFalse
) — 是否使用带有学习权重的层输出的加权平均值。仅在使用 Wav2Vec2ForSequenceClassification 的实例时相关。 - classifier_proj_size (
int
, optional, defaults to 256) — 分类前 token 均值池化之前的投影维度。
这是用于存储 SEWDModel 配置的配置类。它用于根据指定的参数实例化 SEW-D 模型,定义模型架构。使用默认值实例化配置将产生类似于 SEW-D asapp/sew-d-tiny-100k 架构的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import SEWDConfig, SEWDModel
>>> # Initializing a SEW-D asapp/sew-d-tiny-100k style configuration
>>> configuration = SEWDConfig()
>>> # Initializing a model (with random weights) from the asapp/sew-d-tiny-100k style configuration
>>> model = SEWDModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
将此实例序列化为 Python 字典。
SEWDModel
class transformers.SEWDModel
< source >( config: SEWDConfig )
参数
- config (SEWDConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 SEW-D 模型 Transformer,输出原始隐藏状态,顶部没有任何特定的 head。SEW-D 在 语音识别无监督预训练中的性能-效率权衡 中提出,作者为 Felix Wu、Kwangyoun Kim、Jing Pan、Kyu Han、Kilian Q. Weinberger、Yoav Artzi。
此模型继承自 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.BaseModelOutput or tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor
,形状为(batch_size, sequence_length)
) — 输入原始语音波形的浮点值。值可以通过将.flac
或.wav
音频文件加载到List[float]
类型的数组或numpy.ndarray
中获得,例如 通过 soundfile 库 (pip install soundfile
)。要将数组准备为input_values
,应使用 AutoProcessor 进行填充并转换为torch.FloatTensor
类型的张量。有关详细信息,请参见 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor
,形状为(batch_size, sequence_length)
,可选) — 掩码,用于避免在填充 token 索引上执行卷积和注意力。掩码值在[0, 1]
中选择:- 1 表示 未被掩码 的 token,
- 0 表示 被掩码 的 token。
- 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
时),包含各种元素,具体取决于配置 (SEWDConfig) 和输入。
-
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 之后的注意力权重,用于计算自注意力头中的加权平均值。
SEWDModel forward 方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, SEWDModel
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("asapp/sew-d-tiny-100k-ft-ls100h")
>>> model = SEWDModel.from_pretrained("asapp/sew-d-tiny-100k-ft-ls100h")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 292, 384]
SEWDForCTC
class transformers.SEWDForCTC
< source >( config target_lang: typing.Optional[str] = None )
参数
- config (SEWDConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有用于连接时序分类 (CTC) 的 语言建模
head 的 SEW-D 模型。SEW-D 在 语音识别无监督预训练中的性能-效率权衡 中提出,作者为 Felix Wu、Kwangyoun Kim、Jing Pan、Kyu Han、Kilian Q. Weinberger、Yoav Artzi。
此模型继承自 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 or tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor
,形状为(batch_size, sequence_length)
) — 输入原始语音波形的浮点值。值可以通过将.flac
或.wav
音频文件加载到List[float]
类型的数组或numpy.ndarray
中获得,例如 通过 soundfile 库 (pip install soundfile
)。要将数组准备为input_values
,应使用 AutoProcessor 进行填充并转换为torch.FloatTensor
类型的张量。有关详细信息,请参见 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor
,形状为(batch_size, sequence_length)
,可选) — 掩码,用于避免在填充 token 索引上执行卷积和注意力。掩码值在[0, 1]
中选择:- 1 表示 未被掩码 的 token,
- 0 表示 被掩码 的 token。
- output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
。 - return_dict (
bool
,可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (形状为
(batch_size, target_length)
的torch.LongTensor
,可选) — 用于连接时序分类的标签。 请注意,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
时),包含各种元素,具体取决于配置 (SEWDConfig) 和输入。
-
loss (形状为
(1,)
的torch.FloatTensor
,可选,当提供labels
时返回) — 语言建模损失(用于下一个 token 预测)。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)
的torch.FloatTensor
) — 语言建模头的预测分数(SoftMax 之前每个词汇表 token 的分数)。 -
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 之后的注意力权重,用于计算自注意力头中的加权平均值。
SEWDForCTC 前向传播方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoProcessor, SEWDForCTC
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("asapp/sew-d-tiny-100k-ft-ls100h")
>>> model = SEWDForCTC.from_pretrained("asapp/sew-d-tiny-100k-ft-ls100h")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_ids = torch.argmax(logits, dim=-1)
>>> # transcribe speech
>>> transcription = processor.batch_decode(predicted_ids)
>>> transcription[0]
'MISTER QUILTER IS THE APOSTIL OF THE MIDDLE CLASSES AND WE ARE GLAD TO WELCOME HIS GOSPEL'
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
0.21
SEWDForSequenceClassification
class transformers.SEWDForSequenceClassification
< source >( config )
参数
- config (SEWDConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重,仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有序列分类头的 SEWD 模型(池化输出之上的线性层),用于诸如 SUPERB 关键词检测之类的任务。
SEW-D 在 Performance-Efficiency Trade-offs in Unsupervised Pre-training for Speech Recognition 中提出,作者是 Felix Wu, Kwangyoun Kim, Jing Pan, Kyu Han, Kilian Q. Weinberger, Yoav Artzi。
此模型继承自 PreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法(例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_values (形状为
(batch_size, sequence_length)
的torch.FloatTensor
) — 输入原始语音波形的浮点值。 值可以通过将.flac
或.wav
音频文件加载到List[float]
类型的数组或numpy.ndarray
中获得,例如 通过 soundfile 库 (pip install soundfile
)。 要将数组准备为input_values
,应使用 AutoProcessor 进行填充并转换为torch.FloatTensor
类型的张量。 有关详细信息,请参见 Wav2Vec2Processor.call()。 - attention_mask (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。 在[0, 1]
中选择的掩码值:- 1 表示未被掩盖的 token,
- 0 表示被掩盖的 token。
- 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
时),包含各种元素,具体取决于配置 (SEWDConfig) 和输入。
-
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 之后的注意力权重,用于计算自注意力头中的加权平均值。
SEWDForSequenceClassification 前向传播方法,覆盖了 __call__
特殊方法。
尽管 forward 传递的配方需要在该函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, SEWDForSequenceClassification
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("anton-l/sew-d-mid-400k-ft-keyword-spotting")
>>> model = SEWDForSequenceClassification.from_pretrained("anton-l/sew-d-mid-400k-ft-keyword-spotting")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.argmax(logits, dim=-1).item()
>>> predicted_label = model.config.id2label[predicted_class_ids]
>>> predicted_label
'_unknown_'
>>> # compute loss - target_label is e.g. "down"
>>> target_label = model.config.id2label[0]
>>> inputs["labels"] = torch.tensor([model.config.label2id[target_label]])
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
3.16