Transformers 文档

Pop2Piano

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Pop2Piano

PyTorch

概述

Pop2Piano 模型由 Jongho Choi 和 Kyogu Lee 在 Pop2Piano : Pop Audio-based Piano Cover Generation 中提出。

流行音乐的钢琴翻唱广受欢迎,但从音乐中生成钢琴翻唱并非易事。这需要精湛的钢琴演奏技巧以及对歌曲不同特点和旋律的了解。使用 Pop2Piano,您可以直接从歌曲的音频波形生成翻唱。它是第一个直接从流行音频生成钢琴翻唱,而无需旋律和和弦提取模块的模型。

Pop2Piano 是一种基于 T5 的编码器-解码器 Transformer 模型。输入音频被转换为其波形并传递给编码器,编码器将其转换为潜在表示。解码器使用这些潜在表示以自回归方式生成 token id。每个 token id 对应于四种不同 token 类型之一:时间、速度、音符和“特殊”。然后将 token id 解码为其等效的 MIDI 文件。

论文的摘要如下:

流行音乐的钢琴翻唱受到许多人的喜爱。然而,自动生成流行音乐钢琴翻唱的任务仍然未被充分研究。部分原因是缺乏同步的 {Pop, Piano Cover} 数据对,这使得应用最新的数据密集型深度学习方法具有挑战性。为了利用数据驱动方法的强大功能,我们使用自动化流程制作了大量配对和同步的 {Pop, Piano Cover} 数据。在本文中,我们提出了 Pop2Piano,这是一个 Transformer 网络,可以根据流行音乐的波形生成钢琴翻唱。据我们所知,这是第一个直接从流行音频生成钢琴翻唱,而无需使用旋律和和弦提取模块的模型。我们表明,使用我们的数据集训练的 Pop2Piano 能够生成合理的钢琴翻唱。

此模型由 Susnato Dhar 贡献。原始代码可以在这里找到。

使用技巧

  • 要使用 Pop2Piano,您需要安装 🤗 Transformers 库,以及以下第三方模块
pip install pretty-midi==0.2.9 essentia==2.1b6.dev1034 librosa scipy

请注意,安装后您可能需要重启运行时。

  • Pop2Piano 是一种基于 Encoder-Decoder 的模型,类似于 T5。
  • Pop2Piano 可用于为给定的音频序列生成 midi 音频文件。
  • Pop2PianoForConditionalGeneration.generate() 中选择不同的作曲家可能会产生各种不同的结果。
  • 加载音频文件时,将采样率设置为 44.1 kHz 可以获得良好的性能。
  • 尽管 Pop2Piano 主要在韩国流行音乐上进行训练,但在其他西方流行音乐或嘻哈歌曲上也表现良好。

示例

  • 使用 HuggingFace Dataset 的示例
>>> from datasets import load_dataset
>>> from transformers import Pop2PianoForConditionalGeneration, Pop2PianoProcessor

>>> model = Pop2PianoForConditionalGeneration.from_pretrained("sweetcocoa/pop2piano")
>>> processor = Pop2PianoProcessor.from_pretrained("sweetcocoa/pop2piano")
>>> ds = load_dataset("sweetcocoa/pop2piano_ci", split="test")

>>> inputs = processor(
...     audio=ds["audio"][0]["array"], sampling_rate=ds["audio"][0]["sampling_rate"], return_tensors="pt"
... )
>>> model_output = model.generate(input_features=inputs["input_features"], composer="composer1")
>>> tokenizer_output = processor.batch_decode(
...     token_ids=model_output, feature_extractor_output=inputs
... )["pretty_midi_objects"][0]
>>> tokenizer_output.write("./Outputs/midi_output.mid")
  • 使用您自己的音频文件的示例
>>> import librosa
>>> from transformers import Pop2PianoForConditionalGeneration, Pop2PianoProcessor

>>> audio, sr = librosa.load("<your_audio_file_here>", sr=44100)  # feel free to change the sr to a suitable value.
>>> model = Pop2PianoForConditionalGeneration.from_pretrained("sweetcocoa/pop2piano")
>>> processor = Pop2PianoProcessor.from_pretrained("sweetcocoa/pop2piano")

>>> inputs = processor(audio=audio, sampling_rate=sr, return_tensors="pt")
>>> model_output = model.generate(input_features=inputs["input_features"], composer="composer1")
>>> tokenizer_output = processor.batch_decode(
...     token_ids=model_output, feature_extractor_output=inputs
... )["pretty_midi_objects"][0]
>>> tokenizer_output.write("./Outputs/midi_output.mid")
  • 批量处理多个音频文件的示例
>>> import librosa
>>> from transformers import Pop2PianoForConditionalGeneration, Pop2PianoProcessor

