Hugging Face's logo

Transformers documentation

MusicGen Melody

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.2).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Este modelo se publicó en HF papers el 2023-06-08 y se contribuyó a Hugging Face Transformers el 2024-03-18.

MusicGen Melody

FlashAttention SDPA

Resumen

El modelo MusicGen Melody fue propuesto en Simple and Controllable Music Generation por Jade Copet, Felix Kreuk, Itai Gat, Tal Remez, David Kant, Gabriel Synnaeve, Yossi Adi y Alexandre Défossez.

MusicGen Melody es un modelo Transformer autoregresivo de una sola etapa capaz de generar muestras de música de alta calidad condicionadas en descripciones de texto o en prompts de audio. Las descripciones de texto se procesan a través de un modelo codificador de texto congelado para obtener una secuencia de representaciones de estados ocultos. A continuación, MusicGen se entrena para predecir tokens de audio discretos, o códigos de audio, condicionados en estos estados ocultos. Estos tokens de audio se decodifican luego mediante un modelo de compresión de audio, como EnCodec, para recuperar la forma de onda del audio.

Gracias a un patrón de intercalación de tokens eficiente, MusicGen no requiere una representación semántica auto-supervisada de los prompts de texto/audios, lo que elimina la necesidad de encadenar múltiples modelos para predecir un conjunto de codebooks (por ejemplo, de forma jerárquica o mediante upsampling). En su lugar, es capaz de generar todos los codebooks en una única pasada hacia adelante.

El resumen del artículo es el siguiente:

Abordamos la tarea de generación de música condicional. Presentamos MusicGen, un único modelo de lenguaje (LM) que opera sobre varios flujos de representación musical discreta y comprimida, es decir, tokens. A diferencia del trabajo previo, MusicGen está compuesto por un LM transformer de una sola etapa junto con patrones eficientes de intercalación de tokens, lo que elimina la necesidad de encadenar varios modelos, por ejemplo, de forma jerárquica o mediante remuestreo. Siguiendo este enfoque, demostramos cómo MusicGen puede generar muestras de alta calidad, mientras se condiciona en descripciones textuales o características melódicas, permitiendo un mejor control sobre la salida generada. Realizamos una evaluación empírica exhaustiva, considerando tanto estudios automáticos como humanos, que muestra que el enfoque propuesto es superior a las líneas base evaluadas en un benchmark estándar de texto a música. A través de estudios de ablación, aclaramos la importancia de cada uno de los componentes que componen MusicGen.

Este modelo fue aportado por ylacombe. El código original se puede encontrar aquí. Los puntos de control preentrenados se pueden encontrar en el Hugging Face Hub.

Diferencia con MusicGen

Hay dos diferencias clave con MusicGen:

  1. La entrada de audio se utiliza aquí como señal condicional para la muestra de audio generada, mientras que en MusicGen se emplea para la continuación de audio.
  2. Las señales condicionales de texto y audio se concatenan a los estados ocultos del decodificador en lugar de utilizarse como señal de atención cruzada, como en MusicGen.

Generación

MusicGen Melody es compatible con dos modos de generación: greedy y sampling. En la práctica, sampling produce resultados significativamente mejores que greedy, por lo que animamos a usar el modo sampling siempre que sea posible. Sampling está habilitado de forma predeterminada y se puede especificar explícitamente estableciendo do_sample=True en la llamada a MusicgenMelodyForConditionalGeneration.generate(), o sobrescribiendo la configuración de generación del modelo (ver más abajo).

Transformers admite tanto las variantes mono (1 canal) como estéreo (2 canales) de MusicGen Melody. Las versiones de canal mono generan un único conjunto de codebooks. Las versiones estéreo generan 2 conjuntos de codebooks, 1 para cada canal (izquierdo/derecho), y cada conjunto de codebooks se decodifica de forma independiente a través del modelo de compresión de audio. Las flujos de audio de cada canal se combinan para dar como resultado la salida estéreo final.

Generación condicional de audio

El modelo puede generar una muestra de audio condicionada por un texto y un prompt de audio mediante el uso de MusicgenMelodyProcessor para preprocesar las entradas.

En los siguientes ejemplos, cargamos un archivo de audio usando la biblioteca 🤗 Datasets, que se puede instalar con pip mediante el siguiente comando:

pip install --upgrade pip
pip install datasets[audio]

El archivo de audio que vamos a utilizar se carga de la siguiente manera:

from datasets import load_dataset


dataset = load_dataset("sanchit-gandhi/gtzan", split="train", streaming=True)
sample = next(iter(dataset))["audio"]

El prompt de audio debe estar idealmente libre de las señales de baja frecuencia que suelen producir instrumentos como los tambores y el bajo. El modelo Demucs puede utilizarse para separar las voces y otras señales de los componentes de tambores y bajo.

Si deseas usar Demucs, primero debes seguir los pasos de instalación aquí antes de usar el siguiente fragmento de código:

import torch
from demucs import pretrained
from demucs.apply import apply_model
from demucs.audio import convert_audio


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])

A continuación, puede usar el siguiente fragmento de código para generar música:

from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration


processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody", device_map="auto")

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)

También puede pasar la señal de audio directamente sin usar Demucs, aunque la calidad de la generación probablemente se degradará:

