Hugging Face's logo

Transformers documentation

MusicGen

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

Model ini dipublikasikan di HF papers pada 2023-06-08 dan disumbangkan ke Hugging Face Transformers pada 2023-06-29.

MusicGen

FlashAttention SDPA

Ikhtisar

Model MusicGen diusulkan dalam makalah Simple and Controllable Music Generation oleh Jade Copet, Felix Kreuk, Itai Gat, Tal Remez, David Kant, Gabriel Synnaeve, Yossi Adi, dan Alexandre Défossez.

MusicGen adalah model Transformer auto-regressive satu tahap yang mampu menghasilkan sampel musik berkualitas tinggi yang dikondisikan pada deskripsi teks atau prompt audio. Deskripsi teks tersebut diproses melalui model encoder teks yang dibekukan (frozen) untuk memperoleh urutan representasi hidden-state. MusicGen kemudian dilatih untuk memprediksi token audio diskrit, atau audio codes, yang dikondisikan pada hidden-state tersebut. Token audio ini kemudian didekode menggunakan model kompresi audio, seperti EnCodec, untuk memulihkan waveform audio.

Melalui pola penginterleaving token yang efisien, MusicGen tidak memerlukan representasi semantik self-supervised dari prompt teks/audio, sehingga menghilangkan kebutuhan untuk mengascade beberapa model guna memprediksi seperangkat codebook (misalnya secara hierarkis atau upsampling). Sebagai gantinya, model ini mampu menghasilkan semua codebook dalam satu forward pass.

Abstrak dari makalah tersebut adalah sebagai berikut:

Kami menangani tugas pembuatan musik bersyarat. Kami memperkenalkan MusicGen, sebuah Language Model (LM) tunggal yang beroperasi di atas beberapa stream representasi musik diskrit terkompresi, yaitu token. Berbeda dengan karya sebelumnya, MusicGen terdiri dari transformer LM satu tahap yang dilengkapi dengan pola penginterleaving token yang efisien, sehingga menghilangkan kebutuhan untuk mengascade beberapa model, misalnya secara hierarkis atau upsampling. Dengan pendekatan ini, kami menunjukkan bagaimana MusicGen dapat menghasilkan sampel berkualitas tinggi, sementara dikondisikan pada deskripsi teks atau fitur melodi, yang memungkinkan kontrol yang lebih baik atas output yang dihasilkan. Kami melakukan evaluasi empiris yang luas, mempertimbangkan studi otomatis dan studi manusia, yang menunjukkan bahwa pendekatan yang diusulkan lebih unggul daripada baseline yang dievaluasi pada benchmark teks-ke-musik standar. Melalui studi ablation, kami menyoroti pentingnya masing-masing komponen yang membentuk MusicGen.

Model ini disumbangkan oleh sanchit-gandhi. Kode aslinya dapat ditemukan di sini. Checkpoint yang telah dilatih sebelumnya dapat ditemukan di Hugging Face Hub.

Tips penggunaan

  • Setelah mengunduh checkpoint asli dari sini , Anda dapat mengonversinya menggunakan skrip konversi yang tersedia di src/transformers/models/musicgen/convert_musicgen_transformers.py dengan perintah berikut:
python src/transformers/models/musicgen/convert_musicgen_transformers.py \
    --checkpoint small --pytorch_dump_folder /output/path

Generasi

MusicGen kompatibel dengan dua mode generasi: greedy dan sampling. Dalam praktiknya, sampling menghasilkan kualitas yang jauh lebih baik daripada greedy, sehingga kami mendorong penggunaan mode sampling sejauh mungkin. Sampling diaktifkan secara default, dan dapat ditentukan secara eksplisit dengan mengatur do_sample=True dalam pemanggilan MusicgenForConditionalGeneration.generate(), atau dengan menimpa konfigurasi generasi model (lihat di bawah).

Generation dibatasi oleh sinusoidal positional embeddings hingga input 30 detik. Artinya, MusicGen tidak dapat menghasilkan lebih dari 30 detik audio (1503 token), dan audio input yang diberikan melalui Audio-Prompted Generation turut berkontribusi pada batas ini sehingga, dengan input audio 20 detik, MusicGen tidak dapat menghasilkan lebih dari 10 detik audio tambahan.

Transformers mendukung varian mono (1 kanal) dan stereo (2 kanal) dari MusicGen. Versi kanal mono menghasilkan satu set codebook. Versi stereo menghasilkan 2 set codebook, 1 untuk setiap kanal (kiri/kanan), dan setiap set codebook didekode secara independen melalui model kompresi audio. Aliran audio untuk setiap kanal digabungkan untuk menghasilkan output stereo akhir.

Generasi Tanpa Syarat

Input untuk generasi tanpa syarat (atau ‘null’) dapat diperoleh melalui metode MusicgenForConditionalGeneration.get_unconditional_inputs():

from transformers import MusicgenForConditionalGeneration


model = MusicgenForConditionalGeneration.from_pretrained("facebook/musicgen-small", device_map="auto")
unconditional_inputs = model.get_unconditional_inputs(num_samples=1)

audio_values = model.generate(**unconditional_inputs, do_sample=True, max_new_tokens=256)

Output audio adalah tensor Torch tiga dimensi dengan bentuk (batch_size, num_channels, sequence_length). Untuk mendengarkan sampel audio yang dihasilkan, Anda dapat memutar mereka di notebook ipynb:

from IPython.display import Audio


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

Atau simpan sebagai file .wav menggunakan pustaka pihak ketiga, misalnya scipy:

import scipy


sampling_rate = model.config.audio_encoder.sampling_rate
scipy.io.wavfile.write("musicgen_out.wav", rate=sampling_rate, data=audio_values[0, 0].numpy())

Generasi Bersyarat Teks

Model dapat menghasilkan sampel audio yang dikondisikan pada prompt teks dengan menggunakan MusicgenProcessor untuk memproses awal input:

from transformers import AutoProcessor, MusicgenForConditionalGeneration


