Transformers 文档
Pop2Piano
并获得增强的文档体验
开始使用
Pop2Piano
概述
Pop2Piano 模型由 Jongho Choi 和 Kyogu Lee 在Pop2Piano: 基于流行音乐音频的钢琴翻弹生成中提出。
流行音乐的钢琴翻弹广受欢迎，但从音乐生成它们并非易事。它需要丰富的钢琴演奏专业知识以及对歌曲不同特征和旋律的了解。使用 Pop2Piano，您可以直接从歌曲的音频波形生成翻弹。它是第一个无需旋律和和弦提取模块即可直接从流行音乐音频生成钢琴翻弹的模型。
Pop2Piano 是一个基于T5的编码器-解码器Transformer模型。输入音频被转换为其波形并传递给编码器，编码器将其转换为潜在表示。解码器使用这些潜在表示以自回归方式生成令牌ID。每个令牌ID对应四种不同令牌类型之一：时间、速度、音符和“特殊”。然后将令牌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
< 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可以表示的不同令牌的数量。 - 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() 方法来加载模型权重。
Pop2Piano 模型，顶部带有一个 语言建模 头。
该模型继承自 PreTrainedModel。请查看超类文档，了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是 PyTorch torch.nn.Module 的子类。请将其作为常规 PyTorch 模块使用，并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。
forward
< source >( 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[tuple[tuple[torch.Tensor]]] = None past_key_values: typing.Optional[tuple[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 或 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.Tensor]], 可选) — 元组包含 (last_hidden_state, 可选:hidden_states, 可选:attentions)last_hidden_state形状为(batch_size, sequence_length, hidden_size)，可选) 是编码器最后一层输出的隐藏状态序列。用于解码器的交叉注意力。 - past_key_values (
tuple[tuple[torch.Tensor]], 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加快顺序解码。这通常包括模型在解码上一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 一个包含
config.n_layers个tuple(torch.FloatTensor)的元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。这也被称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，用户可以选择只输入最后一个input_ids（那些没有将过去的键值状态提供给此模型的）的形状(batch_size, 1)，而不是所有input_ids的形状(batch_size, sequence_length)。 - 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的值。 - labels (
torch.LongTensor形状为(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[-100, 0, ..., config.vocab_size - 1]范围内。所有设置为-100的标签都将被忽略（被掩码），损失仅针对[0, ..., config.vocab_size]中的标签计算。 - 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 (
torch.LongTensor，形状为(sequence_length)，可选) — 表示输入序列标记在序列中的位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
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 (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
EncoderDecoderCache，可选，当传入use_cache=True或当config.use_cache=True时返回) — 它是一个 EncoderDecoderCache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于（参见
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时返回) —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__ 特殊方法。
虽然前向传播的实现需要在该函数中定义，但在此之后应该调用 Module 实例，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoProcessor, Pop2PianoForConditionalGeneration
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("sweetcocoa/pop2piano")
>>> model = Pop2PianoForConditionalGeneration.from_pretrained("sweetcocoa/pop2piano")
>>> # 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]
...
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
...生成
< 源代码 >( 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被填充以使所有示例具有相同的形状。attention_mask有助于确定哪些区域被填充，哪些没有被填充。- 1 表示未填充的标记，
- 0 表示填充的标记。
- composer (
str，可选，默认为"composer1") — 此值被传递给Pop2PianoConcatEmbeddingToMel以针对每个"composer"生成不同的嵌入。请确保composer值存在于generation_config中的composer_to_feature_token中。例如，请参见 https://huggingface.co/sweetcocoa/pop2piano/blob/main/generation_config.json。 - generation_config (
~generation.GenerationConfig，可选) — 用作生成调用基础参数化的生成配置。传递给 generate() 且与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 输出生成 token id。
大多数生成控制参数都在 generation_config 中设置，如果未传入，则会设置为模型的默认生成配置。您可以通过向 generate() 传入相应的参数来覆盖任何 generation_config，例如 .generate(inputs, num_beams=4, do_sample=True)。有关生成策略和代码示例的概述，请查阅以下指南。