Transformers 文档

CLAP

CLAP

概述

CLAP模型由Yusong Wu、Ke Chen、Tianyu Zhang、Yuchen Hui、Taylor Berg-Kirkpatrick和Shlomo Dubnov在大规模对比语言-音频预训练与特征融合和关键词到字幕增强中提出。

CLAP(对比语言-音频预训练)是一种在多种(音频,文本)对上训练的神经网络。它可以在给定音频的情况下,预测最相关的文本片段,而无需直接针对任务进行优化。CLAP模型使用SWINTransformer从对数梅尔频谱图输入中获取音频特征,并使用RoBERTa模型获取文本特征。然后将文本和音频特征投影到具有相同维度的潜在空间中。投影后的音频和文本特征之间的点积被用作相似度分数。

论文的摘要如下:

对比学习在多模态表示学习领域取得了显著的成功。在本文中,我们提出了一种对比语言-音频预训练的流程,通过将音频数据与自然语言描述相结合来开发音频表示。为了实现这一目标,我们首先发布了LAION-Audio-630K,这是一个包含633,526个音频-文本对的大型数据集,这些数据来自不同的数据源。其次,我们通过考虑不同的音频编码器和文本编码器构建了一个对比语言-音频预训练模型。我们在模型设计中融入了特征融合机制和关键词到描述的增强,以进一步使模型能够处理可变长度的音频输入并提高性能。第三,我们进行了全面的实验,以评估我们的模型在三个任务中的表现:文本到音频检索、零样本音频分类和有监督音频分类。结果表明,我们的模型在文本到音频检索任务中表现出色。在音频分类任务中,该模型在零样本设置中达到了最先进的性能,并且能够在非零样本设置中获得与模型结果相当的性能。LAION-Audio-6

该模型由Younes BelkadaArthur Zucker贡献。 原始代码可以在这里找到。

ClapConfig

transformers.ClapConfig

< >

( text_config = None audio_config = None logit_scale_init_value = 14.285714285714285 projection_dim = 512 projection_hidden_act = 'relu' initializer_factor = 1.0 **kwargs )

参数

  • text_config (dict, optional) — 用于初始化ClapTextConfig的配置选项字典。
  • audio_config (dict, 可选) — 用于初始化 ClapAudioConfig 的配置选项字典.
  • logit_scale_init_value (float, optional, 默认为 14.29) — logit_scale 参数的初始值。默认值按照原始 CLAP 实现使用。
  • projection_dim (int, optional, 默认为 512) — 文本和音频投影层的维度。
  • projection_hidden_act (str, 可选, 默认为 "relu") — 投影层的激活函数。
  • initializer_factor (float, optional, 默认为 1.0) — 用于缩放模型权重初始化的因子。
  • kwargs (可选) — 关键字参数字典。

ClapConfig 是用于存储 ClapModel 配置的配置类。它用于根据指定的参数实例化一个 CLAP 模型,定义文本模型和音频模型的配置。使用默认值实例化配置将产生类似于 CLAP laion/clap-htsat-fused 架构的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import ClapConfig, ClapModel

>>> # Initializing a ClapConfig with laion-ai/base style configuration
>>> configuration = ClapConfig()

>>> # Initializing a ClapModel (with random weights) from the laion-ai/base style configuration
>>> model = ClapModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

>>> # We can also initialize a ClapConfig from a ClapTextConfig and a ClapAudioConfig
>>> from transformers import ClapTextConfig, ClapAudioConfig

>>> # Initializing a ClapText and ClapAudioConfig configuration
>>> config_text = ClapTextConfig()
>>> config_audio = ClapAudioConfig()

>>> config = ClapConfig.from_text_audio_configs(config_text, config_audio)

from_text_audio_configs

< >

( text_config: ClapTextConfig audio_config: ClapAudioConfig **kwargs ) ClapConfig

返回

ClapConfig

配置对象的一个实例

从clap文本模型配置和clap音频模型配置实例化一个ClapConfig(或派生类)。

ClapTextConfig

transformers.ClapTextConfig

< >

( vocab_size = 50265 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 514 type_vocab_size = 1 initializer_factor = 1.0 layer_norm_eps = 1e-12 projection_dim = 512 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 position_embedding_type = 'absolute' use_cache = True projection_hidden_act = 'relu' **kwargs )