from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration


processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody", device_map="auto")

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)

Las salidas de audio son un tensor de Torch tridimensional de forma (batch_size, num_channels, sequence_length). Para escuchar las muestras de audio generadas, puedes reproducirlas en un cuaderno ipynb:

from IPython.display import Audio


sampling_rate = model.config.audio_encoder.sampling_rate
Audio(audio_values[0].numpy(), rate=sampling_rate)

O guárdelos como un archivo .wav usando una biblioteca de terceros, por ejemplo, soundfile:

import soundfile as sf


sampling_rate = model.config.audio_encoder.sampling_rate
sf.write("musicgen_out.wav", audio_values[0].T.numpy(), sampling_rate)

Generación condicional solo de texto

El mismo MusicgenMelodyProcessor se puede usar para preprocesar un prompt solo de texto.

from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration


processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody", device_map="auto")

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)

El parámetro guidance_scale se utiliza en la guía libre de clasificador (CFG) para establecer el peso entre los logits condicionales (predichos a partir de los prompts de texto) y los logits incondicionales (predichos a partir de un prompt incondicional o ‘nulo’). Un valor de escala de guía más alto anima al modelo a generar muestras más estrechamente vinculadas al prompt de entrada, generalmente a costa de una menor calidad de audio. La CFG se habilita estableciendo guidance_scale > 1. Para obtener los mejores resultados, use guidance_scale=3 (valor predeterminado).

También puede generar en lotes:


from transformers import AutoProcessor, MusicgenMelodyForConditionalGeneration


processor = AutoProcessor.from_pretrained("facebook/musicgen-melody")
model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody", device_map="auto")

# 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)

Generación incondicional

Los datos de entrada para la generación incondicional (o ‘nula’) se pueden obtener mediante el método MusicgenMelodyProcessor.get_unconditional_inputs():

from transformers import MusicgenMelodyForConditionalGeneration, MusicgenMelodyProcessor


model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody", device_map="auto")
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)

Configuración de generación

Los parámetros predeterminados que controlan el proceso de generación, como el muestreo, la escala de guía y el número de tokens generados, se encuentran en la configuración de generación del modelo y se pueden actualizar según sea necesario:

from transformers import MusicgenMelodyForConditionalGeneration


model = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody", device_map="auto")

# 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

Tenga en cuenta que cualquier argumento pasado al método generate anulará los de la configuración de generación, por lo que establecer do_sample=False en la llamada a generate anulará la configuración de model.generation_config.do_sample en la configuración de generación.

Estructura del modelo

El modelo MusicGen se puede descomponer en tres etapas distintas:

  1. Codificador de texto: mapea las entradas de texto a una secuencia de representaciones de estados ocultos. Los modelos de MusicGen preentrenados utilizan un codificador de texto congelado de T5 o Flan-T5.
  2. Decodificador de melodía de MusicGen: un modelo de lenguaje (LM) que genera de forma auto-regresiva tokens de audio (o códigos) condicionados a las representaciones de estados ocultos del codificador
  3. Decodificador de audio: se utiliza para recuperar la forma de onda del audio a partir de los tokens de audio predichos por el decodificador.

Por lo tanto, el modelo MusicGen puede utilizarse como un modelo decodificador independiente, que corresponde a la clase MusicgenMelodyForCausalLM, o como un modelo compuesto que incluye el codificador de texto y el codificador de audio, que corresponde a la clase MusicgenMelodyForConditionalGeneration. Si solo se necesita cargar el decodificador desde el punto de control preentrenado, se puede cargar especificando primero la configuración correcta, o acceder a él a través del atributo .decoder del modelo compuesto:

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(), device_map="auto")

# Option 2: load the entire composite model, but only return the decoder
decoder = MusicgenMelodyForConditionalGeneration.from_pretrained("facebook/musicgen-melody", device_map="auto").decoder

Dado que los modelos de codificador de texto y de codificador de audio se mantienen congelados durante el entrenamiento, el decodificador de MusicGen MusicgenMelodyForCausalLM puede entrenarse de forma independiente en un conjunto de datos de estados ocultos del codificador y códigos de audio. Para la inferencia, el decodificador entrenado puede combinarse con el codificador de texto y el codificador de audio congelados para recuperar el modelo compuesto MusicgenMelodyForConditionalGeneration.

Conversión de puntos de control

  • Después de descargar los puntos de control originales desde aquí, puedes convertirlos utilizando el script de conversión disponible en src/transformers/models/musicgen_melody/convert_musicgen_melody_transformers.py con el siguiente comando:
python src/transformers/models/musicgen_melody/convert_musicgen_melody_transformers.py \
    --checkpoint="facebook/musicgen-melody" --pytorch_dump_folder /output/path

Consejos:

  • MusicGen se entrena con el checkpoint de 32 kHz de Encodec. Debe asegurarse de utilizar una versión compatible del modelo Encodec.
  • El modo de muestreo suele ofrecer mejores resultados que el modo codicioso; puede activar el muestreo con la variable do_sample en la llamada a MusicgenMelodyForConditionalGeneration.generate()

MusicgenMelodyDecoderConfig

clase transformers.MusicgenMelodyDecoderConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 2048max_position_embeddings: int = 2048num_hidden_layers: int = 24ffn_dim: int = 4096num_attention_heads: int = 16layerdrop: float | int = 0.0use_cache: bool = Trueactivation_function: str = 'gelu'hidden_size: int = 1024dropout: float | int = 0.1attention_dropout: float | int = 0.0activation_dropout: float | int = 0.0initializer_factor: float = 0.02scale_embedding: bool = Falsenum_codebooks: int = 4audio_channels: int = 1pad_token_id: int | None = 2048bos_token_id: int | None = 2048eos_token_id: int | list[int] | None = Nonetie_word_embeddings: bool = Falseis_decoder: bool = Falseadd_cross_attention: bool = False )

Parámetros

  • vocab_size (int, opcional, valor predeterminado 2048) — Tamaño del vocabulario del modelo. Define el número de tokens diferentes que pueden representarse mediante input_ids.
  • max_position_embeddings (int, opcional, valor predeterminado 2048) — La longitud máxima de secuencia con la que se podría utilizar este modelo.
  • num_hidden_layers (int, opcional, valor predeterminado 24) — Número de capas ocultas en el decodificador del Transformer.
  • ffn_dim (int, opcional, valor predeterminado 4096) — Dimensión de las representaciones del MLP.
  • num_attention_heads (int, opcional, valor predeterminado 16) — Número de cabezas de atención para cada capa de atención en el decodificador Transformer.
  • layerdrop (Union[float, int], opcional, valor predeterminado 0.0) — La probabilidad de LayerDrop. Consulte el [artículo de LayerDrop](ver https://huggingface.co/papers/1909.11556) para más detalles.
  • use_cache (bool, opcional, valor predeterminado True) — Indica si el modelo debe devolver las últimas claves/valores de atención (no utilizado por todos los modelos). Solo es relevante si config.is_decoder=True o cuando el modelo es un modelo generativo solo de decodificador.
  • activation_function (str, opcional, valor predeterminado gelu) — La función de activación no lineal (función o cadena) en el decodificador. Por ejemplo, "gelu", "relu", "silu", etc.
  • hidden_size (int, opcional, valor predeterminado 1024) — Dimensión de las representaciones ocultas.
  • dropout (Union[float, int], opcional, valor predeterminado 0.1) — La proporción para todas las capas de dropout.
  • attention_dropout (Union[float, int], opcional, valor predeterminado 0.0) — La proporción de dropout para las probabilidades de atención.
  • activation_dropout (Union[float, int], opcional, valor predeterminado 0.0) — La proporción de dropout para las activaciones dentro de la capa totalmente conectada.
  • initializer_factor (float, opcional, valor predeterminado 0.02) — Un factor para inicializar todas las matrices de pesos (debe mantenerse en 1, se usa internamente para pruebas de inicialización).
  • scale_embedding (bool, opcional, valor predeterminado False) — Si se deben escalar los embeddings dividiendo por sqrt(d_model).
  • num_codebooks (int, opcional, valor predeterminado 4) — El número de libros de códigos paralelos utilizados por el modelo.
  • audio_channels (int, opcional, valor predeterminado 1) — Número de canales de audio utilizados por el modelo (ya sea mono o estéreo). Los modelos estéreo generan un flujo de audio separado para los canales de salida izquierda/derecha. Los modelos mono generan un único flujo de audio de salida.
  • pad_token_id (int, opcional, valor predeterminado 2048) — Id del token utilizado para el relleno en el vocabulario.
  • bos_token_id (int, opcional, valor predeterminado 2048) — Id del token utilizado para el inicio de la secuencia en el vocabulario.
  • eos_token_id (Union[int, list[int]], opcional) — Id del token utilizado para el fin de secuencia en el vocabulario.
  • tie_word_embeddings (bool, opcional, valor predeterminado False) — Si se deben vincular las matrices de pesos de embeddings según el mapeo tied_weights_keys del modelo.
  • is_decoder (bool, opcional, valor predeterminado False) — Indica si el modelo se utiliza como decodificador o no. Si es False, el modelo se utiliza como codificador.
  • add_cross_attention (bool, opcional, valor predeterminado False) — Si se deben añadir capas de atención cruzada al modelo.

Esta es la clase de configuración para almacenar la configuración de un MusicgenMelodyModel. Se utiliza para instanciar un modelo Musicgen Melody según los argumentos especificados, definiendo la arquitectura del modelo. Instanciar una configuración con los valores predeterminados producirá una configuración similar a la de facebook/musicgen-melody

Los objetos de configuración heredan de PreTrainedConfig y se pueden usar para controlar las salidas del modelo. Lea la documentación de PreTrainedConfig para obtener más información.

MusicgenMelodyProcessor

clase transformers.MusicgenMelodyProcessor

< >

( feature_extractortokenizer )

Parámetros

  • feature_extractor (MusicgenMelodyFeatureExtractor) — El extractor de características es una entrada obligatoria.
  • tokenizer (T5Tokenizer) — El tokenizador es una entrada obligatoria.

Construye un MusicgenMelodyProcessor que envuelve un extractor de características y un tokenizador en un único procesador.

MusicgenMelodyProcessor ofrece todas las funcionalidades de MusicgenMelodyFeatureExtractor y T5Tokenizer. Consulte ~MusicgenMelodyFeatureExtractor y ~T5Tokenizer para obtener más información.

__call__

< >

( *args**kwargs )

Parámetros

  • return_tensors (str o TensorType, opcional) — Si se establece, devolverá tensores de un marco de trabajo específico. Los valores aceptables son:
    • 'pt': Devuelve objetos torch.Tensor de PyTorch.
    • 'np': Devuelve objetos np.ndarray de NumPy.

get_unconditional_inputs

< >

( num_samples = 1return_tensors = 'pt' )

Parámetros

  • num_samples (int, opcional) — Número de muestras de audio que se generarán de forma incondicional.

Función auxiliar para obtener entradas nulas para la generación incondicional, lo que permite usar el modelo sin el extractor de características ni el tokenizador.

Ejemplo:

>>> 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

clase transformers.MusicgenMelodyFeatureExtractor

< >

( feature_size = 12sampling_rate = 32000hop_length = 4096chunk_length = 30n_fft = 16384num_chroma = 12padding_value = 0.0return_attention_mask = Falsestem_indices = [3, 2]**kwargs )

Parámetros

  • feature_size (int, opcional, valor predeterminado 12) — La dimensión de las características de las características extraídas.
  • sampling_rate (int, opcional, valor predeterminado 32000) — La tasa de muestreo a la que deben digitalizarse los archivos de audio, expresada en hercios (Hz).
  • hop_length (int, opcional, valor predeterminado 4096) — Longitud de las ventanas superpuestas para la STFT utilizada para obtener los coeficientes de Frecuencia Mel.
  • chunk_length (int, opcional, valor predeterminado 30) — El número máximo de fragmentos de sampling_rate muestras utilizados para recortar y rellenar secuencias de audio más largas o más cortas.
  • n_fft (int, opcional, valor predeterminado 16384) — Tamaño de la transformada de Fourier.
  • num_chroma (int, opcional, valor predeterminado 12) — Número de bins de cromatismo a utilizar.
  • padding_value (float, opcional, valor predeterminado 0.0) — Valor de relleno utilizado para rellenar el audio.
  • return_attention_mask (bool, opcional, por defecto False) — Si se debe devolver la máscara de atención. Se puede sobrescribir al llamar al extractor de características.

    ¿Qué son las máscaras de atención?

    Para los modelos Whisper, attention_mask siempre debe pasarse en la inferencia por lotes para evitar errores sutiles.

  • stem_indices (list[int], opcional, valor predeterminado [3, 2]) — Canales de tallo a extraer si se pasan las salidas de demucs.

Construye un extractor de características MusicgenMelody.

Este extractor de características hereda de SequenceFeatureExtractor, que contiene la mayoría de los métodos principales. Los usuarios deben consultar esta superclase para obtener más información sobre dichos métodos.

Esta clase extrae características cromáticas de audio procesado por Demucs o directamente de la forma de onda de audio sin procesar.

MusicgenMelodyConfig

clase transformers.MusicgenMelodyConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonetext_encoder: dict | transformers.configuration_utils.PreTrainedConfig | None = Noneaudio_encoder: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonedecoder: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonenum_chroma: int = 12chroma_length: int = 235initializer_factor: float = 0.02 )

