Pop2Piano
概述
Pop2Piano 模型由 Jongho Choi 和 Kyogu Lee 在 Pop2Piano : Pop Audio-based Piano Cover Generation 中提出。
流行音乐的钢琴翻唱广受欢迎，但从音乐中生成钢琴翻唱并非易事。它需要精湛的钢琴演奏技巧，以及对歌曲不同特点和旋律的了解。借助 Pop2Piano，你可以直接从歌曲的音频波形生成翻唱。它是第一个无需旋律和和弦提取模块，直接从流行音频生成钢琴翻唱的模型。
Pop2Piano 是一个基于 T5 的编码器-解码器 Transformer 模型。输入音频被转换为波形并传递给编码器，编码器将其转换为潜在表示。解码器使用这些潜在表示以自回归方式生成 token ids。每个 token id 对应于四种不同 token 类型之一：时间、速度、音符和“特殊”。然后将 token ids 解码为等效的 MIDI 文件。
该论文的摘要如下
流行音乐的钢琴翻唱深受人们喜爱。然而，自动生成流行音乐钢琴翻唱的任务仍未得到充分研究。部分原因是缺乏同步的 {流行音乐, 钢琴翻唱} 数据对，这使得应用最新的数据密集型深度学习方法具有挑战性。为了利用数据驱动方法的强大功能，我们使用自动化 pipeline 创建了大量的配对和同步的 {流行音乐, 钢琴翻唱} 数据。在本文中，我们介绍了 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")- 批量处理多个音频文件的示例 (使用
Pop2PianoFeatureExtractor和Pop2PianoTokenizer)
>>> 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
< source >( 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, 可选, 默认为 32) — 每个注意力层使用的桶的数量。 - relative_attention_max_distance (
int, 可选, 默认为 128) — 用于桶分离的较长序列的最大距离。 - dropout_rate (
float, 可选, 默认为 0.1) — 所有 dropout 层的比率。 - layer_norm_epsilon (
float, 可选, 默认为 1e-6) — 层归一化层使用的 epsilon 值。 - initializer_factor (
float, 可选, 默认为 1.0) — 用于初始化所有权重矩阵的因子（应保持为 1.0，内部用于初始化测试）。 - feed_forward_proj (
string, 可选, 默认为"gated-gelu") — 要使用的前馈层类型。 应为"relu"或"gated-gelu"之一。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回上次的键/值注意力（并非所有模型都使用）。 - dense_act_fn (
string, 可选, 默认为"relu") — 要在Pop2PianoDenseActDense和Pop2PianoDenseGatedActDense中使用的激活函数类型。
这是用于存储 Pop2PianoForConditionalGeneration 配置的配置类。 它用于根据指定的参数实例化 Pop2PianoForConditionalGeneration 模型，定义模型架构。 使用默认值实例化配置将产生与 Pop2Piano sweetcocoa/pop2piano 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。 有关更多信息，请阅读 PretrainedConfig 的文档。
Pop2PianoFeatureExtractor
Pop2PianoForConditionalGeneration
class transformers.Pop2PianoForConditionalGeneration
< source >( config: Pop2PianoConfig )
参数
- config (Pop2PianoConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，而只会加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有 language modeling 头部的 Pop2Piano 模型。 此模型继承自 PreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None decoder_input_ids: Optional = None decoder_attention_mask: Optional = None head_mask: Optional = None decoder_head_mask: Optional = None cross_attn_head_mask: Optional = None encoder_outputs: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None input_features: Optional = None decoder_inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。Pop2Piano 是一个使用相对位置嵌入的模型，因此你应该能够在左侧和右侧填充输入。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是输入 IDs？ 要了解更多关于如何为预训练准备input_ids的信息，请查看 Pop2Piano 训练。 - attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免在 padding token 索引上执行 attention。 Mask values selected in[0, 1]:- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。什么是 attention mask？
- decoder_input_ids (
torch.LongTensor，形状为(batch_size, target_sequence_length)，可选) — 解码器输入序列 tokens 在词汇表中的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是解码器输入 IDs？ 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)，可选) — 默认行为：生成一个忽略decoder_input_ids中的 padding token 的 tensor。默认情况下，也会使用因果掩码。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空编码器中 self-attention 模块的选定 head 的掩码。Mask values selected in[0, 1]:- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- decoder_head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空解码器中 self-attention 模块的选定 head 的掩码。Mask values selected in[0, 1]:- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- cross_attn_head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空解码器中 cross-attention 模块的选定 head 的掩码。Mask values selected in[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是编码器最后一层的输出处的隐藏状态序列。用于解码器的 cross-attention 中。 - past_key_values (
tuple(tuple(torch.FloatTensor))，长度为config.n_layers，其中每个元组有 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的 tensors) — 包含 attention blocks 的预先计算的 key 和 value 隐藏状态。可用于加速解码。如果使用past_key_values，用户可以选择仅输入最后的decoder_input_ids（那些没有将其 past key value 状态提供给此模型的），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）除了传递input_ids之外，你可以选择直接传递嵌入表示。如果你想比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - input_features (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 执行与inputs_embeds相同的任务。如果inputs_embeds不存在但input_features存在，则input_features将被视为inputs_embeds。 - decoder_inputs_embeds (
torch.FloatTensor，形状为(batch_size, target_sequence_length, hidden_size)，可选) — （可选）除了传递decoder_input_ids之外，你可以选择直接传递嵌入表示。如果使用past_key_values，则可以选择仅输入最后的decoder_inputs_embeds（请参阅past_key_values）。如果你想比模型的内部嵌入查找矩阵更精细地控制如何将decoder_input_ids索引转换为关联的向量，这将非常有用。如果decoder_input_ids和decoder_inputs_embeds均未设置，则decoder_inputs_embeds取inputs_embeds的值。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[-100, 0, ..., config.vocab_size - 1]中。所有设置为-100的标签都将被忽略（掩码），损失仅针对[0, ..., config.vocab_size]中的标签计算
返回值
transformers.modeling_outputs.Seq2SeqLMOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.Seq2SeqLMOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含取决于配置 (Pop2PianoConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor，形状为(1,)，可选，当提供labels时返回) — 语言建模损失。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，其中每个元组都有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 tensors）和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加 tensors。包含预先计算的 hidden-states（self-attention blocks 和 cross-attention blocks 中的 key 和 values），可用于加速顺序解码（请参阅
past_key_values输入）。 -
decoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有 embedding 层，则一个用于 embeddings 的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。解码器在每一层输出的 hidden-states 加上初始 embedding 输出。
-
decoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的 attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器的 cross-attention 层的 attention 权重，在 attention softmax 之后，用于计算 cross-attention heads 中的加权平均值。
-
encoder_last_hidden_state (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层输出处的 hidden-states 序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（如果模型有 embedding 层，则一个用于 embeddings 的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。编码器在每一层输出的 hidden-states 加上初始 embedding 输出。
-
encoder_attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。编码器的 attention 权重，在 attention softmax 之后，用于计算 self-attention heads 中的加权平均值。
Pop2PianoForConditionalGeneration forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
generate
< source >( input_features attention_mask = None composer = 'composer1' generation_config = None **kwargs ) → ModelOutput 或 torch.LongTensor
参数
- input_features (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 这是由Pop2PianoFeatureExtractor生成的音频的特征化版本。 attention_mask — 对于批量生成，input_features会被 padding 以使所有示例具有相同的形状。attention_mask帮助确定哪些区域被 padding，哪些区域没有被 padding。- 1 表示 token 未被 padding，
- 0 表示 token 已被 padding。
- composer (
str, optional, defaults to"composer1") — 此值会传递给Pop2PianoConcatEmbeddingToMel，以便为每个"composer"生成不同的嵌入 (embeddings)。请确保 composer 值存在于generation_config中的composer_to_feature_token中。有关示例，请参阅 https://huggingface.co/sweetcocoa/pop2piano/blob/main/generation_config.json 。 - generation_config (
~generation.GenerationConfig, optional) — 用作生成调用的基本参数化的生成配置。传递给 generate 的**kwargs会覆盖generation_config的属性。 如果未提供generation_config，则将使用默认配置，默认配置具有以下加载优先级：1) 来自generation_config.json模型文件（如果存在）；2) 来自模型配置。 请注意，未指定的参数将继承 GenerationConfig 的默认值，应查看其文档以参数化生成。 kwargs —generate_config的 Ad hoc 参数化和/或将转发到模型的forward函数的其他模型特定 kwargs。 如果模型是编码器-解码器模型，则编码器特定的 kwargs 不应带有前缀，解码器特定的 kwargs 应带有 decoder_ 前缀。
返回值
ModelOutput 或 torch.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 IDs。
大多数生成控制参数都在 generation_config 中设置，如果未传递，则将设置为模型的默认生成配置。 您可以通过将相应的参数传递给 generate() 来覆盖任何 generation_config，例如 .generate(inputs, num_beams=4, do_sample=True)。 有关生成策略和代码示例的概述，请查看以下指南。