参数

  • vocab_size (int, 可选, 默认为 30522) — CLAP 模型的词汇表大小。定义了调用 ClapTextModel 时传递的 inputs_ids 可以表示的不同标记的数量。
  • hidden_size (int, optional, 默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, optional, 默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, optional, defaults to 12) — Transformer编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, optional, 默认为 3072) — Transformer 编码器中“中间”(通常称为前馈)层的维度。
  • hidden_act (strCallable, 可选, 默认为 "relu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "relu", "relu", "silu""relu_new".
  • hidden_dropout_prob (float, optional, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, optional, defaults to 0.1) — 注意力概率的丢弃比例。
  • max_position_embeddings (int, optional, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一(例如,512、1024 或 2048)。
  • type_vocab_size (int, 可选, 默认为 2) — 调用 ClapTextModel 时传递的 token_type_ids 的词汇大小.
  • layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的epsilon值。
  • position_embedding_type (str, 可选, 默认为 "absolute") — 位置嵌入的类型。选择 "absolute", "relative_key", "relative_key_query" 中的一个。对于 位置嵌入,使用 "absolute"。有关 "relative_key" 的更多信息,请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。 有关 "relative_key_query" 的更多信息,请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 方法 4.
  • is_decoder (bool, 可选, 默认为 False) — 模型是否用作解码器。如果为 False,则模型用作编码器。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。仅在 config.is_decoder=True 时相关。
  • projection_hidden_act (str, 可选, 默认为 "relu") — 投影层中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu", "relu", "silu""gelu_new".
  • projection_dim (int, 可选, 默认为 512) — ClapTextModelWithProjection 的投影头的维度。

这是用于存储ClapTextModel配置的配置类。它用于根据指定的参数实例化CLAP模型,定义模型架构。使用默认值实例化配置将产生与CLAP calp-hsat-fused架构相似的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import ClapTextConfig, ClapTextModel

>>> # Initializing a CLAP text configuration
>>> configuration = ClapTextConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = ClapTextModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ClapAudioConfig

transformers.ClapAudioConfig

< >

( window_size = 8 num_mel_bins = 64 spec_size = 256 hidden_act = 'gelu' patch_size = 4 patch_stride = [4, 4] num_classes = 527 hidden_size = 768 projection_dim = 512 depths = [2, 2, 6, 2] num_attention_heads = [4, 8, 16, 32] enable_fusion = False hidden_dropout_prob = 0.1 fusion_type = None patch_embed_input_channels = 1 flatten_patch_embeds = True patch_embeds_hidden_size = 96 enable_patch_layer_norm = True drop_path_rate = 0.0 attention_probs_dropout_prob = 0.0 qkv_bias = True mlp_ratio = 4.0 aff_block_r = 4 num_hidden_layers = 4 projection_hidden_act = 'relu' layer_norm_eps = 1e-05 initializer_factor = 1.0 **kwargs )

参数

  • window_size (int, 可选, 默认为 8) — 频谱图的图像大小
  • num_mel_bins (int, 可选, 默认为 64) — 每帧使用的梅尔特征数量。应与 ClapProcessor 类中使用的值对应。
  • spec_size (int, 可选, 默认为 256) — 模型支持的频谱图的期望输入大小。它可以与 ClapFeatureExtractor 的输出不同,在这种情况下,输入特征将被调整大小。对应于音频模型的 image_size
  • hidden_act (str, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu""relu""silu""gelu_new"
  • patch_size (int, optional, defaults to 4) — 音频频谱图的补丁大小
  • patch_stride (list, optional, defaults to [4, 4]) — 音频频谱图的补丁步幅
  • num_classes (int, optional, 默认为 527) — 用于头部训练的类别数量
  • hidden_size (int, optional, 默认为 768) — 音频编码器输出的隐藏大小。对应于倒数第二层输出的维度,该输出被发送到投影 MLP 层。
  • projection_dim (int, optional, 默认为 512) — 投影层的隐藏大小。
  • depths (list, 可选, 默认为 [2, 2, 6, 2]) — 用于音频模型的Swin层的深度
  • num_attention_heads (list, 可选, 默认为 [4, 8, 16, 32]) — 用于音频模型的Swin层的注意力头数量
  • enable_fusion (bool, 可选, 默认为 False) — 是否启用补丁融合。这是作者的主要贡献,应该会给出最佳结果。
  • hidden_dropout_prob (float, optional, defaults to 0.1) — 编码器中所有全连接层的dropout概率。
  • fusion_type ([type], 可选) — 用于补丁融合的融合类型。
  • patch_embed_input_channels (int, optional, 默认为 1) — 用于输入频谱图的通道数
  • flatten_patch_embeds (bool, optional, defaults to True) — 是否展平补丁嵌入
  • patch_embeds_hidden_size (int, optional, 默认为 96) — 补丁嵌入的隐藏大小。它被用作输出通道的数量。
  • enable_patch_layer_norm (bool, optional, defaults to True) — 是否启用补丁嵌入的层归一化
  • drop_path_rate (float, optional, defaults to 0.0) — 用于补丁融合的路径丢弃率
  • attention_probs_dropout_prob (float, optional, defaults to 0.0) — 注意力概率的丢弃比例。
  • qkv_bias (bool, optional, defaults to True) — 是否在查询、键、值投影中添加偏置。
  • mlp_ratio (float, optional, defaults to 4.0) — MLP隐藏维度与嵌入维度的比率。
  • aff_block_r (int, 可选, 默认为 4) — AudioFF 块中使用的缩小比例
  • num_hidden_layers (int, optional, defaults to 4) — Transformer编码器中的隐藏层数量。
  • projection_hidden_act (str, 可选, 默认为 "relu") — 投影层中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu""relu""silu""gelu_new"
  • layer_norm_eps ([type], optional, defaults to 1e-05) — 层归一化层使用的epsilon值。
  • initializer_factor (float, 可选, 默认为 1.0) — 用于初始化所有权重矩阵的因子(应保持为1,内部用于初始化测试)。

这是用于存储ClapAudioModel配置的配置类。它用于根据指定的参数实例化一个CLAP音频编码器,定义模型架构。使用默认值实例化配置将产生与CLAP音频编码器laion/clap-htsat-fused架构类似的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。阅读PretrainedConfig的文档以获取更多信息。

示例:

>>> from transformers import ClapAudioConfig, ClapAudioModel

>>> # Initializing a ClapAudioConfig with laion/clap-htsat-fused style configuration
>>> configuration = ClapAudioConfig()

>>> # Initializing a ClapAudioModel (with random weights) from the laion/clap-htsat-fused style configuration
>>> model = ClapAudioModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ClapFeatureExtractor

transformers.ClapFeatureExtractor

< >

( feature_size = 64 sampling_rate = 48000 hop_length = 480 max_length_s = 10 fft_window_size = 1024 padding_value = 0.0 return_attention_mask = False frequency_min: float = 0 frequency_max: float = 14000 top_db: int = None truncation: str = 'fusion' padding: str = 'repeatpad' **kwargs )

参数

  • feature_size (int, optional, defaults to 64) — 提取的梅尔频谱图的特征维度。这对应于梅尔滤波器的数量 (n_mels).
  • sampling_rate (int, optional, defaults to 48000) — 音频文件应被数字化的采样率,以赫兹(Hz)表示。这仅用于警告用户,如果输入到特征提取器的音频不具有相同的采样率。
  • hop_length (int,可选, 默认为 480) — 用于获取梅尔频谱图的短时傅里叶变换(STFT)的重叠窗口长度。音频将被分割成较小的frames,每帧之间的步长为hop_length
  • max_length_s (int, optional, 默认为 10) — 模型的最大输入长度,以秒为单位。这用于填充音频。
  • fft_window_size (int, optional, defaults to 1024) — 应用傅里叶变换的窗口大小(以样本为单位)。这控制了频谱图的频率分辨率。400 表示在 400 个样本的窗口上计算傅里叶变换。
  • padding_value (float, 可选, 默认为 0.0) — 用于填充音频的填充值。应对应于静音部分。
  • return_attention_mask (bool, optional, defaults to False) — 模型是否应返回与输入相对应的注意力掩码。
  • frequency_min (float, optional, defaults to 0) — 感兴趣的最低频率。对于低于此值的频率,将不会计算STFT。
  • frequency_max (float, optional, 默认值为 14000) — 感兴趣的最高频率。STFT 将不会计算高于此值的频率。
  • top_db (float, 可选) — 用于将梅尔频谱图转换为对数刻度的最高分贝值。更多详情请参见 audio_utils.power_to_db 函数
  • 截断 (str, 可选, 默认为 "fusion") — 长音频输入的截断模式。有两种模式可用:
    • fusion 将使用 _random_mel_fusion,它从梅尔频谱图中堆叠3个随机裁剪和一个 整个梅尔频谱图的下采样版本。 如果 config.fusion 设置为 True,较短的音频也需要返回4个梅尔频谱图,这些将只是从填充音频中获得的原始梅尔频谱图的副本。
    • rand_trunc 将选择梅尔频谱图的一个随机裁剪。
  • padding (str, 可选, 默认为 "repeatpad") — 用于较短音频输入的填充模式。最初实现了三种模式:
    • repeatpad: 音频被重复,然后填充以适合 max_length
    • repeat: 音频被重复,然后截断以适合 max_length
    • pad: 音频被填充。

构建一个CLAP特征提取器。

此特征提取器继承自SequenceFeatureExtractor,其中包含 大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

该类使用自定义的numpy实现从原始语音中提取梅尔滤波器组特征,该实现应与pytorch的torch.stft等效。

to_dict

< >

( ) Dict[str, Any]

返回

Dict[str, Any]

构成此配置实例的所有属性的字典,除了梅尔滤波器组,因为它们太长而不需要保存或打印。

将此实例序列化为Python字典。

ClapProcessor

transformers.ClapProcessor

< >

( feature_extractor tokenizer )

参数

构建一个CLAP处理器,它将CLAP特征提取器和RoBerta分词器封装到一个单一的处理器中。

ClapProcessor 提供了 ClapFeatureExtractorRobertaTokenizerFast 的所有功能。更多信息请参见 __call__()decode()

batch_decode

< >

( *args **kwargs )

此方法将其所有参数转发给RobertaTokenizerFast的batch_decode()。请参考该方法的文档字符串以获取更多信息。

解码

< >

( *args **kwargs )

此方法将其所有参数转发给RobertaTokenizerFast的decode()。请参考该方法的文档字符串以获取更多信息。

ClapModel

transformers.ClapModel

< >

( config: ClapConfig )

参数

  • config (ClapConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。

该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

< >

( input_ids: typing.Optional[torch.LongTensor] = None input_features: typing.Optional[torch.FloatTensor] = None is_longer: typing.Optional[torch.BoolTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None return_loss: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.clap.modeling_clap.ClapOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.max_position_embeddings - 1].

    什么是位置ID?

  • input_features (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 输入音频特征。这应该由ClapFeatureExtractor类返回,你也可以从AutoFeatureExtractor中获取。详情请参见ClapFeatureExtractor.__call__().
  • return_loss (bool, optional) — 是否返回对比损失。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。

返回

transformers.models.clap.modeling_clap.ClapOutputtuple(torch.FloatTensor)

一个 transformers.models.clap.modeling_clap.ClapOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置()和输入而定的各种元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,当 return_lossTrue 时返回) — 音频-文本相似性的对比损失。
  • logits_per_audio (torch.FloatTensor 形状为 (audio_batch_size, text_batch_size)) — audio_embedstext_embeds 之间的缩放点积分数。这表示音频-文本相似性分数。
  • logits_per_text (torch.FloatTensor 形状为 (text_batch_size, audio_batch_size)) — text_embedsaudio_embeds 之间的缩放点积分数。这表示文本-音频相似性分数。
  • text_embeds (torch.FloatTensor 形状为 (batch_size, output_dim) — 通过将投影层应用于 ClapTextModel 的池化输出获得的文本嵌入。
  • audio_embeds (torch.FloatTensor 形状为 (batch_size, output_dim) — 通过将投影层应用于 ClapAudioModel 的池化输出获得的音频嵌入。
  • text_model_output (BaseModelOutputWithPooling) — ClapTextModel 的输出。
  • audio_model_output (BaseModelOutputWithPooling) — ClapAudioModel 的输出。

ClapModel 的 forward 方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from datasets import load_dataset
>>> from transformers import AutoProcessor, ClapModel

>>> dataset = load_dataset("hf-internal-testing/ashraq-esc50-1-dog-example")
>>> audio_sample = dataset["train"]["audio"][0]["array"]

>>> model = ClapModel.from_pretrained("laion/clap-htsat-unfused")
>>> processor = AutoProcessor.from_pretrained("laion/clap-htsat-unfused")

>>> input_text = ["Sound of a dog", "Sound of vaccum cleaner"]

>>> inputs = processor(text=input_text, audios=audio_sample, return_tensors="pt", padding=True)

>>> outputs = model(**inputs)
>>> logits_per_audio = outputs.logits_per_audio  # this is the audio-text similarity score
>>> probs = logits_per_audio.softmax(dim=-1)  # we can take the softmax to get the label probabilities

get_text_features

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) 文本特征 (torch.FloatTensor 形状为 (batch_size, output_dim)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.max_position_embeddings - 1].

    什么是位置ID?

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。

返回

文本特征 (torch.FloatTensor 形状为 (batch_size, output_dim)

通过将投影层应用于ClapTextModel的池化输出获得的文本嵌入。

ClapModel 的 forward 方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from transformers import AutoTokenizer, ClapModel

>>> model = ClapModel.from_pretrained("laion/clap-htsat-unfused")
>>> tokenizer = AutoTokenizer.from_pretrained("laion/clap-htsat-unfused")

>>> inputs = tokenizer(["the sound of a cat", "the sound of a dog"], padding=True, return_tensors="pt")
>>> text_features = model.get_text_features(**inputs)

get_audio_features

< >

( input_features: typing.Optional[torch.Tensor] = None is_longer: typing.Optional[torch.Tensor] = None 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 ) 音频特征 (torch.FloatTensor 形状为 (batch_size, output_dim)

参数

  • input_features (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 输入音频特征。这应该由ClapFeatureExtractor类返回,你也可以从AutoFeatureExtractor中获取。详情请参见ClapFeatureExtractor.__call__().
  • is_longer (torch.FloatTensor, 形状为 (batch_size, 1), 可选) — 音频片段是否长于 max_length。如果为 True,将启用特征融合以增强特征。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

音频特征 (torch.FloatTensor 形状为 (batch_size, output_dim)

通过将投影层应用于ClapAudioModel的池化输出获得的音频嵌入。

ClapModel 的 forward 方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from transformers import AutoFeatureExtractor, ClapModel
>>> import torch

>>> model = ClapModel.from_pretrained("laion/clap-htsat-unfused")
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("laion/clap-htsat-unfused")
>>> random_audio = torch.rand((16_000))
>>> inputs = feature_extractor(random_audio, return_tensors="pt")
>>> audio_features = model.get_audio_features(**inputs)

ClapTextModel

transformers.ClapTextModel

< >

( config add_pooling_layer = True )

该模型可以作为编码器(仅具有自注意力机制)以及解码器,在这种情况下,自注意力层之间会添加一层交叉注意力层,遵循Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser和Illia Polosukhin在Attention is all you need_中描述的架构。

要作为解码器使用,模型需要使用配置中的is_decoder参数初始化为True。要在Seq2Seq模型中使用,模型需要同时使用is_decoder参数和add_cross_attention参数初始化为True;然后在前向传递中需要输入encoder_hidden_states

.. _注意力就是一切: https://arxiv.org/abs/1706.03762

前进

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None )

encoder_hidden_states (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), 可选): 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。 encoder_attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), 可选): 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器,则在交叉注意力中使用此掩码。掩码值在 [0, 1] 中选择:

  • 1 表示 未屏蔽 的标记,
  • 0 表示被掩码的标记。 past_key_values (tuple(tuple(torch.FloatTensor)),长度为config.n_layers,每个元组包含4个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量): 包含预先计算的注意力块的键和值隐藏状态。可用于加速解码。

如果使用了past_key_values,用户可以选择只输入最后一个decoder_input_ids(那些没有将其过去键值状态提供给此模型的)形状为(batch_size, 1),而不是所有形状为(batch_size, sequence_length)decoder_input_ids。 use_cache (bool, 可选): 如果设置为Truepast_key_values键值状态将被返回,并可用于加速解码(参见past_key_values)。

ClapTextModelWithProjection

transformers.ClapTextModelWithProjection

< >

( config: ClapTextConfig )

参数

  • config (ClapConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

CLAP文本模型,顶部有一个投影层(在池化输出之上的线性层)。

该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。

该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: 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.models.clap.modeling_clap.ClapTextModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide it.

    可以使用AutoTokenizer获取索引。详情请参见PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.max_position_embeddings - 1].

    什么是位置ID?

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个ModelOutput而不是一个普通的元组。

返回

transformers.models.clap.modeling_clap.ClapTextModelOutputtuple(torch.FloatTensor)

一个 transformers.models.clap.modeling_clap.ClapTextModelOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置()和输入。

  • text_embeds (torch.FloatTensor 形状为 (batch_size, output_dim) 可选,当模型使用 with_projection=True 初始化时返回) — 通过将投影层应用于 pooler_output 获得的文本嵌入。

  • 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 后的注意力权重,用于计算自注意力头中的加权平均值。

ClapTextModelWithProjection 的前向方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from transformers import AutoTokenizer, ClapTextModelWithProjection

>>> model = ClapTextModelWithProjection.from_pretrained("laion/clap-htsat-unfused")
>>> tokenizer = AutoTokenizer.from_pretrained("laion/clap-htsat-unfused")

>>> inputs = tokenizer(["a sound of a cat", "a sound of a dog"], padding=True, return_tensors="pt")

>>> outputs = model(**inputs)
>>> text_embeds = outputs.text_embeds

ClapAudioModel

transformers.ClapAudioModel

< >

( config: ClapAudioConfig )

前进

< >

( input_features: typing.Optional[torch.FloatTensor] = None is_longer: 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.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • input_features (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 输入音频特征。这应该由ClapFeatureExtractor类返回,你也可以从AutoFeatureExtractor中获取。详情请参见ClapFeatureExtractor.__call__().
  • is_longer (torch.FloatTensor, 形状为 (batch_size, 1), 可选) — 音频片段是否长于 max_length。如果为 True,将启用特征融合以增强特征。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置()和输入。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  • pooler_output (torch.FloatTensor 形状为 (batch_size, hidden_size)) — 序列的第一个标记(分类标记)在经过用于辅助预训练任务的层进一步处理后的最后一层隐藏状态。例如,对于BERT系列模型,这返回经过线性层和tanh激活函数处理后的分类标记。线性层的权重是在预训练期间通过下一个句子预测(分类)目标进行训练的。

  • 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之后,用于计算自注意力头中的加权平均值。

ClapAudioModel 的 forward 方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from datasets import load_dataset
>>> from transformers import AutoProcessor, ClapAudioModel

>>> dataset = load_dataset("hf-internal-testing/ashraq-esc50-1-dog-example")
>>> audio_sample = dataset["train"]["audio"][0]["array"]

>>> model = ClapAudioModel.from_pretrained("laion/clap-htsat-fused")
>>> processor = AutoProcessor.from_pretrained("laion/clap-htsat-fused")

>>> inputs = processor(audios=audio_sample, return_tensors="pt")

>>> outputs = model(**inputs)
>>> last_hidden_state = outputs.last_hidden_state

ClapAudioModelWithProjection

transformers.ClapAudioModelWithProjection

< >

( config: ClapAudioConfig )

参数

  • config (ClapConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法以加载模型权重。

CLAP音频模型,顶部有一个投影层(在池化输出之上的线性层)。

该模型继承自PreTrainedModel。请查看超类文档以了解库为其所有模型实现的通用方法(如下载或保存、调整输入嵌入的大小、修剪头部等)。

该模型也是一个PyTorch torch.nn.Module 子类。 将其作为常规的PyTorch模块使用,并参考PyTorch文档以获取与一般使用和行为相关的所有信息。

前进

< >

( input_features: typing.Optional[torch.FloatTensor] = None is_longer: 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.clap.modeling_clap.ClapAudioModelOutputtuple(torch.FloatTensor)

参数

  • input_features (torch.FloatTensor of shape (batch_size, num_channels, height, width)) — 输入音频特征。这应该由ClapFeatureExtractor类返回,你也可以从AutoFeatureExtractor中获取。详情请参见ClapFeatureExtractor.__call__().
  • is_longer (torch.FloatTensor, 形状为 (batch_size, 1), 可选) — 音频片段是否长于 max_length。如果为 True,将启用特征融合以增强特征。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.models.clap.modeling_clap.ClapAudioModelOutputtuple(torch.FloatTensor)

一个 transformers.models.clap.modeling_clap.ClapAudioModelOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置 () 和输入。

  • audio_embeds (torch.FloatTensor 形状为 (batch_size, hidden_size)) — 通过将投影层应用于 pooler_output 获得的音频嵌入。

  • last_hidden_state (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 后的注意力权重,用于计算自注意力头中的加权平均值。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 由 torch.FloatTensor 组成的元组(一个用于嵌入层的输出,如果模型有嵌入层,+ 一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型每层输出的隐藏状态加上可选的初始嵌入输出。

ClapAudioModelWithProjection 的前向方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from datasets import load_dataset
>>> from transformers import ClapAudioModelWithProjection, ClapProcessor

>>> model = ClapAudioModelWithProjection.from_pretrained("laion/clap-htsat-fused")
>>> processor = ClapProcessor.from_pretrained("laion/clap-htsat-fused")

>>> dataset = load_dataset("hf-internal-testing/ashraq-esc50-1-dog-example")
>>> audio_sample = dataset["train"]["audio"][0]["array"]

>>> inputs = processor(audios=audio_sample, return_tensors="pt")
>>> outputs = model(**inputs)
>>> audio_embeds = outputs.audio_embeds
< > Update on GitHub