Pop2Piano
概述
Pop2Piano 模型由 Jongho Choi 和 Kyogu Lee 在 Pop2Piano：基于流行音频的钢琴伴奏生成 中提出。
流行音乐的钢琴伴奏深受人们喜爱，但从音乐中生成它们并非易事。它需要精湛的钢琴演奏技巧，以及对歌曲的不同特征和旋律的了解。使用 Pop2Piano，您可以直接从歌曲的音频波形生成伴奏。它是第一个直接从流行音频生成钢琴伴奏的模型，无需旋律和和弦提取模块。
Pop2Piano 是一个基于 T5 的编码器-解码器 Transformer 模型。输入音频被转换为其波形，并传递到编码器，编码器将其转换为潜在表示。解码器使用这些潜在表示以自回归的方式生成 token id。每个 token id 对应于四种不同类型的 token 之一：时间、速度、音符和“特殊”。然后，token id 被解码为等效的 MIDI 文件。
论文中的摘要如下：
许多人喜欢流行音乐的钢琴伴奏。然而，自动生成流行音乐的钢琴伴奏的任务仍未得到充分研究。这部分是由于缺乏同步的 {流行音乐，钢琴伴奏} 数据对，这使得难以应用最新的基于数据密集型深度学习的方法。为了利用数据驱动方法的强大功能，我们使用自动管道生成大量成对的同步 {流行音乐，钢琴伴奏} 数据。在本文中，我们介绍了 Pop2Piano，这是一种 Transformer 网络，它在给定流行音乐波形的情况下生成钢琴伴奏。据我们所知，这是第一个直接从流行音频生成钢琴伴奏的模型，无需使用旋律和和弦提取模块。我们证明 Pop2Piano 在使用我们的数据集训练后，能够生成合理的钢琴伴奏。
该模型由 Susnato Dhar 贡献。原始代码可以在 此处 找到。
使用技巧
- 要使用 Pop2Piano，您需要安装 🤗 Transformers 库，以及以下第三方模块
pip install pretty-midi==0.2.9 essentia==2.1b6.dev1034 librosa scipy
请注意，您可能需要在安装后重新启动运行时。
- Pop2Piano 是一个基于编码器-解码器的模型，类似于 T5。
- Pop2Piano 可用于为给定的音频序列生成 MIDI 音频文件。
- 在
Pop2PianoForConditionalGeneration.generate()中选择不同的作曲家会导致各种不同的结果。 - 在加载音频文件时将采样率设置为 44.1 kHz 可以提供良好的性能。
- 尽管 Pop2Piano 主要是在韩国流行音乐上训练的，但它在其他西方流行音乐或嘻哈歌曲上也表现得相当不错。
示例
- 使用 HuggingFace 数据集的示例
>>> 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
< 来源 >( 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表示的不同标记的数量。 - 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"之一。
这是用于存储 Pop2PianoForConditionalGeneration 配置的配置类。它用于根据指定的参数实例化 Pop2PianoForConditionalGeneration 模型，定义模型架构。使用默认值实例化配置将生成与 Pop2Piano sweetcocoa/pop2piano 架构相似的配置。
配置对象继承自 PretrainedConfig 并可用于控制模型输出。阅读来自 PretrainedConfig 的文档以获取更多信息。
Pop2PianoFeatureExtractor
Pop2PianoForConditionalGeneration
类 transformers.Pop2PianoForConditionalGeneration
< 源代码 >( config: Pop2PianoConfig )
参数
- config (Pop2PianoConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 语言建模 头的 Pop2Piano 模型。该模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头等）。
该模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关通用使用和行为的所有事宜。
forward
< 源代码 >( 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)) — 词汇表中输入序列标记的索引。Pop2Piano 是一个具有相对位置嵌入的模型，因此您可以左右两侧填充输入。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是输入 ID？ 要了解更多关于如何为预训练准备input_ids的信息，请查看 Pop2Piano 训练。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 避免对填充标记索引执行注意力的掩码。在[0, 1]中选择掩码值：- 1 用于未掩码的标记，
- 0 用于掩码的标记。 什么是注意力掩码？
- decoder_input_ids (
torch.LongTensor形状为(batch_size, target_sequence_length), 可选) — 词汇表中解码器输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 什么是解码器输入 ID？ Pop2Piano 使用pad_token_id作为decoder_input_ids生成的起始标记。如果使用past_key_values，可以选择仅输入最后一个decoder_input_ids（参见past_key_values）。要了解更多关于如何准备 - decoder_attention_mask (
torch.BoolTensor形状为(batch_size, target_sequence_length), 可选) — 默认行为：生成一个忽略decoder_input_ids中填充标记的张量。因果掩码也将默认使用。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使编码器中自注意力模块的选定头部失效的掩码。在[0, 1]中选择掩码值：- 1 表示头部未掩码，
- 0 表示头部掩码。
- decoder_head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使解码器中自注意力模块的选定头部失效的掩码。在[0, 1]中选择掩码值：- 1 表示头部未掩码，
- 0 表示头部掩码。
- cross_attn_head_mask (
torch.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使解码器中交叉注意力模块的选定头部失效的掩码。在[0, 1]中选择掩码值：- 1 表示头部未掩码，
- 0 表示头部掩码。
- encoder_outputs (
tuple(tuple(torch.FloatTensor), 可选) — 元组包含 (last_hidden_state,可选: hidden_states,可选: attentions)last_hidden_state形状为(batch_size, sequence_length, hidden_size)是编码器最后一层输出处的隐藏状态序列。在解码器的交叉注意力中使用。 - 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。 - 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，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的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)) — 语言建模头的预测分数（SoftMax 之前每个词汇表标记的分数）。 -
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)的张量，以及 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 (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 模型编码器最后一层的隐藏状态序列。 -
encoder_hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组 (如果模型具有嵌入层，则一个用于嵌入的输出，以及一个用于每层的输出)。编码器在每一层输出处的隐藏状态，加上初始嵌入输出。
-
encoder_attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组 (每一层一个)。编码器的注意力权重，在注意力 Softmax 之后，用于计算自注意力头部的加权平均值。
Pop2PianoForConditionalGeneration 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在这个函数中定义，但应该在之后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
generate
< source >( input_features attention_mask = None composer = 'composer1' generation_config = None **kwargs ) → ModelOutput 或 torch.LongTensor
参数
- input_features (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 这是由Pop2PianoFeatureExtractor生成的音频的特征化版本。attention_mask — 对于批次生成，input_features被填充以在所有示例中具有相同的形状。attention_mask有助于确定哪些区域被填充，哪些没有填充。- 1 代表未填充的标记，
- 0 代表填充的标记。
- composer (
str, 可选, 默认为"composer1") — 此值传递给Pop2PianoConcatEmbeddingToMel，为每个"composer"生成不同的嵌入。请确保在generation_config中的composer_to_feature_token中存在作曲家值。有关示例，请参见 https://huggingface.co/sweetcocoa/pop2piano/blob/main/generation_config.json 。 - generation_config (
~generation.GenerationConfig, 可选) — 用作生成调用基本参数化的生成配置。传递给生成匹配generation_config属性的**kwargs将覆盖它们。如果未提供generation_config，将使用默认值，其加载优先级如下：1) 如果存在，则来自generation_config.json模型文件；2) 来自模型配置。请注意，未指定的参数将继承 GenerationConfig 的默认值，应检查其文档以参数化生成。kwargs —generate_config的临时参数化和/或将转发到模型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 输出的标记 ID。
大多数生成控制参数在 generation_config 中设置，如果没有传递，它将设置为模型的默认生成配置。可以通过将相应的参数传递给 generate() 来覆盖任何 generation_config，例如 .generate(inputs, num_beams=4, do_sample=True)。有关生成策略和代码示例的概述，请查看 以下指南。