Parámetros

  • text_encoder (Union[dict, PretrainedConfig]) — Una instancia de un objeto de configuración que define la configuración del codificador de texto.
  • audio_encoder (Union[dict, PretrainedConfig]) — Una instancia de un objeto de configuración que define la configuración del codificador de audio.
  • decoder (Union[dict, PretrainedConfig]) — Una instancia de un objeto de configuración que define la configuración del decodificador.
  • num_chroma (int, opcional, valor predeterminado 12) — Número de bins de cromatismo a utilizar.
  • chroma_length (int, opcional, valor predeterminado 235) — Duración máxima de la cromática si se usa audio para condicionar el modelo. Corresponde a la duración máxima utilizada durante el entrenamiento.
  • initializer_factor (float, opcional, valor predeterminado 0.02) — Un factor para inicializar todas las matrices de pesos (debe mantenerse en 1, se usa internamente para pruebas de inicialización).

Esta es la clase de configuración para almacenar la configuración de un MusicgenMelodyModel. Se utiliza para instanciar un modelo Musicgen Melody según los argumentos especificados, definiendo la arquitectura del modelo. Instanciar una configuración con los valores predeterminados producirá una configuración similar a la de facebook/musicgen-melody

Los objetos de configuración heredan de PreTrainedConfig y se pueden usar para controlar las salidas del modelo. Lea la documentación de PreTrainedConfig para obtener más información.

Ejemplo:

>>> 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(
...     text_encoder=text_encoder_config, audio_encoder=audio_encoder_config, decoder=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)

MusicgenMelodyModel

clase transformers.MusicgenMelodyModel

< >

( config: MusicgenMelodyDecoderConfig )

Parámetros

  • config (MusicgenMelodyDecoderConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.

El modelo Musicgen Melody básico que genera estados ocultos sin ninguna cabeza específica en la parte superior.

Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).

Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneencoder_hidden_states: typing.Optional[torch.Tensor] = Noneencoder_attention_mask: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → BaseModelOutputWithPast or tuple(torch.Tensor)

