Transformers 文档
MusicGen Melody
并获得增强的文档体验
开始使用
MusicGen Melody
概述
MusicGen Melody 模型由 Jade Copet、Felix Kreuk、Itai Gat、Tal Remez、David Kant、Gabriel Synnaeve、Yossi Adi 和 Alexandre Défossez 在 Simple and Controllable Music Generation 中提出。
MusicGen Melody 是一个单阶段自回归 Transformer 模型，能够根据文本描述或音频提示生成高质量的音乐样本。文本描述通过一个冻结的文本编码器模型传递，以获得隐藏状态表示序列。然后训练 MusicGen 预测离散音频 tokens 或音频代码，并以这些隐藏状态为条件。然后使用音频压缩模型（例如 EnCodec）解码这些音频 tokens，以恢复音频波形。
通过高效的 token 交错模式，MusicGen 不需要文本/音频提示的自监督语义表示，从而消除了级联多个模型来预测一组代码本（例如，分层或上采样）的需求。相反，它能够在单个前向传递中生成所有代码本。
论文摘要如下：
我们着手解决条件音乐生成任务。我们介绍了 MusicGen，这是一个在压缩离散音乐表示（即 tokens）的多个流上运行的单个语言模型 (LM)。与先前的工作不同，MusicGen 由单阶段 transformer LM 以及高效的 token 交错模式组成，这消除了级联多个模型（例如，分层或上采样）的需求。遵循这种方法，我们演示了 MusicGen 如何生成高质量的样本，同时以文本描述或旋律特征为条件，从而可以更好地控制生成的输出。我们进行了广泛的实证评估，同时考虑了自动和人工研究，表明所提出的方法在标准文本到音乐基准测试中优于评估的基线。通过消融研究，我们阐明了构成 MusicGen 的每个组件的重要性。
此模型由 ylacombe 贡献。 原始代码可以在此处找到。 预训练的检查点可以在 Hugging Face Hub 上找到。
与 MusicGen 的区别
与 MusicGen 有两个主要区别：
- 在此处，音频提示用作生成音频样本的条件信号，而在 MusicGen 中，它用于音频延续。
- 条件文本和音频信号被连接到解码器的隐藏状态，而不是像 MusicGen 中那样用作交叉注意力信号。
生成
MusicGen Melody 兼容两种生成模式：贪婪模式和采样模式。在实践中，采样模式比贪婪模式产生的结果明显更好，因此我们鼓励尽可能使用采样模式。默认情况下启用采样，可以通过在调用 MusicgenMelodyForConditionalGeneration.generate() 时设置 do_sample=True，或通过覆盖模型的生成配置（见下文）来显式指定采样。
Transformers 支持 MusicGen Melody 的单声道（1 声道）和立体声（2 声道）变体。单声道版本生成一组代码本。立体声版本生成 2 组代码本，每个声道（左/右）一组，并且每组代码本都通过音频压缩模型独立解码。每个声道的音频流被组合以给出最终的立体声输出。
音频条件生成
该模型可以通过使用 MusicgenMelodyProcessor 预处理输入，根据文本和音频提示生成音频样本。
在以下示例中，我们使用 🤗 Datasets 库加载音频文件，该库可以通过以下命令进行 pip 安装
pip install --upgrade pip
pip install datasets[audio]我们即将使用的音频文件按如下方式加载
>>> from datasets import load_dataset
>>> dataset = load_dataset("sanchit-gandhi/gtzan", split="train", streaming=True)
>>> sample = next(iter(dataset))["audio"]音频提示理想情况下应不包含通常由鼓和贝斯等乐器产生的低频信号。Demucs 模型可用于将人声和其他信号与鼓和贝斯组件分离。
如果您希望使用 Demucs，您首先需要按照 此处 的安装步骤进行操作，然后再使用以下代码片段
from demucs import pretrained
from demucs.apply import apply_model
from demucs.audio import convert_audio
import torch
wav = torch.tensor(sample["array"]).to(torch.float32)
demucs = pretrained.get_model('htdemucs')
wav = convert_audio(wav[None], sample["sampling_rate"], demucs.samplerate, demucs.audio_channels)
wav = apply_model(demucs, wav[None])然后，您可以使用以下代码片段生成音乐
>>> from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration
>>> processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> inputs = processor(
... audio=wav,
... sampling_rate=demucs.samplerate,
... text=["80s blues track with groovy saxophone"],
... padding=True,
... return_tensors="pt",
... )
>>> audio_values = model.generate(**inputs, do_sample=True, guidance_scale=3, max_new_tokens=256)您也可以直接传递音频信号，而无需使用 Demucs，尽管生成的质量可能会降低
>>> from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration
>>> processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> inputs = processor(
... audio=sample["array"],
... sampling_rate=sample["sampling_rate"],
... text=["80s blues track with groovy saxophone"],
... padding=True,
... return_tensors="pt",
... )
>>> audio_values = model.generate(**inputs, do_sample=True, guidance_scale=3, max_new_tokens=256)音频输出是一个三维 Torch 张量，形状为 (batch_size, num_channels, sequence_length)。要收听生成的音频样本，您可以选择在 ipynb 笔记本中播放它们
from IPython.display import Audio
sampling_rate = model.config.audio_encoder.sampling_rate
Audio(audio_values[0].numpy(), rate=sampling_rate)或使用第三方库（例如 soundfile）将其保存为 .wav 文件
>>> import soundfile as sf
>>> sampling_rate = model.config.audio_encoder.sampling_rate
>>> sf.write("musicgen_out.wav", audio_values[0].T.numpy(), sampling_rate)仅文本条件生成
相同的 MusicgenMelodyProcessor 可用于预处理仅文本提示。
>>> from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration
>>> processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> inputs = processor(
... text=["80s pop track with bassy drums and synth", "90s rock song with loud guitars and heavy drums"],
... padding=True,
... return_tensors="pt",
... )
>>> audio_values = model.generate(**inputs, do_sample=True, guidance_scale=3, max_new_tokens=256)guidance_scale 用于无分类器引导 (CFG)，设置条件 logits（从文本提示预测）和无条件 logits（从无条件或“null”提示预测）之间的权重。较高的 guidance scale 鼓励模型生成与输入提示更紧密相关的样本，但通常以音频质量较差为代价。通过设置 guidance_scale > 1 启用 CFG。为了获得最佳结果，请使用 guidance_scale=3（默认值）。
您也可以批量生成
>>> from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration
>>> from datasets import load_dataset
>>> processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> # take the first quarter of the audio sample
>>> sample_1 = sample["array"][: len(sample["array"]) // 4]
>>> # take the first half of the audio sample
>>> sample_2 = sample["array"][: len(sample["array"]) // 2]
>>> inputs = processor(
... audio=[sample_1, sample_2],
... sampling_rate=sample["sampling_rate"],
... text=["80s blues track with groovy saxophone", "90s rock song with loud guitars and heavy drums"],
... padding=True,
... return_tensors="pt",
... )
>>> audio_values = model.generate(**inputs, do_sample=True, guidance_scale=3, max_new_tokens=256)无条件生成
无条件（或“null”）生成的输入可以通过方法 MusicgenMelodyProcessor.get_unconditional_inputs() 获得
>>> from transformers import MusicgenMelodyForConditionalGeneration, MusicgenMelodyProcessor
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> unconditional_inputs = MusicgenMelodyProcessor.from_pretrained("facebook/musicgen-melody").get_unconditional_inputs(num_samples=1)
>>> audio_values = model.generate(**unconditional_inputs, do_sample=True, max_new_tokens=256)生成配置
控制生成过程的默认参数（例如采样、引导缩放比例和生成的 tokens 数量）可以在模型的生成配置中找到，并可以根据需要进行更新
>>> from transformers import MusicgenMelodyForConditionalGeneration
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> # inspect the default generation config
>>> model.generation_config
>>> # increase the guidance scale to 4.0
>>> model.generation_config.guidance_scale = 4.0
>>> # decrease the max length to 256 tokens
>>> model.generation_config.max_length = 256请注意，传递给 generate 方法的任何参数都将取代生成配置中的参数，因此在调用 generate 时设置 do_sample=False 将取代生成配置中 model.generation_config.do_sample 的设置。
模型结构
MusicGen 模型可以分解为三个不同的阶段：
- 文本编码器：将文本输入映射到隐藏状态表示序列。预训练的 MusicGen 模型使用来自 T5 或 Flan-T5 的冻结文本编码器。
- MusicGen Melody 解码器：一种语言模型 (LM)，它以自回归方式生成音频 tokens（或代码），并以编码器隐藏状态表示为条件
- 音频解码器：用于从解码器预测的音频 tokens 中恢复音频波形。
因此，MusicGen 模型既可以用作独立的解码器模型（对应于类 MusicgenMelodyForCausalLM），也可以用作包含文本编码器和音频编码器的复合模型（对应于类 MusicgenMelodyForConditionalGeneration）。如果只需要从预训练检查点加载解码器，则可以首先指定正确的配置来加载它，或者通过复合模型的 .decoder 属性访问它
>>> from transformers import AutoConfig, MusicgenMelodyForCausalLM, MusicgenMelodyForConditionalGeneration
>>> # Option 1: get decoder config and pass to `.from_pretrained`
>>> decoder_config = AutoConfig.from_pretrained("facebook/musicgen-melody").decoder
>>> decoder = MusicgenMelodyForCausalLM.from_pretrained("facebook/musicgen-melody", **decoder_config.to_dict())
>>> # Option 2: load the entire composite model, but only return the decoder
>>> decoder = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody").decoder由于文本编码器和音频编码器模型在训练期间被冻结，因此 MusicGen 解码器 MusicgenMelodyForCausalLM 可以独立地在编码器隐藏状态和音频代码的数据集上进行训练。对于推理，训练后的解码器可以与冻结的文本编码器和音频编码器组合，以恢复复合 MusicgenMelodyForConditionalGeneration 模型。
检查点转换
- 从 此处 下载原始检查点后，您可以使用
src/transformers/models/musicgen_melody/convert_musicgen_melody_transformers.py中提供的转换脚本通过以下命令转换它们
python src/transformers/models/musicgen_melody/convert_musicgen_melody_transformers.py \
--checkpoint="facebook/musicgen-melody" --pytorch_dump_folder /output/path 提示
- MusicGen 在 Encodec 的 32kHz 检查点上进行训练。您应确保使用兼容版本的 Encodec 模型。
- 采样模式往往比贪婪模式产生更好的结果 - 您可以使用变量
do_sample在调用MusicgenMelodyForConditionalGeneration.generate()时切换采样。
MusicgenMelodyDecoderConfig
class transformers.MusicgenMelodyDecoderConfig
< source >( vocab_size = 2048 max_position_embeddings = 2048 num_hidden_layers = 24 ffn_dim = 4096 num_attention_heads = 16 layerdrop = 0.0 use_cache = True activation_function = 'gelu' hidden_size = 1024 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 initializer_factor = 0.02 scale_embedding = False num_codebooks = 4 audio_channels = 1 pad_token_id = 2048 bos_token_id = 2048 eos_token_id = None tie_word_embeddings = False **kwargs )
参数
- vocab_size (
int, optional, defaults to 2048) — MusicgenMelodyDecoder 模型的词汇表大小。定义了在调用MusicgenMelodyDecoder时，通过inputs_ids能够表示的不同 token 的数量。 - max_position_embeddings (
int, optional, defaults to 2048) — 此模型可能使用的最大序列长度。通常，为了以防万一，将其设置为较大的值（例如，512 或 1024 或 2048）。 - num_hidden_layers (
int, optional, defaults to 24) — 解码器层数。 - ffn_dim (
int, optional, defaults to 4096) — Transformer 模块中“中间”层（通常称为前馈层）的维度。 - num_attention_heads (
int, optional, defaults to 16) — Transformer 模块中每个注意力层的注意力头数。 - layerdrop (
float, optional, defaults to 0.0) — 解码器的 LayerDrop 概率。有关更多详细信息，请参见 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应返回上次的键/值注意力（并非所有模型都使用）。 - activation_function (
str或function, optional, defaults to"gelu") — 解码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_size (
int, optional, defaults to 1024) — 层和池化器层的维度。 - dropout (
float, optional, defaults to 0.1) — 嵌入层、text_encoder 和池化器中所有全连接层的 dropout 概率。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。 - activation_dropout (
float, optional, defaults to 0.0) — 全连接层内部激活的 dropout 比率。 - initializer_factor (
float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - scale_embedding (
bool, optional, defaults toFalse) — 是否通过除以 sqrt(hidden_size) 来缩放嵌入。 - num_codebooks (
int, optional, defaults to 4) — 转发到模型的并行码本的数量。 - audio_channels (
int, optional, defaults to 1) — 模型使用的音频通道数（单声道或立体声）。立体声模型为左右输出通道生成单独的音频流。单声道模型生成单个音频流输出。 - pad_token_id (
int, optional, defaults to 2048) — padding token 的 id。 - bos_token_id (
int, optional, defaults to 2048) — beginning-of-sequence token 的 id。 - eos_token_id (
int, optional) — end-of-sequence token 的 id。 - tie_word_embeddings (
bool, optional, defaults toFalse) — 是否将词嵌入与文本编码器绑定。
这是用于存储 MusicgenMelodyDecoder 配置的配置类。它用于根据指定的参数实例化 Musicgen Melody 解码器，定义模型架构。使用默认值实例化配置将产生与 Musicgen Melody facebook/musicgen-melody 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
MusicgenMelodyProcessor
class transformers.MusicgenMelodyProcessor
< source >( feature_extractor tokenizer )
参数
- feature_extractor (
MusicgenMelodyFeatureExtractor) — MusicgenMelodyFeatureExtractor 的一个实例。feature extractor 是必需的输入。 - tokenizer (
T5Tokenizer) — T5Tokenizer 的一个实例。tokenizer 是必需的输入。
构建一个 MusicGen Melody processor，它将 Wav2Vec2 feature extractor（用于原始音频波形处理）和一个 T5 tokenizer 封装到单个 processor 类中。
MusicgenProcessor 提供了 MusicgenMelodyFeatureExtractor 和 T5Tokenizer 的所有功能。有关更多信息，请参见 __call__() 和 decode()。
用于获取无条件生成的空输入的辅助函数，使模型无需 feature extractor 或 tokenizer 即可使用。
示例
>>> from transformers import MusicgenMelodyForConditionalGeneration, MusicgenMelodyProcessor
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> # get the unconditional (or 'null') inputs for the model
>>> processor = MusicgenMelodyProcessor.from_pretrained("facebook/musicgen-melody")
>>> unconditional_inputs = processor.get_unconditional_inputs(num_samples=1)
>>> audio_samples = model.generate(**unconditional_inputs, max_new_tokens=256)MusicgenMelodyFeatureExtractor
class transformers.MusicgenMelodyFeatureExtractor
< source >( feature_size = 12 sampling_rate = 32000 hop_length = 4096 chunk_length = 30 n_fft = 16384 num_chroma = 12 padding_value = 0.0 return_attention_mask = False stem_indices = [3, 2] **kwargs )
参数
- feature_size (
int, optional, defaults to 12) — 提取特征的特征维度。 - sampling_rate (
int, optional, defaults to 32000) — 音频文件应数字化的采样率，以赫兹 (Hz) 表示。 - hop_length (
int, 可选, 默认为 4096) — 用于获取梅尔频率倒谱系数的 STFT 的重叠窗口长度。 - chunk_length (
int, 可选, 默认为 30) — 用于裁剪和填充较长或较短音频序列的sampling_rate样本的最大块数。 - n_fft (
int, 可选, 默认为 16384) — 傅里叶变换的大小。 - num_chroma (
int, 可选, 默认为 12) — 要使用的色度箱 (chroma bins) 的数量。 - padding_value (
float, 可选, 默认为 0.0) — 用于填充音频的填充值。 - return_attention_mask (
bool, 可选, 默认为False) — 是否返回 attention mask。在调用特征提取器时可以被覆盖。对于 Whisper 模型，为了避免细微的错误，批量推理时应始终传递
attention_mask。 - stem_indices (
List[int], 可选, 默认为[3, 2]) — 如果传递 demucs 输出，则提取的 stem 通道索引。
构建 MusicgenMelody 特征提取器。
此特征提取器继承自 SequenceFeatureExtractor，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
此类从 Demucs 处理的音频或直接从原始音频波形中提取色度特征。
MusicgenMelodyConfig
class transformers.MusicgenMelodyConfig
< source >( num_chroma = 12 chroma_length = 235 **kwargs )
参数
- num_chroma (
int, 可选, 默认为 12) — 要使用的色度箱 (chroma bins) 的数量。 - chroma_length (
int, 可选, 默认为 235) — 如果音频用于调节模型，则为最大色度持续时间。对应于训练期间使用的最大持续时间。 - kwargs (可选) — 关键字参数字典。 特别是：
- text_encoder (PretrainedConfig, 可选) — 定义文本编码器配置的配置对象实例。
- audio_encoder (PretrainedConfig, 可选) — 定义音频编码器配置的配置对象实例。
- decoder (PretrainedConfig, 可选) — 定义解码器配置的配置对象实例。
这是用于存储 MusicgenMelodyModel 配置的配置类。它用于根据指定的参数实例化 Musicgen Melody 模型，定义文本编码器、音频编码器和 Musicgen Melody 解码器配置。使用默认值实例化配置将产生与 Musicgen Melody facebook/musicgen-melody 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import (
... MusicgenMelodyConfig,
... MusicgenMelodyDecoderConfig,
... T5Config,
... EncodecConfig,
... MusicgenMelodyForConditionalGeneration,
... )
>>> # Initializing text encoder, audio encoder, and decoder model configurations
>>> text_encoder_config = T5Config()
>>> audio_encoder_config = EncodecConfig()
>>> decoder_config = MusicgenMelodyDecoderConfig()
>>> configuration = MusicgenMelodyConfig.from_sub_models_config(
... text_encoder_config, audio_encoder_config, decoder_config
... )
>>> # Initializing a MusicgenMelodyForConditionalGeneration (with random weights) from the facebook/musicgen-melody style configuration
>>> model = MusicgenMelodyForConditionalGeneration(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
>>> config_text_encoder = model.config.text_encoder
>>> config_audio_encoder = model.config.audio_encoder
>>> config_decoder = model.config.decoder
>>> # Saving the model, including its configuration
>>> model.save_pretrained("musicgen_melody-model")
>>> # loading model and config from pretrained folder
>>> musicgen_melody_config = MusicgenMelodyConfig.from_pretrained("musicgen_melody-model")
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("musicgen_melody-model", config=musicgen_melody_config)from_sub_models_config
< source >( text_encoder_config: PretrainedConfig audio_encoder_config: PretrainedConfig decoder_config: MusicgenMelodyDecoderConfig **kwargs ) → MusicgenMelodyConfig
从文本编码器、音频编码器和解码器配置实例化 MusicgenMelodyConfig（或派生类）。
MusicgenMelodyModel
class transformers.MusicgenMelodyModel
< source >( config: MusicgenMelodyDecoderConfig )
参数
- config (MusicgenMelodyConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 MusicgenMelody 解码器模型，输出原始隐藏状态，顶部没有任何特定的 head。
Musicgen Melody 模型在 Simple and Controllable Music Generation 中被提出，作者是 Jade Copet、Felix Kreuk、Itai Gat、Tal Remez、David Kant、Gabriel Synnaeve、Yossi Adi、Alexandre Défossez。它是一个仅解码器 Transformer，经过条件音乐生成任务的训练。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如，下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None inputs_embeds: typing.Optional[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 )
参数
- input_ids (形状为
(batch_size * num_codebooks, sequence_length)的torch.LongTensor) — 词汇表中输入序列 token 的索引，对应于音频代码序列。索引可以通过使用音频编码器模型对音频提示进行编码以预测音频代码来获得，例如使用 EncodecModel。 有关详细信息，请参阅 EncodecModel.encode()。
input_ids将在 forward 传递中自动从形状(batch_size * num_codebooks, target_sequence_length)转换为(batch_size, num_codebooks, target_sequence_length)。 如果您从音频编码模型（例如 EncodecModel）获得音频代码，请确保帧数等于 1，并且在将音频代码作为input_ids传递之前，将音频代码从(frames, batch_size, num_codebooks, target_sequence_length)重塑为(batch_size * num_codebooks, target_sequence_length)。 - attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。Mask 值在[0, 1]中选择：- 1 表示 未被屏蔽 的 token，
- 0 表示 被屏蔽 的 token。
- encoder_hidden_states (形状为
(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor, 可选) — 表示文本编码器输出和处理后的音频编码器输出的串联的隐藏状态序列。用作条件信号，因此将连接到 projected 的decoder_input_ids。 - encoder_attention_mask (
torch.LongTensor，形状为(batch_size, encoder_sequence_length)，可选) — 用于避免在条件隐藏状态上执行注意力机制的掩码。 掩码值选自[0, 1]：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于置空注意力模块中选定 head 的掩码。 掩码值选自[0, 1]：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- 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)) 的张量。包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。如果使用
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索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。
MusicgenMelodyModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
MusicgenMelodyForCausalLM
class transformers.MusicgenMelodyForCausalLM
< source >( config: MusicgenMelodyDecoderConfig )
参数
- config (MusicgenMelodyConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有语言建模头的 Musicgen Melody 解码器模型。
Musicgen Melody 模型在 Simple and Controllable Music Generation 中被提出，作者是 Jade Copet、Felix Kreuk、Itai Gat、Tal Remez、David Kant、Gabriel Synnaeve、Yossi Adi、Alexandre Défossez。它是一个仅解码器 Transformer，经过条件音乐生成任务的训练。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如，下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None inputs_embeds: typing.Optional[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 labels: typing.Optional[torch.LongTensor] = None ) → transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size * num_codebooks, sequence_length)) — 词汇表中输入序列 token 的索引，对应于音频代码序列。索引可以通过使用音频编码器模型编码音频提示以预测音频代码来获得，例如使用
EncodecModel。 有关详细信息，请参见EncodecModel.encode()。input_ids将在 forward 传递中自动从形状(batch_size * num_codebooks, target_sequence_length)转换为(batch_size, num_codebooks, target_sequence_length)。 如果您从音频编码模型（例如EncodecModel）获取音频代码，请确保帧数等于 1，并且在将音频代码作为input_ids传递之前，将音频代码从(frames, batch_size, num_codebooks, target_sequence_length)重塑为(batch_size * num_codebooks, target_sequence_length)。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力机制的掩码。 掩码值选自[0, 1]：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, encoder_sequence_length, hidden_size)，可选) — 表示文本编码器输出和处理后的音频编码器输出的连接的隐藏状态序列。 用作条件信号，因此将连接到投影的decoder_input_ids。 - encoder_attention_mask (
torch.LongTensor，形状为(batch_size, encoder_sequence_length)，可选) — 用于避免在条件隐藏状态上执行注意力机制的掩码。 掩码值选自[0, 1]：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- head_mask (
torch.Tensor，形状为(decoder_layers, decoder_attention_heads)，可选) — 用于置空注意力模块中选定 head 的掩码。 掩码值选自[0, 1]：- 1 表示 head 未被掩码，
- 0 表示 head 已被掩码。
- 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)) 的张量。包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。如果使用
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索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是纯元组。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length, num_codebooks)，可选) — 用于语言建模的标签。 请注意，标签在模型内部已移位，即您可以设置labels = input_ids。 索引在[-100, 0, ..., config.vocab_size]中选择。 所有设置为-100的标签都将被忽略（掩码），损失仅针对[0, ..., config.vocab_size]中的标签计算。
返回值
transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (MusicgenMelodyConfig) 和输入。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 语言建模损失（用于预测下一个 token）。 -
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时返回) —tuple(torch.FloatTensor)的元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量)包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。 -
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 之后的注意力权重，用于计算自注意力头的加权平均值。
-
encoder_hidden_states (形状为
(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor，可选) — 条件隐藏状态序列，表示 projected 文本编码器输出和 projected 音频编码器输出的连接。用作条件信号。
MusicgenMelodyForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
MusicgenMelodyForConditionalGeneration
class transformers.MusicgenMelodyForConditionalGeneration
< source >( config: MusicgenMelodyConfig = None text_encoder: typing.Optional[transformers.modeling_utils.PreTrainedModel] = None audio_encoder: typing.Optional[transformers.modeling_utils.PreTrainedModel] = None decoder: typing.Optional[transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyForCausalLM] = None )
参数
- config (MusicgenMelodyConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
- text_encoder (
Optional[PreTrainedModel], 可选) — 文本编码器。 - audio_encoder (
Optional[PreTrainedModel], 可选) — 音频代码解码器。 - decoder (
Optional[MusicgenMelodyForCausalLM], 可选) — MusicGen Melody 解码器，用于生成音频代码。
带有文本和音频条件模型、MusicgenMelody 解码器和音频编码器的复合 Musicgen Melody 模型，用于执行带有一个或两个文本和音频提示的音乐生成任务。
Musicgen Melody 模型在 Simple and Controllable Music Generation 中被提出，作者是 Jade Copet、Felix Kreuk、Itai Gat、Tal Remez、David Kant、Gabriel Synnaeve、Yossi Adi、Alexandre Défossez。它是一个仅解码器 Transformer，经过条件音乐生成任务的训练。
此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如，下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.BoolTensor] = None input_features: typing.Optional[torch.FloatTensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.BoolTensor] = None past_key_values: typing.Tuple[typing.Tuple[torch.FloatTensor]] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None inputs_embeds: 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 **kwargs ) → transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 token 的索引。默认情况下，如果您提供 padding，则会被忽略。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免在 padding token 索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩盖的 token，
- 0 表示被掩盖的 token。
- input_features (形状为
(batch_size, audio_sequence_length, num_chroma)的torch.FloatTensor) — 输入音频特征。这应该由 MusicgenMelodyFeatureExtractor 类返回，您也可以从 AutoFeatureExtractor 中检索该类。 有关详细信息，请参阅MusicgenMelodyFeatureExtractor.__call__()。 - decoder_input_ids (形状为
(batch_size * num_codebooks, target_sequence_length)的torch.LongTensor，可选) — 解码器输入序列 token 在词汇表中的索引，对应于音频代码序列。索引可以通过使用音频编码器模型（例如 EncodecModel）对音频提示进行编码以预测音频代码来获得。有关详细信息，请参阅 EncodecModel.encode()。
在正向传播中，
decoder_input_ids将自动从形状(batch_size * num_codebooks, target_sequence_length)转换为(batch_size, num_codebooks, target_sequence_length)。 如果您从音频编码模型（例如 EncodecModel）获得音频代码，请确保帧数等于 1，并在将音频代码作为decoder_input_ids传递之前，将音频代码从(frames, batch_size, num_codebooks, target_sequence_length)重塑为(batch_size * num_codebooks, target_sequence_length)。 - decoder_attention_mask (形状为
(batch_size, target_sequence_length)的torch.LongTensor，可选) — 默认行为：生成一个 tensor，忽略decoder_input_ids中的 pad token。默认情况下，也将使用因果掩码。 - past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递了use_cache=True或当config.use_cache=True时返回) —tuple(torch.FloatTensor)的元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, encoder_sequence_length + sequence_length, embed_size_per_head)的张量)。包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。如果使用
past_key_values，用户可以选择仅输入最后一次的decoder_input_ids（那些没有将其 past key value states 提供给此模型的），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - encoder_hidden_states (形状为
(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor，可选) — 条件隐藏状态序列，表示 projected 文本编码器输出和 projected 音频编码器输出的连接。用作条件信号，因此将连接到 projecteddecoder_input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想要比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - 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_ids和decoder_inputs_embeds均未设置，则decoder_inputs_embeds取inputs_embeds的值。 - labels (形状为
(batch_size, sequence_length, num_codebooks)的torch.LongTensor，可选) — 用于语言建模的标签。请注意，标签在模型内部已移位，即您可以设置labels = input_ids。 索引在[-100, 0, ..., config.vocab_size]中选择。 所有设置为-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, optional) — 是否返回 ModelOutput 而不是纯粹的元组。(bool, 可选) — 是否返回 ModelOutput 而不是纯粹的元组。
返回值
transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (MusicgenMelodyConfig) 和输入。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 语言建模损失（用于预测下一个 token）。 -
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时返回) —tuple(torch.FloatTensor)的元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量)包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。 -
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 之后的注意力权重，用于计算自注意力头的加权平均值。
-
encoder_hidden_states (形状为
(batch_size, encoder_sequence_length, hidden_size)的torch.FloatTensor，可选) — 条件隐藏状态序列，表示 projected 文本编码器输出和 projected 音频编码器输出的连接。用作条件信号。
MusicgenMelodyForConditionalGeneration 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration
>>> import torch
>>> processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
>>> model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody")
>>> inputs = processor(
... text=["80s pop track with bassy drums and synth", "90s rock song with loud guitars and heavy drums"],
... padding=True,
... return_tensors="pt",
... )
>>> pad_token_id = model.generation_config.pad_token_id
>>> decoder_input_ids = (
... torch.ones((inputs.input_ids.shape[0] * model.decoder.num_codebooks, 1), dtype=torch.long)
... * pad_token_id
... )
>>> logits = model(**inputs, decoder_input_ids=decoder_input_ids).logits
>>> logits.shape # (bsz * num_codebooks, encoder_len + tgt_len, vocab_size)
torch.Size([8, 249, 2048])