>>> # feel free to change the sr to a suitable value.
>>> audio1, sr1 = librosa.load("<your_first_audio_file_here>", sr=44100)  
>>> audio2, sr2 = librosa.load("<your_second_audio_file_here>", sr=44100)
>>> model = Pop2PianoForConditionalGeneration.from_pretrained("sweetcocoa/pop2piano")
>>> processor = Pop2PianoProcessor.from_pretrained("sweetcocoa/pop2piano")

>>> inputs = processor(audio=[audio1, audio2], sampling_rate=[sr1, sr2], return_attention_mask=True, return_tensors="pt")
>>> # Since we now generating in batch(2 audios) we must pass the attention_mask
>>> model_output = model.generate(
...     input_features=inputs["input_features"],
...     attention_mask=inputs["attention_mask"],
...     composer="composer1",
... )
>>> tokenizer_output = processor.batch_decode(
...     token_ids=model_output, feature_extractor_output=inputs
... )["pretty_midi_objects"]

>>> # Since we now have 2 generated MIDI files
>>> tokenizer_output[0].write("./Outputs/midi_output1.mid")
>>> tokenizer_output[1].write("./Outputs/midi_output2.mid")
  • 批量处理多个音频文件的示例(使用 Pop2PianoFeatureExtractorPop2PianoTokenizer
>>> import librosa
>>> from transformers import Pop2PianoForConditionalGeneration, Pop2PianoFeatureExtractor, Pop2PianoTokenizer

>>> # feel free to change the sr to a suitable value.
>>> audio1, sr1 = librosa.load("<your_first_audio_file_here>", sr=44100)  
>>> audio2, sr2 = librosa.load("<your_second_audio_file_here>", sr=44100)
>>> model = Pop2PianoForConditionalGeneration.from_pretrained("sweetcocoa/pop2piano")
>>> feature_extractor = Pop2PianoFeatureExtractor.from_pretrained("sweetcocoa/pop2piano")
>>> tokenizer = Pop2PianoTokenizer.from_pretrained("sweetcocoa/pop2piano")

>>> inputs = feature_extractor(
...     audio=[audio1, audio2], 
...     sampling_rate=[sr1, sr2], 
...     return_attention_mask=True, 
...     return_tensors="pt",
... )
>>> # Since we now generating in batch(2 audios) we must pass the attention_mask
>>> model_output = model.generate(
...     input_features=inputs["input_features"],
...     attention_mask=inputs["attention_mask"],
...     composer="composer1",
... )
>>> tokenizer_output = tokenizer.batch_decode(
...     token_ids=model_output, feature_extractor_output=inputs
... )["pretty_midi_objects"]

>>> # Since we now have 2 generated MIDI files
>>> tokenizer_output[0].write("./Outputs/midi_output1.mid")
>>> tokenizer_output[1].write("./Outputs/midi_output2.mid")

Pop2PianoConfig

class transformers.Pop2PianoConfig

< >

( vocab_size = 2400 composer_vocab_size = 21 d_model = 512 d_kv = 64 d_ff = 2048 num_layers = 6 num_decoder_layers = None num_heads = 8 relative_attention_num_buckets = 32 relative_attention_max_distance = 128 dropout_rate = 0.1 layer_norm_epsilon = 1e-06 initializer_factor = 1.0 feed_forward_proj = 'gated-gelu' is_encoder_decoder = True use_cache = True pad_token_id = 0 eos_token_id = 1 dense_act_fn = 'relu' **kwargs )

参数

  • vocab_size (int, 可选, 默认为 2400) — Pop2PianoForConditionalGeneration 模型的词汇表大小。定义了在调用 Pop2PianoForConditionalGeneration 时传递的 inputs_ids 可以表示的不同 token 的数量。
  • composer_vocab_size (int, 可选, 默认为 21) — 表示作曲家的数量。
  • d_model (int, 可选, 默认为 512) — 编码器层和池化层的大小。
  • d_kv (int, 可选, 默认为 64) — 每个注意力头的键、查询、值投影的大小。投影层的 inner_dim 将定义为 num_heads * d_kv
  • d_ff (int, 可选, 默认为 2048) — 每个 Pop2PianoBlock 中间前馈层的大小。
  • num_layers (int, 可选, 默认为 6) — Transformer 编码器中隐藏层的数量。
  • num_decoder_layers (int, 可选) — Transformer 解码器中隐藏层的数量。如果未设置,将使用与 num_layers 相同的值。
  • num_heads (int, 可选, 默认为 8) — Transformer 编码器中每个注意力层的注意力头的数量。
  • relative_attention_num_buckets (int, optional, defaults to 32) — 用于每个注意力层的桶的数量。
  • relative_attention_max_distance (int, optional, defaults to 128) — 用于桶分离的较长序列的最大距离。
  • dropout_rate (float, optional, defaults to 0.1) — 所有 dropout 层的比率。
  • layer_norm_epsilon (float, optional, defaults to 1e-6) — layer normalization 层使用的 epsilon 值。
  • initializer_factor (float, optional, defaults to 1.0) — 用于初始化所有权重矩阵的因子 (应保持为 1.0,在内部用于初始化测试)。
  • feed_forward_proj (string, optional, defaults to "gated-gelu") — 要使用的前馈层类型。应为 "relu""gated-gelu" 之一。
  • use_cache (bool, optional, defaults to True) — 模型是否应返回最后的键/值注意力(并非所有模型都使用)。
  • dense_act_fn (string, optional, defaults to "relu") — 在 Pop2PianoDenseActDensePop2PianoDenseGatedActDense 中要使用的激活函数类型。

这是用于存储 Pop2PianoForConditionalGeneration 配置的配置类。它用于根据指定的参数实例化 Pop2PianoForConditionalGeneration 模型,定义模型架构。使用默认值实例化配置将产生与 Pop2Piano sweetcocoa/pop2piano 架构类似的配置。

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

Pop2PianoFeatureExtractor

class transformers.Pop2PianoFeatureExtractor

< >

( *args **kwargs )

__call__

( *args **kwargs )

将自身作为函数调用。

Pop2PianoForConditionalGeneration

class transformers.Pop2PianoForConditionalGeneration

< >

( config: Pop2PianoConfig )

参数

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

带有置于顶部的 language modeling 头的 Pop2Piano 模型。此模型继承自 PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参阅 PyTorch 文档,了解与常规用法和行为相关的所有事项。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None decoder_head_mask: typing.Optional[torch.FloatTensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None input_features: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = 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 cache_position: typing.Optional[torch.LongTensor] = None ) transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。Pop2Piano 是一个具有相对位置嵌入的模型,因此您应该能够在右侧和左侧填充输入。索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是输入 ID? 要了解有关如何为预训练准备 input_ids 的更多信息,请查看 Pop2Piano 训练
  • attention_mask (torch.FloatTensor,形状为 (batch_size, sequence_length)可选) — 掩码,以避免对 padding token 索引执行注意力机制。掩码值在 [0, 1] 中选择:

  • decoder_input_ids (torch.LongTensor,形状为 (batch_size, target_sequence_length)可选) — 词汇表中 decoder 输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()什么是 decoder 输入 ID? Pop2Piano 使用 pad_token_id 作为 decoder_input_ids 生成的起始 token。如果使用 past_key_values,则可以选择仅输入最后一个 decoder_input_ids(请参阅 past_key_values)。要了解有关如何准备
  • decoder_attention_mask (torch.BoolTensor,形状为 (batch_size, target_sequence_length)可选) — 默认行为:生成一个 tensor,该 tensor 忽略 decoder_input_ids 中的 pad tokens。默认情况下,也将使用因果掩码。
  • head_mask (torch.FloatTensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 掩码,用于使 encoder 中 self-attention 模块的选定 head 失效。掩码值在 [0, 1] 中选择:

    • 1 表示 head 未被掩码
    • 0 表示 head 被掩码
  • decoder_head_mask (torch.FloatTensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 掩码,用于使 decoder 中 self-attention 模块的选定 head 失效。掩码值在 [0, 1] 中选择:

    • 1 表示 head 未被掩码
    • 0 表示 head 被掩码
  • cross_attn_head_mask (torch.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 掩码,用于使 decoder 中 cross-attention 模块的选定 head 失效。掩码值在 [0, 1] 中选择:

    • 1 表示 head 未被掩码
    • 0 表示 head 被掩码
  • encoder_outputs (tuple(tuple(torch.FloatTensor), 可选) — 元组由 (last_hidden_state, optional: hidden_states, optional: attentions) 组成。形状为 (batch_size, sequence_length, hidden_size)last_hidden_state 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力中。
  • past_key_values (长度为 config.n_layerstuple(tuple(torch.FloatTensor)),其中每个元组有 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含预先计算的注意力块的键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择仅输入形状为 (batch_size, 1) 的最后 decoder_input_ids(那些没有将其过去的键值状态提供给此模型的),而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想更好地控制如何将 input_ids 索引转换为关联的向量,而不是模型的内部嵌入查找矩阵,这将非常有用。
  • input_features (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 执行与 inputs_embeds 相同的任务。如果 inputs_embeds 不存在但 input_features 存在,则 input_features 将被视为 inputs_embeds
  • decoder_inputs_embeds (形状为 (batch_size, target_sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 decoder_input_ids。如果使用 past_key_values,则可以选择仅输入最后的 decoder_inputs_embeds(请参阅 past_key_values)。如果您想更好地控制如何将 decoder_input_ids 索引转换为关联的向量,而不是模型的内部嵌入查找矩阵,这将非常有用。如果 decoder_input_idsdecoder_inputs_embeds 均未设置,则 decoder_inputs_embedsinputs_embeds 的值。
  • use_cache (bool可选) — 如果设置为 True,则返回 past_key_values 键值状态,并可用于加速解码(请参阅 past_key_values)。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (形状为 (sequence_length)torch.LongTensor可选) — 索引描绘了输入序列 token 在序列中的位置。 它用于在正确的位置更新缓存并推断完整的序列长度。
  • labels (形状为 (batch_size,)torch.LongTensor可选) — 用于计算序列分类/回归损失的标签。索引应在 [-100, 0, ..., config.vocab_size - 1] 中。所有设置为 -100 的标签都会被忽略(掩码),损失仅针对 [0, ..., config.vocab_size] 中的标签计算。

返回值

transformers.modeling_outputs.Seq2SeqLMOutputtuple(torch.FloatTensor)

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

  • loss (形状为 (1,)torch.FloatTensor可选,当提供 labels 时返回) — 语言建模损失。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言建模头的预测分数(SoftMax 之前每个词汇表 token 的分数)。

  • past_key_values (tuple(tuple(torch.FloatTensor))可选,当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(tuple(torch.FloatTensor)) 元组,其中每个元组有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量) 和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

    包含预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),这些状态可用于(请参阅 past_key_values 输入)加速顺序解码。

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

    解码器在每一层输出的隐藏状态,加上初始嵌入输出。

  • decoder_attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

  • cross_attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均值。

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

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

    编码器在每一层输出的隐藏状态,加上初始嵌入输出。

  • encoder_attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    编码器的注意力权重,在注意力 softmax 之后,用于计算自注意力头中的加权平均值。

Pop2PianoForConditionalGeneration 的 forward 方法覆盖了 __call__ 特殊方法。

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

generate

< >

( input_features attention_mask = None composer = 'composer1' generation_config = None **kwargs ) ModelOutputtorch.LongTensor

参数

  • input_features (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 这是由 Pop2PianoFeatureExtractor 生成的音频的特征化版本。
  • attention_mask — 对于批量生成,input_features 会被填充以使所有示例具有相同的形状。 attention_mask 帮助确定哪些区域被填充,哪些区域未被填充。
    • 1 表示未填充的 token,
    • 0 表示已填充的 token。
  • composer (str可选,默认为 "composer1") — 此值传递给 Pop2PianoConcatEmbeddingToMel,以便为每个 "composer" 生成不同的嵌入。请确保 composet 值存在于 generation_config 中的 composer_to_feature_token 中。有关示例,请参阅 https://huggingface.co/sweetcocoa/pop2piano/blob/main/generation_config.json
  • generation_config (~generation.GenerationConfig可选) — 要用作生成调用的基本参数化的生成配置。传递给 generate 的 **kwargs (与 generation_config 的属性匹配)将覆盖它们。 如果未提供 generation_config,将使用默认值,该默认值具有以下加载优先级:1)来自 generation_config.json 模型文件(如果存在);2)来自模型配置。 请注意,未指定的参数将继承 GenerationConfig 的默认值,应检查其文档以参数化生成。
  • kwargsgenerate_config 的 Ad hoc 参数化和/或将转发到模型的 forward 函数的其他特定于模型的 kwargs。如果模型是编码器-解码器模型,则编码器特定的 kwargs 不应添加前缀,而解码器特定的 kwargs 应以 decoder_ 为前缀。

返回值

ModelOutputtorch.LongTensor

一个 ModelOutput (如果 return_dict_in_generate=True 或当 config.return_dict_in_generate=True 时)或一个 torch.FloatTensor。由于 Pop2Piano 是一个编码器-解码器模型 (model.config.is_encoder_decoder=True),可能的 ModelOutput 类型有

为 midi 输出生成 token id。

大多数生成控制参数都在 generation_config 中设置,如果未传递,则将设置为模型的默认生成配置。您可以通过将相应的参数传递给 generate() 来覆盖任何 generation_config,例如 .generate(inputs, num_beams=4, do_sample=True)。有关生成策略和代码示例的概述,请查看以下指南

Pop2PianoTokenizer

class transformers.Pop2PianoTokenizer

< >

( *args **kwargs )

__call__

( *args **kwargs )

将自身作为函数调用。

Pop2PianoProcessor

transformers.Pop2PianoProcessor

< >

( *args **kwargs )

__call__

( *args **kwargs )

将自身作为函数调用。

< > 更新 在 GitHub 上