processor = AutoProcessor.from_pretrained("facebook/musicgen-small")
model = MusicgenForConditionalGeneration.from_pretrained("facebook/musicgen-small", 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)

guidance_scale digunakan dalam classifier free guidance (CFG) untuk mengatur pembobotan antara logits bersyarat (yang diprediksi dari prompt teks) dan logits tak bersyarat (yang diprediksi dari prompt tak bersyarat atau ‘null’). Nilai guidance scale yang lebih tinggi mendorong model untuk menghasilkan sampel yang lebih erat kaitannya dengan prompt input, biasanya dengan mengorbankan kualitas audio yang lebih buruk. CFG diaktifkan dengan mengatur guidance_scale > 1. Untuk hasil terbaik, gunakan guidance_scale=3 (default).

Generasi yang Dipicu Audio

MusicgenProcessor yang sama dapat digunakan untuk memproses awal prompt audio yang dipakai untuk kelanjutan audio. Pada contoh berikut, kami memuat file audio menggunakan pustaka 🤗 Datasets, yang dapat diinstal melalui pip dengan perintah di bawah ini:

pip install --upgrade pip
pip install datasets[audio]
from datasets import load_dataset

from transformers import AutoProcessor, MusicgenForConditionalGeneration


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

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

# take the first half of the audio sample
sample["array"] = sample["array"][: len(sample["array"]) // 2]

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)

Untuk generasi berbasis prompt audio yang diproses secara batch, audio_values yang dihasilkan dapat diproses lebih lanjut untuk menghapus padding dengan menggunakan kelas MusicgenProcessor:

from datasets import load_dataset

from transformers import AutoProcessor, MusicgenForConditionalGeneration


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

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

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

# post-process to remove padding from the batched audio
audio_values = processor.batch_decode(audio_values, padding_mask=inputs.padding_mask)

Konfigurasi Generasi

Parameter default yang mengontrol proses generasi, seperti sampling, guidance scale, dan jumlah token yang dihasilkan, dapat ditemukan dalam konfigurasi generasi model, dan diperbarui sesuai keinginan:

from transformers import MusicgenForConditionalGeneration