Parámetros

  • input_ids (torch.LongTensor de forma (batch_size * num_codebooks, sequence_length)) — Índices de los tokens de la secuencia de entrada en el vocabulario, que corresponden a la secuencia de códigos de audio. Los índices se pueden obtener codificando un prompt de audio con un modelo de codificador de audio para predecir códigos de audio, como con EncodecModel. Consulte EncodecModel.encode() para obtener más detalles. ¿Qué son los input IDs? Los input_ids se convertirán automáticamente de la forma (batch_size * num_codebooks, target_sequence_length) a (batch_size, num_codebooks, target_sequence_length) en la pasada hacia adelante. Si obtiene códigos de audio de un modelo de codificación de audio, como EncodecModel, asegúrese de que el número de fotogramas sea igual a 1 y de que redimensione los códigos de audio de (frames, batch_size, num_codebooks, target_sequence_length) a (batch_size * num_codebooks, target_sequence_length) antes de pasarlos como input_ids.

    Los índices se pueden obtener codificando un prompt de audio con un modelo codificador de audio para predecir códigos de audio, como con EncodecModel. Consulte EncodecModel.encode() para más detalles.

    ¿Qué son los IDs de entrada?

    Los input_ids se convertirán automáticamente de la forma (batch_size * num_codebooks, target_sequence_length) a (batch_size, num_codebooks, target_sequence_length) en la pasada hacia adelante. Si obtiene códigos de audio de un modelo de codificación de audio, como EncodecModel, asegúrese de que el número de marcos sea igual a 1 y de que redimensione los códigos de audio de (frames, batch_size, num_codebooks, target_sequence_length) a (batch_size * num_codebooks, target_sequence_length) antes de pasarlos como input_ids.

  • attention_mask (torch.Tensor de forma (batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en [0, 1]:
    • 1 para los tokens que no están enmascarados,
    • 0 para los tokens que están enmascarados.

    ¿Qué son las máscaras de atención?

  • encoder_hidden_states (torch.Tensor de forma (batch_size, encoder_sequence_length, hidden_size), opcional) — Secuencia de hidden-states que representa la concatenación de la salida del codificador de texto y la salida procesada del codificador de audio. Se utiliza como señal condicional y, por lo tanto, se concatenará con los decoder_input_ids proyectados.
  • encoder_attention_mask (torch.LongTensor de forma (batch_size, encoder_sequence_length), opcional) — Máscara para evitar realizar atención sobre estados ocultos condicionales. Valores de la máscara seleccionados en [0, 1]:
    • 1 para los tokens que no están enmascarados,
    • 0 para los tokens que están enmascarados.

    ¿Qué son las máscaras de atención?

  • past_key_values (~cache_utils.Cache, opcional) — Estados ocultos precalculados (claves y valores en los bloques de autoatención y en los bloques de atención cruzada) que se pueden usar para acelerar la decodificación secuencial. Esto generalmente consiste en la past_key_values devuelta por el modelo en una etapa anterior de la decodificación, cuando use_cache=True o config.use_cache=True.

    Solo se permite una instancia de Cache como entrada, consulte nuestra guía de caché kv. Si no se pasan past_key_values, DynamicCache se inicializará de forma predeterminada.

    El modelo generará el mismo formato de caché que se proporciona como entrada.

    Si se utilizan past_key_values, se espera que el usuario introduzca únicamente los input_ids no procesados (aquellos que no tienen sus estados de clave y valor pasados proporcionados a este modelo) con forma (batch_size, unprocessed_length) en lugar de todos los input_ids con forma (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor de forma (batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasar input_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices de input_ids en los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo.
  • use_cache (bool, opcional) — Si se establece en True, se devuelven los estados de clave-valor de past_key_values y pueden usarse para acelerar la decodificación (ver past_key_values).

Devuelve

BaseModelOutputWithPast o tuple(torch.Tensor)

Un BaseModelOutputWithPast o una tupla de torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios elementos según la configuración (None) y las entradas.

El método forward de MusicgenMelodyModel sobrescribe el método especial __call__.

Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de Module después en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.

  • last_hidden_state (torch.Tensor de forma (batch_size, sequence_length, hidden_size)) — Secuencia de estados ocultos en la salida de la última capa del modelo.

    Si se utiliza past_key_values, solo se genera el último hidden-state de las secuencias con forma (batch_size, 1, hidden_size).

  • past_key_values (Cache, opcional, se devuelve cuando se pasa use_cache=True o cuando config.use_cache=True) — Es una instancia de Cache. Para más detalles, consulta nuestra guía de caché kv.

    Contiene estados ocultos precalculados (claves y valores en los bloques de autoatención y, opcionalmente, si config.is_encoder_decoder=True, en los bloques de atención cruzada) que pueden utilizarse (véase la entrada past_key_values) para acelerar la decodificación secuencial.

  • hidden_states (tuple(torch.Tensor), opcional, devuelto cuando se pasa output_hidden_states=True o cuando config.output_hidden_states=True) — Tupla de torch.Tensor (una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma (batch_size, sequence_length, hidden_size).

    Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.

  • attentions (tuple(torch.Tensor), opcional, se devuelve cuando se pasa output_attentions=True o cuando config.output_attentions=True) — Tupla de torch.Tensor (una por cada capa) de forma (batch_size, num_heads, sequence_length, sequence_length).

    Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.

MusicgenMelodyForCausalLM

clase transformers.MusicgenMelodyForCausalLM

< >

( config: MusicgenMelodyDecoderConfig )

Parámetros

  • config (MusicgenMelodyDecoderConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.

El modelo decodificador Musicgen Melody con una cabeza de modelado de lenguaje en la parte superior.

Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).

Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneencoder_hidden_states: typing.Optional[torch.Tensor] = Noneencoder_attention_mask: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = Nonelabels: typing.Optional[torch.LongTensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MusicgenMelodyOutputWithPast or tuple(torch.Tensor)

Parámetros

  • input_ids (torch.LongTensor de forma (batch_size * num_codebooks, sequence_length)) — Índices de los tokens de la secuencia de entrada en el vocabulario, que corresponden a la secuencia de códigos de audio. Los índices se pueden obtener codificando un prompt de audio con un modelo de codificador de audio para predecir códigos de audio, como con EncodecModel. Consulte EncodecModel.encode() para obtener más detalles. ¿Qué son los input IDs? Los input_ids se convertirán automáticamente de la forma (batch_size * num_codebooks, target_sequence_length) a (batch_size, num_codebooks, target_sequence_length) en la pasada hacia adelante. Si obtiene códigos de audio de un modelo de codificación de audio, como EncodecModel, asegúrese de que el número de fotogramas sea igual a 1 y de que redimensione los códigos de audio de (frames, batch_size, num_codebooks, target_sequence_length) a (batch_size * num_codebooks, target_sequence_length) antes de pasarlos como input_ids.

    Los índices se pueden obtener codificando un prompt de audio con un modelo codificador de audio para predecir códigos de audio, como con EncodecModel. Consulte EncodecModel.encode() para más detalles.

    ¿Qué son los IDs de entrada?

    Los input_ids se convertirán automáticamente de la forma (batch_size * num_codebooks, target_sequence_length) a (batch_size, num_codebooks, target_sequence_length) en la pasada hacia adelante. Si obtiene códigos de audio de un modelo de codificación de audio, como EncodecModel, asegúrese de que el número de marcos sea igual a 1 y de que redimensione los códigos de audio de (frames, batch_size, num_codebooks, target_sequence_length) a (batch_size * num_codebooks, target_sequence_length) antes de pasarlos como input_ids.

  • attention_mask (torch.Tensor de forma (batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en [0, 1]:
    • 1 para los tokens que no están enmascarados,
    • 0 para los tokens que están enmascarados.

    ¿Qué son las máscaras de atención?

  • encoder_hidden_states (torch.Tensor de forma (batch_size, encoder_sequence_length, hidden_size), opcional) — Secuencia de hidden-states que representa la concatenación de la salida del codificador de texto y la salida procesada del codificador de audio. Se utiliza como señal condicional y, por lo tanto, se concatenará con los decoder_input_ids proyectados.
  • encoder_attention_mask (torch.LongTensor de forma (batch_size, encoder_sequence_length), opcional) — Máscara para evitar realizar atención sobre estados ocultos condicionales. Valores de la máscara seleccionados en [0, 1]:
    • 1 para los tokens que no están enmascarados,
    • 0 para los tokens que están enmascarados.

    ¿Qué son las máscaras de atención?

  • past_key_values (~cache_utils.Cache, opcional) — Estados ocultos precalculados (claves y valores en los bloques de autoatención y en los bloques de atención cruzada) que se pueden usar para acelerar la decodificación secuencial. Esto generalmente consiste en la past_key_values devuelta por el modelo en una etapa anterior de la decodificación, cuando use_cache=True o config.use_cache=True.

    Solo se permite una instancia de Cache como entrada, consulte nuestra guía de caché kv. Si no se pasan past_key_values, DynamicCache se inicializará de forma predeterminada.

    El modelo generará el mismo formato de caché que se proporciona como entrada.

    Si se utilizan past_key_values, se espera que el usuario introduzca únicamente los input_ids no procesados (aquellos que no tienen sus estados de clave y valor pasados proporcionados a este modelo) con forma (batch_size, unprocessed_length) en lugar de todos los input_ids con forma (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor de forma (batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasar input_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices de input_ids en los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo.
  • use_cache (bool, opcional) — Si se establece en True, se devuelven los estados de clave-valor de past_key_values y pueden usarse para acelerar la decodificación (ver past_key_values).
  • labels (torch.LongTensor de forma (batch_size, sequence_length, num_codebooks), opcional) — Etiquetas para el modelado de lenguaje. Tenga en cuenta que las etiquetas se desplazan dentro del modelo, es decir, puede establecer labels = input_ids Los índices se seleccionan en [-100, 0, ..., config.vocab_size] Todas las etiquetas establecidas en -100 se ignoran (se enmascaran), la pérdida solo se calcula para las etiquetas en [0, ..., config.vocab_size]

Devuelve

MusicgenMelodyOutputWithPast o tuple(torch.Tensor)

Un MusicgenMelodyOutputWithPast o una tupla de torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios elementos según la configuración (MusicgenMelodyConfig) y las entradas.

El método forward de MusicgenMelodyForCausalLM sobrescribe el método especial __call__.

Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de Module después en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.

  • loss (torch.Tensor de forma (1,), opcional, se devuelve cuando se proporciona labels) — Pérdida de modelado de lenguaje (para la predicción del siguiente token).

  • logits (torch.Tensor de forma (batch_size, sequence_length, config.vocab_size)) — Puntuaciones de predicción de la cabeza de modelado de lenguaje (puntuaciones para cada token del vocabulario antes de SoftMax).

  • past_key_values (Cache, opcional, se devuelve cuando se pasa use_cache=True o cuando config.use_cache=True) — Es una instancia de Cache. Para más detalles, consulta nuestra guía de caché kv.

    Contiene estados ocultos precalculados (claves y valores en los bloques de autoatención) que pueden utilizarse (véase la entrada past_key_values) para acelerar la decodificación secuencial.

  • hidden_states (tuple[torch.Tensor], opcional, se devuelve cuando se pasa output_hidden_states=True o cuando config.output_hidden_states=True) — Tupla de torch.Tensor (una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma (batch_size, sequence_length, hidden_size).

    Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.

  • attentions (tuple[torch.Tensor], opcional, se devuelve cuando se pasa output_attentions=True o cuando config.output_attentions=True) — Tupla de torch.Tensor (una por cada capa) de forma (batch_size, num_heads, sequence_length, sequence_length).

    Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.

  • encoder_hidden_states (torch.Tensor de forma (batch_size, encoder_sequence_length, hidden_size), opcional) — Secuencia de estados ocultos condicionales que representa la concatenación de la salida proyectada del codificador de texto y la salida proyectada del codificador de audio. Se utiliza como señal condicional.

Ejemplo:

MusicgenMelodyForConditionalGeneration

clase transformers.MusicgenMelodyForConditionalGeneration

< >

( config: MusicgenMelodyConfig = Nonetext_encoder: transformers.modeling_utils.PreTrainedModel | None = Noneaudio_encoder: transformers.modeling_utils.PreTrainedModel | None = Nonedecoder: transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyForCausalLM | None = None )

Parámetros

  • config (MusicgenMelodyConfig, opcional) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
  • text_encoder (PreTrainedModel, opcional) — El modelo de codificador de texto que codifica el texto en estados ocultos para el condicionamiento.
  • audio_encoder (PreTrainedModel, opcional) — El modelo de codificador de audio que codifica el audio en estados ocultos para el condicionamiento.
  • decoder (MusicgenMelodyForCausalLM, opcional) — El modelo decodificador que genera tokens de audio en función de las señales de condicionamiento.

El modelo Musicgen Melody para la generación de tokens condicionada en otras modalidades (p. ej., generación de texto a partir de imagen y texto).

Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).

Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.BoolTensor] = Noneinput_features: typing.Optional[torch.Tensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.BoolTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneencoder_hidden_states: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonedecoder_inputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → MusicgenMelodyOutputWithPast or tuple(torch.Tensor)

Parámetros

  • input_ids (torch.LongTensor de forma (batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.

    Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.

    ¿Qué son los IDs de entrada?

  • attention_mask (torch.BoolTensor de forma (batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en [0, 1]:
    • 1 para los tokens que no están enmascarados,
    • 0 para los tokens que están enmascarados.

    ¿Qué son las máscaras de atención?

  • input_features (torch.Tensor de forma (batch_size, sequence_length, feature_dim), opcional) — Los tensores correspondientes a las características de audio de entrada. Las características de audio se pueden obtener utilizando MusicgenMelodyFeatureExtractor. Consulte MusicgenMelodyFeatureExtractor.__call__() para más detalles (MusicgenMelodyProcessor utiliza MusicgenMelodyFeatureExtractor para procesar los audios).
  • decoder_input_ids (torch.LongTensor de forma (batch_size * num_codebooks, target_sequence_length), opcional) — Índices de los tokens de la secuencia de entrada del decodificador en el vocabulario, que corresponden a la secuencia de códigos de audio. Los índices se pueden obtener codificando un prompt de audio con un modelo de codificador de audio para predecir códigos de audio, como con EncodecModel. Consulte EncodecModel.encode() para obtener más detalles. ¿Qué son los IDs de entrada del decodificador? decoder_input_ids se convertirá automáticamente de la forma (batch_size * num_codebooks, target_sequence_length) a (batch_size, num_codebooks, target_sequence_length) en la pasada hacia adelante. Si obtiene códigos de audio de un modelo de codificación de audio, como EncodecModel, asegúrese de que el número de fotogramas sea igual a 1 y de que redimensione los códigos de audio de (frames, batch_size, num_codebooks, target_sequence_length) a (batch_size * num_codebooks, target_sequence_length) antes de pasarlos como decoder_input_ids.

    Los índices se pueden obtener codificando un prompt de audio con un modelo codificador de audio para predecir códigos de audio, como con EncodecModel. Consulte EncodecModel.encode() para más detalles.

    ¿Qué son los IDs de entrada del decodificador?

    Los decoder_input_ids se convertirán automáticamente de la forma (batch_size * num_codebooks, target_sequence_length) a (batch_size, num_codebooks, target_sequence_length) en la pasada hacia adelante. Si obtiene códigos de audio de un modelo de codificación de audio, como EncodecModel, asegúrese de que el número de marcos sea igual a 1 y de que redimensione los códigos de audio de (frames, batch_size, num_codebooks, target_sequence_length) a (batch_size * num_codebooks, target_sequence_length) antes de pasarlos como decoder_input_ids.

  • decoder_attention_mask (torch.LongTensor de forma (batch_size, target_sequence_length), opcional) — Comportamiento predeterminado: genera un tensor que ignora los tokens de relleno en decoder_input_ids. También se usará una máscara causal de forma predeterminada.
  • past_key_values (~cache_utils.Cache, opcional) — Estados ocultos precalculados (claves y valores en los bloques de autoatención y en los bloques de atención cruzada) que se pueden usar para acelerar la decodificación secuencial. Esto generalmente consiste en la past_key_values devuelta por el modelo en una etapa anterior de la decodificación, cuando use_cache=True o config.use_cache=True.

    Solo se permite una instancia de Cache como entrada, consulte nuestra guía de caché kv. Si no se pasan past_key_values, DynamicCache se inicializará de forma predeterminada.

    El modelo generará el mismo formato de caché que se proporciona como entrada.

    Si se utilizan past_key_values, se espera que el usuario introduzca únicamente los input_ids no procesados (aquellos que no tienen sus estados de clave y valor pasados proporcionados a este modelo) con forma (batch_size, unprocessed_length) en lugar de todos los input_ids con forma (batch_size, sequence_length).

  • encoder_hidden_states (torch.Tensor de forma (batch_size, encoder_sequence_length, hidden_size), opcional) — Secuencia de estados ocultos condicionales que representa la concatenación de la salida proyectada del codificador de texto y la salida proyectada del codificador de audio. Se utiliza como señal condicional y, por lo tanto, se concatenará con los decoder_input_ids proyectados.
  • inputs_embeds (torch.Tensor de forma (batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasar input_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices de input_ids en los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo.
  • decoder_inputs_embeds (torch.Tensor de forma (batch_size, target_sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasar decoder_input_ids puede optar por pasar directamente una representación incrustada. Si past_key_values se usa, opcionalmente solo la última decoder_inputs_embeds debe ser introducida (ver past_key_values). Esto es útil si se desea tener más control sobre cómo convertir decoder_input_ids índices en vectores asociados que la matriz de búsqueda de incrustaciones interna del modelo.

    Si decoder_input_ids y decoder_inputs_embeds no están configurados, decoder_inputs_embeds toma el valor de inputs_embeds.

  • labels (torch.LongTensor de forma (batch_size, sequence_length, num_codebooks), opcional) — Etiquetas para el modelado de lenguaje. Tenga en cuenta que las etiquetas se desplazan dentro del modelo, es decir, puede establecer labels = input_ids Los índices se seleccionan en [-100, 0, ..., config.vocab_size] Todas las etiquetas establecidas en -100 se ignoran (se enmascaran), la pérdida solo se calcula para las etiquetas en [0, ..., config.vocab_size]
  • use_cache (bool, opcional) — Si se establece en True, se devuelven los estados de clave-valor de past_key_values y pueden usarse para acelerar la decodificación (ver past_key_values).

Devuelve

MusicgenMelodyOutputWithPast o tuple(torch.Tensor)

Un MusicgenMelodyOutputWithPast o una tupla de torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios elementos según la configuración (MusicgenMelodyConfig) y las entradas.

El método forward de MusicgenMelodyForConditionalGeneration sobrescribe el método especial __call__.

Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de Module después en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.

  • loss (torch.Tensor de forma (1,), opcional, se devuelve cuando se proporciona labels) — Pérdida de modelado de lenguaje (para la predicción del siguiente token).

  • logits (torch.Tensor de forma (batch_size, sequence_length, config.vocab_size)) — Puntuaciones de predicción de la cabeza de modelado de lenguaje (puntuaciones para cada token del vocabulario antes de SoftMax).

  • past_key_values (Cache, opcional, se devuelve cuando se pasa use_cache=True o cuando config.use_cache=True) — Es una instancia de Cache. Para más detalles, consulta nuestra guía de caché kv.

    Contiene estados ocultos precalculados (claves y valores en los bloques de autoatención) que pueden utilizarse (véase la entrada past_key_values) para acelerar la decodificación secuencial.

  • hidden_states (tuple[torch.Tensor], opcional, se devuelve cuando se pasa output_hidden_states=True o cuando config.output_hidden_states=True) — Tupla de torch.Tensor (una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma (batch_size, sequence_length, hidden_size).

    Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.

  • attentions (tuple[torch.Tensor], opcional, se devuelve cuando se pasa output_attentions=True o cuando config.output_attentions=True) — Tupla de torch.Tensor (una por cada capa) de forma (batch_size, num_heads, sequence_length, sequence_length).

    Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.

  • encoder_hidden_states (torch.Tensor de forma (batch_size, encoder_sequence_length, hidden_size), opcional) — Secuencia de estados ocultos condicionales que representa la concatenación de la salida proyectada del codificador de texto y la salida proyectada del codificador de audio. Se utiliza como señal condicional.

Ejemplos:

>>> 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])
Update on GitHub

←MusicGen Nemotron 3 Diarization→