model = MusicgenForConditionalGeneration.from_pretrained("facebook/musicgen-small", 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

Perhatikan bahwa argumen apa pun yang diteruskan ke metode generate akan mengesampingkan argumen dalam konfigurasi generasi, sehingga pengaturan do_sample=False dalam panggilan generate akan mengesampingkan pengaturan model.generation_config.do_sample dalam konfigurasi generasi.

Struktur Model

Model MusicGen dapat diuraikan menjadi tiga tahap yang berbeda:

  1. Text encoder: memetakan input teks ke urutan representasi hidden-state. Model MusicGen yang telah dilatih sebelumnya menggunakan text encoder beku dari T5 atau Flan-T5
  2. MusicGen decoder: model bahasa (LM) yang menghasilkan token audio (atau kode) secara auto-regresif bersyarat pada representasi hidden-state dari encoder
  3. Audio encoder/decoder: digunakan untuk meng-encode prompt audio untuk digunakan sebagai token prompt, dan memulihkan waveform audio dari token audio yang diprediksi oleh decoder

Dengan demikian, model MusicGen dapat digunakan sebagai model decoder mandiri, yang sesuai dengan kelas MusicgenForCausalLM, atau sebagai model komposit yang mencakup encoder teks dan encoder/decoder audio, yang sesuai dengan kelas MusicgenForConditionalGeneration. Jika hanya decoder yang perlu dimuat dari checkpoint terlatih sebelumnya, decoder tersebut dapat dimuat dengan terlebih dahulu menentukan config yang benar, atau diakses melalui atribut .decoder dari model komposit:

from transformers import AutoConfig, MusicgenForCausalLM, MusicgenForConditionalGeneration


# Option 1: get decoder config and pass to `.from_pretrained`
decoder_config = AutoConfig.from_pretrained("facebook/musicgen-small").decoder
decoder = MusicgenForCausalLM.from_pretrained("facebook/musicgen-small", **decoder_config, device_map="auto")

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

Karena model text encoder dan audio encoder/decoder dibekukan selama pelatihan, decoder MusicGen MusicgenForCausalLM dapat dilatih secara mandiri pada dataset hidden-states encoder dan kode audio. Untuk inferensi, decoder yang telah dilatih dapat digabungkan dengan text encoder dan audio encoder/decoder yang dibekukan untuk memulihkan model komposit MusicgenForConditionalGeneration.

Tips:

  • MusicGen dilatih pada checkpoint 32kHz dari Encodec. Anda harus memastikan menggunakan versi Encodec model yang kompatibel.
  • Mode sampling cenderung memberikan hasil yang lebih baik daripada greedy - Anda dapat mengaktifkan sampling dengan variabel do_sample dalam panggilan ke MusicgenForConditionalGeneration.generate()

MusicgenDecoderConfig

kelas transformers.MusicgenDecoderConfig

< >

( 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 = Falsecross_attention_hidden_size: int | None = None )

Parameter

  • vocab_size (int, opsional, default 2048) — Ukuran kosakata model. Menentukan jumlah token berbeda yang dapat direpresentasikan oleh input_ids.
  • max_position_embeddings (int, opsional, default 2048) — Panjang maksimum urutan yang mungkin digunakan dengan model ini.
  • num_hidden_layers (int, opsional, default 24) — Jumlah lapisan tersembunyi dalam decoder Transformer.
  • ffn_dim (int, opsional, defaultnya 4096) — Dimensi dari representasi MLP.
  • num_attention_heads (int, opsional, default 16) — Jumlah attention head untuk setiap lapisan attention di decoder Transformer.
  • layerdrop (Union[float, int], opsional, default 0.0) — Probabilitas LayerDrop. Lihat [makalah LayerDrop](lihat https://huggingface.co/papers/1909.11556) untuk detail lebih lanjut.
  • use_cache (bool, opsional, defaultnya True) — Apakah model harus mengembalikan perhatian kunci/nilai terakhir (tidak digunakan oleh semua model). Hanya relevan jika config.is_decoder=True atau ketika model adalah model generatif yang hanya decoder.
  • activation_function (str, opsional, defaultnya gelu) — Fungsi aktivasi non-linear (fungsi atau string) di decoder. Misalnya, "gelu", "relu", "silu", dan sebagainya.
  • hidden_size (int, opsional, default 1024) — Dimensi dari representasi tersembunyi.
  • dropout (Union[float, int], opsional, default 0.1) — Rasio untuk semua lapisan dropout.
  • attention_dropout (Union[float, int], opsional, default 0.0) — Rasio dropout untuk probabilitas perhatian.
  • activation_dropout (Union[float, int], opsional, defaultnya 0.0) — Rasio dropout untuk aktivasi di dalam lapisan fully connected.
  • initializer_factor (float, opsional, defaultnya 0.02) — Faktor untuk menginisialisasi semua matriks bobot (sebaiknya dipertahankan pada 1, digunakan secara internal untuk pengujian inisialisasi).
  • scale_embedding (bool, opsional, default False) — Apakah akan menskalakan embedding dengan membaginya oleh sqrt(d_model).
  • num_codebooks (int, opsional, default 4) — Jumlah codebook paralel yang digunakan oleh model.
  • audio_channels (int, opsional, defaultnya 1) — Jumlah saluran input.
  • pad_token_id (int, opsional, default 2048) — ID token yang digunakan untuk padding dalam kosakata.
  • bos_token_id (int, opsional, default 2048) — ID token yang digunakan untuk awal-stream dalam kosakata.
  • eos_token_id (Union[int, list[int]], opsional) — ID token yang digunakan untuk akhir aliran dalam kosakata.
  • tie_word_embeddings (bool, opsional, default False) — Apakah akan mengikat bobot embedding sesuai dengan pemetaan tied_weights_keys model.
  • is_decoder (bool, opsional, default False) — Apakah model digunakan sebagai decoder atau tidak. Jika False, model digunakan sebagai encoder.
  • add_cross_attention (bool, opsional, default False) — Apakah lapisan cross-attention harus ditambahkan ke model.
  • cross_attention_hidden_size (int, opsional) — Ukuran tersembunyi dari keluaran encoder yang diproyeksikan ke ruang kunci/nilai cross-attention decoder. Digunakan ketika encoder dan decoder memiliki ukuran tersembunyi yang berbeda.

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari MusicgenModel. Kelas ini digunakan untuk membuat instans model Musicgen sesuai dengan argumen yang ditentukan, yang mendefinisikan arsitektur model. Membuat instans konfigurasi dengan nilai bawaan akan menghasilkan konfigurasi yang serupa dengan konfigurasi dari facebook/musicgen-small

Objek konfigurasi mewarisi dari PreTrainedConfig dan dapat digunakan untuk mengontrol output model. Baca dokumentasi dari PreTrainedConfig untuk informasi lebih lanjut.

MusicgenConfig

kelas transformers.MusicgenConfig

< >

( 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 = Noneinitializer_factor: float = 0.02 )

Parameter

  • text_encoder (Union[dict, PretrainedConfig]) — Instans dari objek konfigurasi yang mendefinisikan konfigurasi text encoder.
  • audio_encoder (Union[dict, PretrainedConfig]) — Instans dari objek konfigurasi yang mendefinisikan konfigurasi audio encoder.
  • decoder (Union[dict, PretrainedConfig]) — Instans dari objek konfigurasi yang mendefinisikan konfigurasi decoder.
  • initializer_factor (float, opsional, defaultnya 0.02) — Faktor untuk menginisialisasi semua matriks bobot (sebaiknya dipertahankan pada 1, digunakan secara internal untuk pengujian inisialisasi).

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari MusicgenModel. Kelas ini digunakan untuk membuat instans model Musicgen sesuai dengan argumen yang ditentukan, yang mendefinisikan arsitektur model. Membuat instans konfigurasi dengan nilai bawaan akan menghasilkan konfigurasi yang serupa dengan konfigurasi dari facebook/musicgen-small

Objek konfigurasi mewarisi dari PreTrainedConfig dan dapat digunakan untuk mengontrol output model. Baca dokumentasi dari PreTrainedConfig untuk informasi lebih lanjut.

Contoh:

>>> from transformers import (
...     MusicgenConfig,
...     MusicgenDecoderConfig,
...     T5Config,
...     EncodecConfig,
...     MusicgenForConditionalGeneration,
... )

>>> # Initializing text encoder, audio encoder, and decoder model configurations
>>> text_encoder_config = T5Config()
>>> audio_encoder_config = EncodecConfig()
>>> decoder_config = MusicgenDecoderConfig()

>>> configuration = MusicgenConfig(
...     text_encoder=text_encoder_config,
...     audio_encoder=audio_encoder_config,
...     decoder=decoder_config,
... )

>>> # Initializing a MusicgenForConditionalGeneration (with random weights) from the facebook/musicgen-small style configuration
>>> model = MusicgenForConditionalGeneration(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-model")

>>> # loading model and config from pretrained folder
>>> musicgen_config = MusicgenConfig.from_pretrained("musicgen-model")
>>> model = MusicgenForConditionalGeneration.from_pretrained("musicgen-model", config=musicgen_config)

MusicgenProcessor

kelas transformers.MusicgenProcessor

< >

( feature_extractortokenizer )

Parameter

  • feature_extractor (EncodecFeatureExtractor) — Ekstraktor fitur adalah input yang wajib.
  • tokenizer (T5Tokenizer) — Tokenizer adalah input yang wajib.

Membangun MusicgenProcessor yang membungkus feature extractor dan tokenizer menjadi satu processor.

MusicgenProcessor menyediakan semua fungsionalitas dari EncodecFeatureExtractor dan T5Tokenizer. Lihat ~EncodecFeatureExtractor dan ~T5Tokenizer untuk informasi lebih lanjut.

__call__

< >

( *args**kwargs )

Parameter

  • return_tensors (str atau TensorType, opsional) — Jika diset, akan mengembalikan tensor dari framework tertentu. Nilai yang dapat diterima adalah:
    • 'pt': Mengembalikan objek PyTorch torch.Tensor.
    • 'np': Mengembalikan objek NumPy np.ndarray.

MusicgenModel

kelas transformers.MusicgenModel

< >

( config: MusicgenDecoderConfig )

Parameter

  • config (MusicgenDecoderConfig) — Kelas konfigurasi model dengan semua parameter model. Inisialisasi dengan file konfigurasi tidak memuat bobot yang terkait dengan model, hanya konfigurasinya. Lihat metode from_pretrained() untuk memuat bobot model.

Model Musicgen polos yang menghasilkan hidden-states mentah tanpa head spesifik di atasnya.

Model ini mewarisi dari PreTrainedModel. Periksa dokumentasi kelas induk untuk metode generik yang diimplementasikan oleh pustaka untuk semua model (seperti mengunduh atau menyimpan, mengubah ukuran embedding input, memangkas kepala, dll.)

Model ini juga merupakan subclass dari torch.nn.Module PyTorch. Gunakan sebagai PyTorch Module biasa dan merujuk ke dokumentasi PyTorch untuk semua hal yang berkaitan dengan penggunaan dan perilaku umum.

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'> ) → BaseModelOutputWithPastAndCrossAttentions or tuple(torch.Tensor)

Parameter

  • input_ids (torch.LongTensor dengan bentuk (batch_size * num_codebooks, sequence_length)) — Indeks token dari urutan input dalam kosakata, yang sesuai dengan urutan kode audio. Indeks dapat diperoleh dengan mengenkripsi prompt audio menggunakan model encoder audio untuk memprediksi kode audio, seperti dengan EncodecModel. Lihat EncodecModel.encode() untuk detailnya. Apa itu input ID? input_ids akan secara otomatis dikonversi dari bentuk (batch_size * num_codebooks, target_sequence_length) menjadi (batch_size, num_codebooks, target_sequence_length) dalam forward pass. Jika Anda memperoleh kode audio dari model encoding audio, seperti EncodecModel, pastikan bahwa jumlah frame sama dengan 1, dan bahwa Anda mengubah bentuk kode audio dari (frames, batch_size, num_codebooks, target_sequence_length) menjadi (batch_size * num_codebooks, target_sequence_length) sebelum melewatkan mereka sebagai input_ids.

    Indeks dapat diperoleh dengan mengkodekan prompt audio menggunakan model encoder audio untuk memprediksi kode audio, misalnya dengan EncodecModel. Lihat EncodecModel.encode() untuk detailnya.

    Apa itu input ID?

    input_ids akan secara otomatis dikonversi dari bentuk (batch_size * num_codebooks, target_sequence_length) menjadi (batch_size, num_codebooks, target_sequence_length) pada forward pass. Jika Anda memperoleh kode audio dari model pengkodean audio, seperti EncodecModel, pastikan bahwa jumlah frame sama dengan 1, dan bahwa Anda mengubah bentuk kode audio dari (frames, batch_size, num_codebooks, target_sequence_length) menjadi (batch_size * num_codebooks, target_sequence_length) sebelum meneruskannya sebagai input_ids.

  • attention_mask (torch.Tensor dengan bentuk (batch_size, sequence_length), opsional) — Mask untuk menghindari eksekusi attention pada indeks token padding. Nilai mask dipilih dari [0, 1]:
    • 1 untuk token yang tidak dimasker,
    • 0 untuk token yang dimasker.

    Apa itu attention mask?

  • encoder_hidden_states (torch.Tensor dengan bentuk (batch_size, encoder_sequence_length, hidden_size), opsional) — Urutan hidden-states pada keluaran lapisan terakhir encoder. Digunakan dalam cross-attention dari decoder.
  • encoder_attention_mask (torch.LongTensor dengan bentuk (batch_size, encoder_sequence_length), opsional) — Mask untuk menghindari eksekusi cross-attention pada indeks token padding dari encoder input_ids. Nilai mask yang dipilih dalam [0, 1]:
    • 1 untuk token yang tidak dimasker,
    • 0 untuk token yang dimasker.

    Apa itu attention mask?

  • past_key_values (~cache_utils.Cache, opsional) — Hidden-states yang sudah dihitung sebelumnya (key dan values di blok self-attention dan di blok cross-attention) yang dapat digunakan untuk mempercepat decoding berurutan. Ini biasanya terdiri dari past_key_values yang dikembalikan oleh model pada tahap decoding sebelumnya, ketika use_cache=True atau config.use_cache=True.

    Hanya instance Cache yang diizinkan sebagai input, lihat panduan kv cache kami. Jika tidak ada past_key_values yang diteruskan, DynamicCache akan diinisialisasi secara default.

    Model akan menghasilkan format cache yang sama dengan yang diberikan sebagai input.

    Jika past_key_values digunakan, pengguna diharapkan hanya memasukkan input_ids yang belum diproses (yang tidak memiliki state past key value yang diberikan ke model ini) dengan bentuk (batch_size, unprocessed_length) alih-alih semua input_ids dengan bentuk (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor dengan bentuk (batch_size, sequence_length, hidden_size), opsional) — Secara opsional, alih-alih meneruskan input_ids, Anda dapat memilih untuk langsung meneruskan representasi tertanam. Hal ini berguna jika Anda ingin memiliki kendali lebih atas cara mengonversi indeks input_ids menjadi vektor terkait, dibandingkan dengan matriks pencarian penanaman internal model.
  • use_cache (bool, opsional) — Jika diset ke True, state kunci-nilai past_key_values akan dikembalikan dan dapat digunakan untuk mempercepat decoding (lihat past_key_values).

Mengembalikan

BaseModelOutputWithPastAndCrossAttentions atau tuple(torch.Tensor)

A BaseModelOutputWithPastAndCrossAttentions atau tuple dari torch.Tensor (jika return_dict=False dilewatkan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (MusicgenConfig) dan input.

Metode forward dari MusicgenModel menimpa metode khusus __call__.

Meskipun resep untuk forward pass perlu didefinisikan di dalam fungsi ini, sebaiknya panggil instance Module setelahnya alih-alih fungsi ini, karena yang pertama menangani langkah-langkah pra-pemrosesan dan pasca-pemrosesan, sedangkan yang kedua mengabaikannya secara diam-diam.

  • last_hidden_state (torch.Tensor dengan bentuk (batch_size, sequence_length, hidden_size)) — Urutan hidden-states pada keluaran lapisan terakhir model.

    Jika past_key_values digunakan, hanya hidden-state terakhir dari sekuens dengan bentuk (batch_size, 1, hidden_size) yang dioutput.

  • past_key_values (Cache, opsional, dikembalikan saat use_cache=True dilewatkan atau saat config.use_cache=True) — Ini adalah instance Cache. Untuk detail lebih lanjut, lihat panduan kv cache kami.

    Berisi hidden-states yang telah dihitung sebelumnya (key dan values di blok self-attention, dan secara opsional jika config.is_encoder_decoder=True di blok cross-attention) yang dapat digunakan (lihat input past_key_values) untuk mempercepat decoding berurutan.

  • hidden_states (tuple(torch.Tensor), opsional, dikembalikan saat output_hidden_states=True dilewatkan atau saat config.output_hidden_states=True) — Tuple dari torch.Tensor (satu untuk output dari embeddings, jika model memiliki lapisan embedding, + satu untuk output dari setiap lapisan) dengan bentuk (batch_size, sequence_length, hidden_size).

    Hidden-states model pada output setiap layer ditambah output embedding awal yang opsional.

  • attentions (tuple(torch.Tensor), opsional, dikembalikan saat output_attentions=True dilewatkan atau saat config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap layer) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot perhatian setelah softmax perhatian, digunakan untuk menghitung rata-rata berbobot di kepala perhatian diri (self-attention).

  • cross_attentions (tuple(torch.Tensor), opsional, dikembalikan ketika output_attentions=True dan config.add_cross_attention=True diteruskan atau ketika config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap lapisan) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot perhatian dari lapisan cross-attention decoder, setelah softmax perhatian, yang digunakan untuk menghitung rata-rata berbobot di kepala cross-attention.

MusicgenForCausalLM

kelas transformers.MusicgenForCausalLM

< >

( config: MusicgenDecoderConfig )

Parameter

  • config (MusicgenDecoderConfig) — Kelas konfigurasi model dengan semua parameter model. Inisialisasi dengan file konfigurasi tidak memuat bobot yang terkait dengan model, hanya konfigurasinya. Lihat metode from_pretrained() untuk memuat bobot model.

Model decoder MusicGen dengan kepala pemodelan bahasa di atasnya.

Model ini mewarisi dari PreTrainedModel. Periksa dokumentasi kelas induk untuk metode generik yang diimplementasikan oleh pustaka untuk semua model (seperti mengunduh atau menyimpan, mengubah ukuran embedding input, memangkas kepala, dll.)

Model ini juga merupakan subclass dari torch.nn.Module PyTorch. Gunakan sebagai PyTorch Module biasa dan merujuk ke dokumentasi PyTorch untuk semua hal yang berkaitan dengan penggunaan dan perilaku umum.

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] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → CausalLMOutputWithCrossAttentions or tuple(torch.Tensor)

Parameter

  • input_ids (torch.LongTensor dengan bentuk (batch_size * num_codebooks, sequence_length)) — Indeks token dari urutan input dalam kosakata, yang sesuai dengan urutan kode audio. Indeks dapat diperoleh dengan mengenkripsi prompt audio menggunakan model encoder audio untuk memprediksi kode audio, seperti dengan EncodecModel. Lihat EncodecModel.encode() untuk detailnya. Apa itu input ID? input_ids akan secara otomatis dikonversi dari bentuk (batch_size * num_codebooks, target_sequence_length) menjadi (batch_size, num_codebooks, target_sequence_length) dalam forward pass. Jika Anda memperoleh kode audio dari model encoding audio, seperti EncodecModel, pastikan bahwa jumlah frame sama dengan 1, dan bahwa Anda mengubah bentuk kode audio dari (frames, batch_size, num_codebooks, target_sequence_length) menjadi (batch_size * num_codebooks, target_sequence_length) sebelum melewatkan mereka sebagai input_ids.

    Indeks dapat diperoleh dengan mengkodekan prompt audio menggunakan model encoder audio untuk memprediksi kode audio, misalnya dengan EncodecModel. Lihat EncodecModel.encode() untuk detailnya.

    Apa itu input ID?

    input_ids akan secara otomatis dikonversi dari bentuk (batch_size * num_codebooks, target_sequence_length) menjadi (batch_size, num_codebooks, target_sequence_length) pada forward pass. Jika Anda memperoleh kode audio dari model pengkodean audio, seperti EncodecModel, pastikan bahwa jumlah frame sama dengan 1, dan bahwa Anda mengubah bentuk kode audio dari (frames, batch_size, num_codebooks, target_sequence_length) menjadi (batch_size * num_codebooks, target_sequence_length) sebelum meneruskannya sebagai input_ids.

  • attention_mask (torch.Tensor dengan bentuk (batch_size, sequence_length), opsional) — Mask untuk menghindari eksekusi attention pada indeks token padding. Nilai mask dipilih dari [0, 1]:
    • 1 untuk token yang tidak dimasker,
    • 0 untuk token yang dimasker.

    Apa itu attention mask?

  • encoder_hidden_states (torch.Tensor dengan bentuk (batch_size, encoder_sequence_length, hidden_size), opsional) — Urutan hidden-states pada keluaran lapisan terakhir encoder. Digunakan dalam cross-attention dari decoder.
  • encoder_attention_mask (torch.LongTensor dengan bentuk (batch_size, encoder_sequence_length), opsional) — Mask untuk menghindari eksekusi cross-attention pada indeks token padding dari encoder input_ids. Nilai mask yang dipilih dalam [0, 1]:
    • 1 untuk token yang tidak dimasker,
    • 0 untuk token yang dimasker.

    Apa itu attention mask?

  • past_key_values (~cache_utils.Cache, opsional) — Hidden-states yang sudah dihitung sebelumnya (key dan values di blok self-attention dan di blok cross-attention) yang dapat digunakan untuk mempercepat decoding berurutan. Ini biasanya terdiri dari past_key_values yang dikembalikan oleh model pada tahap decoding sebelumnya, ketika use_cache=True atau config.use_cache=True.

    Hanya instance Cache yang diizinkan sebagai input, lihat panduan kv cache kami. Jika tidak ada past_key_values yang diteruskan, DynamicCache akan diinisialisasi secara default.

    Model akan menghasilkan format cache yang sama dengan yang diberikan sebagai input.

    Jika past_key_values digunakan, pengguna diharapkan hanya memasukkan input_ids yang belum diproses (yang tidak memiliki state past key value yang diberikan ke model ini) dengan bentuk (batch_size, unprocessed_length) alih-alih semua input_ids dengan bentuk (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor dengan bentuk (batch_size, sequence_length, hidden_size), opsional) — Secara opsional, alih-alih meneruskan input_ids, Anda dapat memilih untuk langsung meneruskan representasi tertanam. Hal ini berguna jika Anda ingin memiliki kendali lebih atas cara mengonversi indeks input_ids menjadi vektor terkait, dibandingkan dengan matriks pencarian penanaman internal model.
  • labels (torch.LongTensor dengan bentuk (batch_size, sequence_length, num_codebooks), opsional) — Label untuk pemodelan bahasa. Perhatikan bahwa label digeser di dalam model, yaitu Anda dapat mengatur labels = input_ids Indeks dipilih dari [-100, 0, ..., config.vocab_size] Semua label yang diatur ke -100 diabaikan (dipertahankan), loss hanya dihitung untuk label dalam [0, ..., config.vocab_size]
  • use_cache (bool, opsional) — Jika diset ke True, state kunci-nilai past_key_values akan dikembalikan dan dapat digunakan untuk mempercepat decoding (lihat past_key_values).

Mengembalikan

CausalLMOutputWithCrossAttentions atau tuple(torch.Tensor)

A CausalLMOutputWithCrossAttentions atau tuple dari torch.Tensor (jika return_dict=False dilewatkan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (MusicgenConfig) dan input.

Metode forward dari MusicgenForCausalLM menimpa metode khusus __call__.

Meskipun resep untuk forward pass perlu didefinisikan di dalam fungsi ini, sebaiknya panggil instance Module setelahnya alih-alih fungsi ini, karena yang pertama menangani langkah-langkah pra-pemrosesan dan pasca-pemrosesan, sedangkan yang kedua mengabaikannya secara diam-diam.

  • loss (torch.Tensor dengan bentuk (1,), opsional, dikembalikan saat labels disediakan) — Loss pemodelan bahasa (untuk prediksi token berikutnya).

  • logits (torch.Tensor dengan bentuk (batch_size, sequence_length, config.vocab_size)) — Skor prediksi dari kepala pemodelan bahasa (skor untuk setiap token kosakata sebelum SoftMax).

  • hidden_states (tuple(torch.Tensor), opsional, dikembalikan saat output_hidden_states=True dilewatkan atau saat config.output_hidden_states=True) — Tuple dari torch.Tensor (satu untuk output dari embeddings, jika model memiliki lapisan embedding, + satu untuk output dari setiap lapisan) dengan bentuk (batch_size, sequence_length, hidden_size).

    Hidden-states model pada output setiap layer ditambah output embedding awal yang opsional.

  • attentions (tuple(torch.Tensor), opsional, dikembalikan saat output_attentions=True dilewatkan atau saat config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap layer) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot perhatian setelah softmax perhatian, digunakan untuk menghitung rata-rata berbobot di kepala perhatian diri (self-attention).

  • cross_attentions (tuple(torch.Tensor), opsional, dikembalikan saat output_attentions=True dilewatkan atau saat config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap layer) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot cross attention setelah softmax attention, digunakan untuk menghitung rata-rata berbobot di kepala cross-attention.

  • past_key_values (Cache, opsional, dikembalikan saat use_cache=True dilewatkan atau saat config.use_cache=True) — Ini adalah instance Cache. Untuk detail lebih lanjut, lihat panduan kv cache kami.

    Berisi hidden-states yang telah dihitung sebelumnya (key dan values di blok attention) yang dapat digunakan (lihat input past_key_values) untuk mempercepat decoding berurutan.

Contoh:

MusicgenForConditionalGeneration

kelas transformers.MusicgenForConditionalGeneration

< >

( config: transformers.models.musicgen.configuration_musicgen.MusicgenConfig | None = Nonetext_encoder: transformers.modeling_utils.PreTrainedModel | None = Noneaudio_encoder: transformers.modeling_utils.PreTrainedModel | None = Nonedecoder: transformers.models.musicgen.modeling_musicgen.MusicgenForCausalLM | None = None )

Parameter

  • config (MusicgenConfig, opsional) — Kelas konfigurasi model dengan semua parameter model. Inisialisasi dengan file konfigurasi tidak memuat bobot yang terkait dengan model, hanya konfigurasinya. Lihat metode from_pretrained() untuk memuat bobot model.
  • text_encoder (PreTrainedModel, opsional) — Model text encoder yang mengodekan teks menjadi hidden states untuk kondisioning.
  • audio_encoder (PreTrainedModel, opsional) — Model audio encoder yang mengkodekan audio menjadi hidden states untuk conditioning.
  • decoder (MusicgenForCausalLM, opsional) — Model decoder yang menghasilkan token audio berdasarkan sinyal kondisioning.

Model komposit MusicGen dengan encoder teks, encoder audio, dan decoder Musicgen,

Model ini mewarisi dari PreTrainedModel. Periksa dokumentasi kelas induk untuk metode generik yang diimplementasikan oleh pustaka untuk semua model (seperti mengunduh atau menyimpan, mengubah ukuran embedding input, memangkas kepala, dll.)

Model ini juga merupakan subclass dari torch.nn.Module PyTorch. Gunakan sebagai PyTorch Module biasa dan merujuk ke dokumentasi PyTorch untuk semua hal yang berkaitan dengan penggunaan dan perilaku umum.

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.BoolTensor] = Noneinput_values: typing.Optional[torch.Tensor] = Nonepadding_mask: typing.Optional[torch.BoolTensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_attention_mask: typing.Optional[torch.BoolTensor] = Noneencoder_outputs: tuple[torch.Tensor] | None = Nonepast_key_values: transformers.cache_utils.Cache | None = 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'> ) → Seq2SeqLMOutput or tuple(torch.Tensor)

Parameter

  • input_ids (torch.LongTensor dengan bentuk (batch_size, sequence_length), opsional) — Indeks token dari urutan input dalam kosakata. Padding akan diabaikan secara default.

    Indeks dapat diperoleh menggunakan AutoTokenizer. Lihat PreTrainedTokenizer.encode() dan PreTrainedTokenizer.call() untuk detailnya.

    Apa itu input ID?

  • attention_mask (torch.BoolTensor dengan bentuk (batch_size, sequence_length), opsional) — Mask untuk menghindari eksekusi attention pada indeks token padding. Nilai mask dipilih dari [0, 1]:
    • 1 untuk token yang tidak dimasker,
    • 0 untuk token yang dimasker.

    Apa itu attention mask?

  • input_values (torch.Tensor dengan bentuk (batch_size, sequence_length), opsional) — Nilai float dari waveform ucapan mentah input. Nilai dapat diperoleh dengan memuat file audio .flac atau .wav ke dalam array bertipe list[float], numpy.ndarray atau torch.Tensor, misalnya melalui pustaka torchcodec (pip install torchcodec) atau pustaka soundfile (pip install soundfile). Untuk menyiapkan array menjadi input_values, gunakan AutoProcessor untuk padding dan konversi menjadi tensor bertipe torch.Tensor. Lihat MusicgenProcessor.call() untuk detailnya.
  • padding_mask (torch.BoolTensor dengan bentuk (batch_size, sequence_length), opsional) — Mask untuk menghindari eksekusi attention pada indeks token padding. Nilai mask dipilih dari [0, 1]:
    • 1 untuk token yang tidak dimasker,
    • 0 untuk token yang dimasker.

    Apa itu attention mask?

  • decoder_input_ids (torch.LongTensor dengan bentuk (batch_size * num_codebooks, target_sequence_length), opsional) — Indeks token dari urutan input decoder dalam kosakata, yang sesuai dengan urutan kode audio. Indeks dapat diperoleh dengan mengenkripsi prompt audio menggunakan model encoder audio untuk memprediksi kode audio, seperti dengan EncodecModel. Lihat EncodecModel.encode() untuk detailnya. Apa itu decoder input ID? decoder_input_ids akan secara otomatis dikonversi dari bentuk (batch_size * num_codebooks, target_sequence_length) menjadi (batch_size, num_codebooks, target_sequence_length) dalam forward pass. Jika Anda memperoleh kode audio dari model encoding audio, seperti EncodecModel, pastikan bahwa jumlah frame sama dengan 1, dan bahwa Anda mengubah bentuk kode audio dari (frames, batch_size, num_codebooks, target_sequence_length) menjadi (batch_size * num_codebooks, target_sequence_length) sebelum melewatkan mereka sebagai decoder_input_ids.

    Indeks dapat diperoleh dengan mengkodekan prompt audio menggunakan model encoder audio untuk memprediksi kode audio, misalnya dengan EncodecModel. Lihat EncodecModel.encode() untuk detailnya.

    Apa itu ID input decoder?

    decoder_input_ids akan secara otomatis dikonversi dari bentuk (batch_size * num_codebooks, target_sequence_length) menjadi (batch_size, num_codebooks, target_sequence_length) pada forward pass. Jika Anda memperoleh kode audio dari model pengkodean audio, seperti EncodecModel, pastikan bahwa jumlah frame sama dengan 1, dan bahwa Anda mengubah bentuk kode audio dari (frames, batch_size, num_codebooks, target_sequence_length) menjadi (batch_size * num_codebooks, target_sequence_length) sebelum meneruskannya sebagai decoder_input_ids.

  • decoder_attention_mask (torch.LongTensor dengan bentuk (batch_size, target_sequence_length), opsional) — Perilaku default: menghasilkan tensor yang mengabaikan token pad di decoder_input_ids. Causal mask juga akan digunakan secara default.
  • encoder_outputs (tuple[torch.Tensor], opsional) — Tuple terdiri dari (last_hidden_state, opsional: hidden_states, opsional: attentions) last_hidden_state dengan bentuk (batch_size, sequence_length, hidden_size), opsional) adalah rangkaian hidden-states pada keluaran lapisan terakhir encoder. Digunakan dalam cross-attention decoder.
  • past_key_values (~cache_utils.Cache, opsional) — Hidden-states yang sudah dihitung sebelumnya (key dan values di blok self-attention dan di blok cross-attention) yang dapat digunakan untuk mempercepat decoding berurutan. Ini biasanya terdiri dari past_key_values yang dikembalikan oleh model pada tahap decoding sebelumnya, ketika use_cache=True atau config.use_cache=True.

    Hanya instance Cache yang diizinkan sebagai input, lihat panduan kv cache kami. Jika tidak ada past_key_values yang diteruskan, DynamicCache akan diinisialisasi secara default.

    Model akan menghasilkan format cache yang sama dengan yang diberikan sebagai input.

    Jika past_key_values digunakan, pengguna diharapkan hanya memasukkan input_ids yang belum diproses (yang tidak memiliki state past key value yang diberikan ke model ini) dengan bentuk (batch_size, unprocessed_length) alih-alih semua input_ids dengan bentuk (batch_size, sequence_length).

  • inputs_embeds (torch.Tensor dengan bentuk (batch_size, sequence_length, hidden_size), opsional) — Secara opsional, alih-alih meneruskan input_ids, Anda dapat memilih untuk langsung meneruskan representasi tertanam. Hal ini berguna jika Anda ingin memiliki kendali lebih atas cara mengonversi indeks input_ids menjadi vektor terkait, dibandingkan dengan matriks pencarian penanaman internal model.
  • decoder_inputs_embeds (torch.Tensor dengan bentuk (batch_size, target_sequence_length, hidden_size), opsional) — Secara opsional, alih-alih meneruskan decoder_input_ids Anda dapat memilih untuk langsung meneruskan representasi tertanam. Jika past_key_values digunakan, secara opsional hanya decoder_inputs_embeds yang perlu dimasukkan (lihat past_key_values). Ini berguna jika Anda ingin lebih banyak kendali atas cara mengonversi decoder_input_ids indeks menjadi vektor terkait daripada matriks pencarian embedding internal model.

    Jika decoder_input_ids dan decoder_inputs_embeds keduanya tidak disetel, decoder_inputs_embeds mengambil nilai dari inputs_embeds.

  • labels (torch.LongTensor dengan bentuk (batch_size, sequence_length, num_codebooks), opsional) — Label untuk pemodelan bahasa. Perhatikan bahwa label digeser di dalam model, yaitu Anda dapat mengatur labels = input_ids Indeks dipilih dari [-100, 0, ..., config.vocab_size] Semua label yang diatur ke -100 diabaikan (dipertahankan), loss hanya dihitung untuk label dalam [0, ..., config.vocab_size]
  • use_cache (bool, opsional) — Jika diset ke True, state kunci-nilai past_key_values akan dikembalikan dan dapat digunakan untuk mempercepat decoding (lihat past_key_values).

Mengembalikan

Seq2SeqLMOutput atau tuple(torch.Tensor)

A Seq2SeqLMOutput atau tuple dari torch.Tensor (jika return_dict=False dilewatkan atau ketika config.return_dict=False) yang terdiri dari berbagai elemen tergantung pada konfigurasi (MusicgenConfig) dan input.

Metode forward dari MusicgenForConditionalGeneration menimpa metode khusus __call__.

Meskipun resep untuk forward pass perlu didefinisikan di dalam fungsi ini, sebaiknya panggil instance Module setelahnya alih-alih fungsi ini, karena yang pertama menangani langkah-langkah pra-pemrosesan dan pasca-pemrosesan, sedangkan yang kedua mengabaikannya secara diam-diam.

  • loss (torch.Tensor dengan bentuk (1,), opsional, dikembalikan saat labels disediakan) — Loss pemodelan bahasa.

  • logits (torch.Tensor dengan bentuk (batch_size, sequence_length, config.vocab_size)) — Skor prediksi dari kepala pemodelan bahasa (skor untuk setiap token kosakata sebelum SoftMax).

  • past_key_values (EncoderDecoderCache, opsional, dikembalikan ketika use_cache=True diteruskan atau ketika config.use_cache=True) — Ini adalah instance EncoderDecoderCache. Untuk detail lebih lanjut, lihat panduan kv cache kami.

    Mengandung hidden-states yang telah dihitung sebelumnya (key dan values di blok self-attention dan di blok cross-attention) yang dapat digunakan (lihat input past_key_values) untuk mempercepat decoding berurutan.

  • decoder_hidden_states (tuple(torch.Tensor), opsional, dikembalikan saat output_hidden_states=True dilewatkan atau saat config.output_hidden_states=True) — Tuple dari torch.Tensor (satu untuk output dari embeddings, jika model memiliki lapisan embedding, + satu untuk output dari setiap lapisan) dengan bentuk (batch_size, sequence_length, hidden_size).

    Hidden-states dari decoder pada output setiap layer ditambah output embedding awal.

  • decoder_attentions (tuple(torch.Tensor), opsional, dikembalikan saat output_attentions=True dilewatkan atau saat config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap lapisan) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot perhatian dari decoder, setelah softmax perhatian, yang digunakan untuk menghitung rata-rata berbobot di kepala self-attention.

  • cross_attentions (tuple(torch.Tensor), opsional, dikembalikan saat output_attentions=True dilewatkan atau saat config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap layer) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot perhatian dari lapisan cross-attention decoder, setelah softmax perhatian, yang digunakan untuk menghitung rata-rata berbobot di kepala cross-attention.

  • encoder_last_hidden_state (torch.Tensor dengan bentuk (batch_size, sequence_length, hidden_size), opsional) — Urutan hidden-states pada keluaran lapisan terakhir dari encoder model.

  • encoder_hidden_states (tuple(torch.Tensor), opsional, dikembalikan ketika output_hidden_states=True dilewatkan atau ketika config.output_hidden_states=True) — Tuple dari torch.Tensor (satu untuk output dari embeddings, jika model memiliki lapisan embedding, + satu untuk output dari setiap lapisan) dengan bentuk (batch_size, sequence_length, hidden_size).

    Hidden-states dari encoder pada output setiap layer ditambah output embedding awal.

  • encoder_attentions (tuple(torch.Tensor), opsional, dikembalikan saat output_attentions=True dilewatkan atau saat config.output_attentions=True) — Tuple dari torch.Tensor (satu untuk setiap lapisan) dengan bentuk (batch_size, num_heads, sequence_length, sequence_length).

    Bobot perhatian dari encoder, setelah softmax perhatian, yang digunakan untuk menghitung rata-rata berbobot di kepala self-attention.

Contoh:

>>> from transformers import AutoProcessor, MusicgenForConditionalGeneration
>>> import torch

>>> processor = AutoProcessor.from_pretrained("facebook/musicgen-small")
>>> model = MusicgenForConditionalGeneration.from_pretrained("facebook/musicgen-small")

>>> 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, tgt_len, vocab_size)
torch.Size([8, 1, 2048])
Update on GitHub

←MOSS-Transcribe-Diarize MusicGen Melody→