# MusicGen Melody

## Ikhtisar

Model MusicGen Melody diusulkan dalam [Simple and Controllable Music Generation](https://huggingface.co/papers/2306.05284) oleh Jade Copet, Felix Kreuk, Itai Gat, Tal Remez, David Kant, Gabriel Synnaeve, Yossi Adi, dan Alexandre Défossez.

MusicGen Melody 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 bersama dengan pola penginterleaving token yang efisien, yang menghilangkan kebutuhan untuk mengascade beberapa model, misalnya secara hierarkis atau upsampling. Dengan mengikuti pendekatan ini, kami mendemonstrasikan bagaimana MusicGen dapat menghasilkan sampel berkualitas tinggi, sementara dikondisikan pada deskripsi teks atau fitur melodi, memungkinkan kontrol yang lebih baik atas output yang dihasilkan. Kami melakukan evaluasi empiris yang luas, mempertimbangkan baik studi otomatis maupun studi manusia, 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 [ylacombe](https://huggingface.co/ylacombe). Kode aslinya dapat ditemukan [di sini](https://github.com/facebookresearch/audiocraft). Checkpoint yang telah dilatih sebelumnya dapat ditemukan di [Hugging Face Hub](https://huggingface.co/models?sort=downloads&search=facebook%2Fmusicgen).

## Perbedaan dengan [MusicGen](./musicgen)

Ada dua perbedaan utama dengan MusicGen:

1. Prompt audio digunakan di sini sebagai sinyal kondisional untuk sampel audio yang dihasilkan, sedangkan pada [MusicGen](./musicgen) prompt tersebut digunakan untuk kelanjutan audio.
2. Sinyal teks dan audio kondisional digabungkan ke hidden states decoder, bukan digunakan sebagai sinyal cross-attention, seperti pada MusicGen.

## Generasi

MusicGen Melody 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 panggilan ke `MusicgenMelodyForConditionalGeneration.generate()`, atau dengan menimpa konfigurasi generasi model (lihat di bawah).

Transformers mendukung varian mono (1 kanal) dan stereo (2 kanal) dari MusicGen Melody. 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 Kondisional Audio

Model dapat menghasilkan sampel audio yang dikondisikan oleh teks dan prompt audio melalui penggunaan [MusicgenMelodyProcessor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyProcessor) untuk memproses awal input.

Pada contoh berikut, kami memuat file audio menggunakan pustaka 🤗 Datasets, yang dapat diinstal melalui pip dengan perintah di bawah ini:

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

File audio yang akan kami gunakan dimuat sebagai berikut:

```python
from datasets import load_dataset

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

Prompt audio sebaiknya idealnya bebas dari sinyal frekuensi rendah yang biasanya dihasilkan oleh instrumen seperti drum dan bas. Model [Demucs](https://github.com/adefossez/demucs/tree/main) dapat digunakan untuk memisahkan vokal dan sinyal lainnya dari komponen drum dan bas.

Jika Anda ingin menggunakan Demucs, Anda perlu mengikuti langkah instalasi [di sini](https://github.com/adefossez/demucs/tree/main?tab=readme-ov-file#for-musicians) terlebih dahulu sebelum menggunakan potongan kode berikut:

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

Anda kemudian dapat menggunakan potongan kode berikut untuk menghasilkan musik:

```python
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)
```

Anda juga dapat meneruskan sinyal audio secara langsung tanpa menggunakan Demucs, meskipun kualitas generasi kemungkinan akan menurun:

```python
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)
```

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:

```python
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 `soundfile`:

```python
import soundfile as sf

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

### Generasi Kondisional Berbasis Teks

[MusicgenMelodyProcessor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyProcessor) yang sama dapat digunakan untuk memproses awal prompt yang hanya berisi teks.

```python
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)
```

`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).

Anda juga dapat menghasilkan dalam batch:

```python

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

### Generasi Tanpa Syarat

Input untuk generasi tanpa syarat (atau 'null') dapat diperoleh melalui metode [MusicgenMelodyProcessor.get_unconditional_inputs()](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyProcessor.get_unconditional_inputs):

```python
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)
```

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

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

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 Melody decoder: model bahasa (LM) yang menghasilkan token audio (atau kode) secara auto-regresif bersyarat pada representasi hidden-state dari encoder
3. Audio decoder: digunakan untuk memulihkan gelombang audio dari token audio yang diprediksi oleh decoder.

Dengan demikian, model MusicGen dapat digunakan sebagai model decoder mandiri, yang sesuai dengan kelas [MusicgenMelodyForCausalLM](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyForCausalLM), atau sebagai model komposit yang mencakup text encoder dan audio encoder, yang sesuai dengan kelas [MusicgenMelodyForConditionalGeneration](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyForConditionalGeneration). 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:

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

Karena model text encoder dan audio encoder dibekukan selama pelatihan, decoder MusicGen [MusicgenMelodyForCausalLM](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyForCausalLM) 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 yang dibekukan untuk memulihkan model komposit [MusicgenMelodyForConditionalGeneration](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyForConditionalGeneration).

## Konversi Checkpoint

- Setelah mengunduh checkpoint asli dari [sini](https://github.com/facebookresearch/audiocraft/blob/main/docs/MUSICGEN.md#importing--exporting-models), Anda dapat mengonversinya menggunakan **skrip konversi** yang tersedia di `src/transformers/models/musicgen_melody/convert_musicgen_melody_transformers.py` dengan perintah berikut:

```bash
python src/transformers/models/musicgen_melody/convert_musicgen_melody_transformers.py \
    --checkpoint="facebook/musicgen-melody" --pytorch_dump_folder /output/path 
```

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 `MusicgenMelodyForConditionalGeneration.generate()`

## MusicgenMelodyDecoderConfig[[transformers.MusicgenMelodyDecoderConfig]]

#### transformers.MusicgenMelodyDecoderConfig[[transformers.MusicgenMelodyDecoderConfig]]

```python
transformers.MusicgenMelodyDecoderConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, vocab_size: int = 2048, max_position_embeddings: int = 2048, num_hidden_layers: int = 24, ffn_dim: int = 4096, num_attention_heads: int = 16, layerdrop: float | int = 0.0, use_cache: bool = True, activation_function: str = 'gelu', hidden_size: int = 1024, dropout: float | int = 0.1, attention_dropout: float | int = 0.0, activation_dropout: float | int = 0.0, initializer_factor: float = 0.02, scale_embedding: bool = False, num_codebooks: int = 4, audio_channels: int = 1, pad_token_id: int | None = 2048, bos_token_id: int | None = 2048, eos_token_id: int | list[int] | None = None, tie_word_embeddings: bool = False, is_decoder: bool = False, add_cross_attention: bool = False)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/configuration_musicgen_melody.py#L28)

**Parameter:**

vocab_size (`int`, *opsional*, defaultnya `2048`) : Ukuran kosakata model. Menentukan jumlah token berbeda yang dapat direpresentasikan oleh `input_ids`.

max_position_embeddings (`int`, *opsional*, defaultnya `2048`) : Panjang urutan maksimum yang mungkin digunakan oleh model ini.

num_hidden_layers (`int`, *opsional*, defaultnya `24`) : Jumlah lapisan tersembunyi dalam decoder Transformer.

ffn_dim (`int`, *opsional*, defaultnya `4096`) : Dimensi dari representasi MLP.

num_attention_heads (`int`, *opsional*, defaultnya `16`) : Jumlah kepala perhatian untuk setiap lapisan perhatian dalam decoder Transformer.

layerdrop (`Union[float, int]`, *opsional*, defaultnya `0.0`) : Probabilitas LayerDrop. Lihat [makalah LayerDrop](see 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*, defaultnya `1024`) : Dimensi dari representasi tersembunyi.

dropout (`Union[float, int]`, *opsional*, defaultnya `0.1`) : Rasio untuk semua lapisan dropout.

attention_dropout (`Union[float, int]`, *opsional*, defaultnya `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*, default `0.02`) : Faktor untuk menginisialisasi semua matriks bobot (sebaiknya dipertahankan pada 1, digunakan secara internal untuk pengujian inisialisasi).

scale_embedding (`bool`, *opsional*, defaultnya `False`) : Apakah akan menskalakan embedding dengan membaginya oleh sqrt(d_model).

num_codebooks (`int`, *opsional*, defaultnya `4`) : Jumlah codebook paralel yang digunakan oleh model.

audio_channels (`int`, *opsional*, default 1) : Jumlah kanal audio yang digunakan oleh model (mono atau stereo). Model stereo menghasilkan aliran audio terpisah untuk kanal keluaran kiri/kanan. Model mono menghasilkan satu aliran keluaran audio.

pad_token_id (`int`, *opsional*, defaultnya `2048`) : Token id yang digunakan untuk padding dalam kosakata.

bos_token_id (`int`, *opsional*, defaultnya `2048`) : Token id yang digunakan untuk awal-stream dalam kosakata.

eos_token_id (`Union[int, list[int]]`, *opsional*) : Token id yang digunakan untuk end-of-stream dalam kosakata.

tie_word_embeddings (`bool`, *opsional*, defaultnya `False`) : Apakah mengikat embedding bobot sesuai dengan pemetaan `tied_weights_keys` model.

is_decoder (`bool`, *opsional*, defaultnya `False`) : Apakah model digunakan sebagai decoder atau tidak. Jika `False`, model digunakan sebagai encoder.

add_cross_attention (`bool`, *opsional*, defaultnya `False`) : Apakah lapisan cross-attention harus ditambahkan ke model.

Ini adalah kelas konfigurasi untuk menyimpan konfigurasi dari MusicgenMelodyModel. Kelas ini digunakan untuk membuat instans model Musicgen Melody 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-melody](https://huggingface.co/facebook/musicgen-melody)

Objek konfigurasi mewarisi dari [PreTrainedConfig](/docs/transformers/main/id/main_classes/configuration#transformers.PreTrainedConfig) dan dapat digunakan untuk mengontrol keluaran model. Baca dokumentasi dari [PreTrainedConfig](/docs/transformers/main/id/main_classes/configuration#transformers.PreTrainedConfig) untuk informasi lebih lanjut.

## MusicgenMelodyProcessor[[transformers.MusicgenMelodyProcessor]]

#### transformers.MusicgenMelodyProcessor[[transformers.MusicgenMelodyProcessor]]

```python
transformers.MusicgenMelodyProcessor(feature_extractor, tokenizer)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/processing_musicgen_melody.py#L29)

**Parameter:**

feature_extractor (`MusicgenMelodyFeatureExtractor`) : Ekstraktor fitur adalah input yang wajib.

tokenizer (`T5Tokenizer`) : Tokenizer adalah input yang wajib.

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

[MusicgenMelodyProcessor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyProcessor) menyediakan semua fungsionalitas dari [MusicgenMelodyFeatureExtractor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyFeatureExtractor) dan [T5Tokenizer](/docs/transformers/main/id/model_doc/t5#transformers.T5Tokenizer). Lihat [~MusicgenMelodyFeatureExtractor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyFeatureExtractor) dan [~T5Tokenizer](/docs/transformers/main/id/model_doc/t5#transformers.T5Tokenizer) untuk informasi lebih lanjut.

#### __call__[[transformers.MusicgenMelodyProcessor.__call__]]

```python
__call__(*args, **kwargs)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/processing_musicgen_melody.py#L37)

**Parameter:**

return_tensors (`str` atau [TensorType](/docs/transformers/main/id/internal/file_utils#transformers.TensorType), *opsional*) : Jika diatur, akan mengembalikan tensor dari framework tertentu. Nilai yang dapat diterima adalah:  - `'pt'`: Mengembalikan objek `torch.Tensor` PyTorch. - `'np'`: Mengembalikan objek `np.ndarray` NumPy.

#### get_unconditional_inputs[[transformers.MusicgenMelodyProcessor.get_unconditional_inputs]]

```python
get_unconditional_inputs(num_samples = 1, return_tensors = 'pt')
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/processing_musicgen_melody.py#L90)

**Parameter:**

num_samples (int, *opsional*) : Jumlah sampel audio yang akan dihasilkan secara tidak bersyarat.

Fungsi bantu untuk mendapatkan input null untuk generasi tanpa syarat, memungkinkan model digunakan tanpa feature extractor atau tokenizer.

Contoh:
```python
>>> 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[[transformers.MusicgenMelodyFeatureExtractor]]

#### transformers.MusicgenMelodyFeatureExtractor[[transformers.MusicgenMelodyFeatureExtractor]]

```python
transformers.MusicgenMelodyFeatureExtractor(feature_size = 12, sampling_rate = 32000, hop_length = 4096, chunk_length = 30, n_fft = 16384, num_chroma = 12, padding_value = 0.0, return_attention_mask = False, stem_indices = [3, 2], **kwargs)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/feature_extraction_musicgen_melody.py#L40)

**Parameter:**

feature_size (`int`, *opsional*, default 12) : Dimensi fitur dari fitur yang diekstrak.

sampling_rate (`int`, *opsional*, default 32000) : Laju sampling di mana file audio harus didigitalisasi, dinyatakan dalam hertz (Hz).

hop_length (`int`, *opsional*, default 4096) : Panjang jendela yang tumpang tindih untuk STFT yang digunakan untuk memperoleh koefisien Frekuensi Mel.

chunk_length (`int`, *opsional*, default 30) : Jumlah maksimum chunk berisi `sampling_rate` sampel yang digunakan untuk memangkas dan mengisi (padding) urutan audio yang lebih panjang atau lebih pendek.

n_fft (`int`, *opsional*, default 16384) : Ukuran transformasi Fourier.

num_chroma (`int`, *opsional*, default 12) : Jumlah bin kroma yang akan digunakan.

padding_value (`float`, *opsional*, default 0.0) : Nilai padding yang digunakan untuk mengisi audio.

return_attention_mask (`bool`, *opsional*, defaultnya `False`) : Apakah akan mengembalikan attention mask. Dapat ditimpa saat memanggil feature extractor.  [Apa itu attention mask?](../glossary#attention-mask)    Untuk model Whisper, `attention_mask` harus selalu diteruskan untuk inferensi batched, untuk menghindari bug halus.

stem_indices (`list[int]`, *opsional*, default `[3, 2]`) : Kanal stem yang akan diekstrak jika output demucs diberikan.

Membangun ekstraktor fitur MusicgenMelody.

Feature extractor ini mewarisi dari [SequenceFeatureExtractor](/docs/transformers/main/id/main_classes/feature_extractor#transformers.SequenceFeatureExtractor) yang berisi sebagian besar metode utama. Pengguna harus merujuk ke superclass ini untuk informasi lebih lanjut mengenai metode-metode tersebut.

Kelas ini mengekstrak fitur kroma dari audio yang diproses oleh [Demucs](https://github.com/adefossez/demucs/tree/main) atau langsung dari gelombang audio mentah.

## MusicgenMelodyConfig[[transformers.MusicgenMelodyConfig]]

#### transformers.MusicgenMelodyConfig[[transformers.MusicgenMelodyConfig]]

```python
transformers.MusicgenMelodyConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, text_encoder: dict | transformers.configuration_utils.PreTrainedConfig | None = None, audio_encoder: dict | transformers.configuration_utils.PreTrainedConfig | None = None, decoder: dict | transformers.configuration_utils.PreTrainedConfig | None = None, num_chroma: int = 12, chroma_length: int = 235, initializer_factor: float = 0.02)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/configuration_musicgen_melody.py#L86)

**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 encoder audio.

decoder (`Union[dict, `PretrainedConfig`]`) : Instans dari objek konfigurasi yang mendefinisikan konfigurasi decoder.

num_chroma (`int`, *opsional*, default 12) : Jumlah bin kroma yang akan digunakan.

chroma_length (`int`, *opsional*, default 235) : Durasi maksimum kroma jika audio digunakan untuk mengondisikan model. Bersesuaian dengan durasi maksimum yang digunakan selama pelatihan.

initializer_factor (`float`, *opsional*, default `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 MusicgenMelodyModel. Kelas ini digunakan untuk membuat instans model Musicgen Melody 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-melody](https://huggingface.co/facebook/musicgen-melody)

Objek konfigurasi mewarisi dari [PreTrainedConfig](/docs/transformers/main/id/main_classes/configuration#transformers.PreTrainedConfig) dan dapat digunakan untuk mengontrol keluaran model. Baca dokumentasi dari [PreTrainedConfig](/docs/transformers/main/id/main_classes/configuration#transformers.PreTrainedConfig) untuk informasi lebih lanjut.

Contoh:

```python
>>> 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[[transformers.MusicgenMelodyModel]]

#### transformers.MusicgenMelodyModel[[transformers.MusicgenMelodyModel]]

```python
transformers.MusicgenMelodyModel(config: MusicgenMelodyDecoderConfig)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/modeling_musicgen_melody.py#L539)

**Parameter:**

config ([MusicgenMelodyDecoderConfig](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyDecoderConfig)) : Kelas konfigurasi model dengan semua parameter model. Inisialisasi dengan file konfigurasi tidak memuat bobot yang terkait dengan model, hanya konfigurasinya. Lihat metode [from_pretrained()](/docs/transformers/main/id/main_classes/model#transformers.PreTrainedModel.from_pretrained) untuk memuat bobot model.

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

Model ini mewarisi dari [PreTrainedModel](/docs/transformers/main/id/main_classes/model#transformers.PreTrainedModel). Periksa dokumentasi kelas induk untuk metode generik yang diimplementasikan oleh pustaka ini untuk semua model (seperti mengunduh atau menyimpan, mengubah ukuran input embeddings, memangkas heads, dll.)

Model ini juga merupakan subclass dari [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#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[[transformers.MusicgenMelodyModel.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, encoder_hidden_states: typing.Optional[torch.Tensor] = None, encoder_attention_mask: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/modeling_musicgen_melody.py#L552)

**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](/docs/transformers/main/id/model_doc/encodec#transformers.EncodecModel). Lihat [EncodecModel.encode()](/docs/transformers/main/id/model_doc/encodec#transformers.EncodecModel.encode) untuk detailnya. [Apa itu input IDs?](../glossary#input-ids) `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 encoding audio, seperti [EncodecModel](/docs/transformers/main/id/model_doc/encodec#transformers.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`.

attention_mask (`torch.Tensor` dengan bentuk `(batch_size, sequence_length)`, *opsional*) : Mask untuk menghindari pelaksanaan attention pada indeks token padding. Nilai mask dipilih dalam `[0, 1]`:  - 1 untuk token yang **tidak di-mask**, - 0 untuk token yang **di-mask**.  [Apa itu attention masks?](../glossary#attention-mask)

encoder_hidden_states (`torch.Tensor` dengan bentuk `(batch_size, encoder_sequence_length, hidden_size)`, *opsional*) : Urutan hidden-states yang merepresentasikan penggabungan (concatenation) dari output text encoder dan output audio encoder yang telah diproses. Digunakan sebagai sinyal kondisional sehingga akan digabungkan dengan `decoder_input_ids` yang telah diproyeksikan.

encoder_attention_mask (`torch.LongTensor` dengan bentuk `(batch_size, encoder_sequence_length)`, *opsional*) : Mask untuk menghindari pelaksanaan perhatian pada state tersembunyi kondisional. Nilai mask dipilih dalam `[0, 1]`:  - 1 untuk token yang **tidak dimask**, - 0 untuk token yang **dimask**.  [Apa itu attention mask?](../glossary#attention-mask)

past_key_values (`~cache_utils.Cache`, *opsional*) : Hidden-states yang telah 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](/docs/transformers/main/id/internal/generation_utils#transformers.Cache) yang diizinkan sebagai input, lihat [panduan kv cache](https://huggingface.co/docs/transformers/en/kv_cache) kami. Jika tidak ada `past_key_values` yang diteruskan, [DynamicCache](/docs/transformers/main/id/internal/generation_utils#transformers.DynamicCache) akan diinisialisasi secara default. Model akan mengoutput format cache yang sama dengan yang diberikan sebagai input. Jika `past_key_values` digunakan, pengguna diharapkan untuk hanya menginput `input_ids` yang belum diproses (yang tidak memiliki state past key value mereka 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. Ini berguna jika Anda ingin lebih banyak kendali atas cara mengonversi indeks `input_ids` menjadi vektor terkait daripada matriks pencarian penanaman internal model.

use_cache (`bool`, *opsional*) : Jika diatur ke `True`, state kunci-nilai `past_key_values` akan dikembalikan dan dapat digunakan untuk mempercepat decoding (lihat `past_key_values`).

**Mengembalikan:** [BaseModelOutputWithPast](/docs/transformers/main/id/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPast) atau `tuple(torch.Tensor)`

[BaseModelOutputWithPast](/docs/transformers/main/id/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPast) atau tuple dari `torch.Tensor` (jika `return_dict=False` diteruskan atau ketika `config.return_dict=False`) yang terdiri dari berbagai elemen tergantung pada konfigurasi (`None`) dan input.

Metode forward dari [MusicgenMelodyModel](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyModel) 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](/docs/transformers/main/id/internal/generation_utils#transformers.Cache). Untuk detail lebih lanjut, lihat [panduan kv cache](https://huggingface.co/docs/transformers/en/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 ketika `output_attentions=True` dilewatkan atau ketika `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 self-attention.

## MusicgenMelodyForCausalLM[[transformers.MusicgenMelodyForCausalLM]]

#### transformers.MusicgenMelodyForCausalLM[[transformers.MusicgenMelodyForCausalLM]]

```python
transformers.MusicgenMelodyForCausalLM(config: MusicgenMelodyDecoderConfig)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/modeling_musicgen_melody.py#L623)

**Parameter:**

config ([MusicgenMelodyDecoderConfig](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyDecoderConfig)) : Kelas konfigurasi model dengan semua parameter model. Inisialisasi dengan file konfigurasi tidak memuat bobot yang terkait dengan model, hanya konfigurasinya. Lihat metode [from_pretrained()](/docs/transformers/main/id/main_classes/model#transformers.PreTrainedModel.from_pretrained) untuk memuat bobot model.

Model decoder Musicgen Melody dengan kepala pemodelan bahasa di atasnya.

Model ini mewarisi dari [PreTrainedModel](/docs/transformers/main/id/main_classes/model#transformers.PreTrainedModel). Periksa dokumentasi kelas induk untuk metode generik yang diimplementasikan oleh pustaka ini untuk semua model (seperti mengunduh atau menyimpan, mengubah ukuran input embeddings, memangkas heads, dll.)

Model ini juga merupakan subclass dari [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#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[[transformers.MusicgenMelodyForCausalLM.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, encoder_hidden_states: typing.Optional[torch.Tensor] = None, encoder_attention_mask: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.Tensor] = None, use_cache: bool | None = None, labels: typing.Optional[torch.LongTensor] = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/modeling_musicgen_melody.py#L651)

**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](/docs/transformers/main/id/model_doc/encodec#transformers.EncodecModel). Lihat [EncodecModel.encode()](/docs/transformers/main/id/model_doc/encodec#transformers.EncodecModel.encode) untuk detailnya. [Apa itu input IDs?](../glossary#input-ids) `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 encoding audio, seperti [EncodecModel](/docs/transformers/main/id/model_doc/encodec#transformers.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`.

attention_mask (`torch.Tensor` dengan bentuk `(batch_size, sequence_length)`, *opsional*) : Mask untuk menghindari pelaksanaan attention pada indeks token padding. Nilai mask dipilih dalam `[0, 1]`:  - 1 untuk token yang **tidak di-mask**, - 0 untuk token yang **di-mask**.  [Apa itu attention masks?](../glossary#attention-mask)

encoder_hidden_states (`torch.Tensor` dengan bentuk `(batch_size, encoder_sequence_length, hidden_size)`, *opsional*) : Urutan hidden-states yang merepresentasikan penggabungan (concatenation) dari output text encoder dan output audio encoder yang telah diproses. Digunakan sebagai sinyal kondisional sehingga akan digabungkan dengan `decoder_input_ids` yang telah diproyeksikan.

encoder_attention_mask (`torch.LongTensor` dengan bentuk `(batch_size, encoder_sequence_length)`, *opsional*) : Mask untuk menghindari pelaksanaan perhatian pada state tersembunyi kondisional. Nilai mask dipilih dalam `[0, 1]`:  - 1 untuk token yang **tidak dimask**, - 0 untuk token yang **dimask**.  [Apa itu attention mask?](../glossary#attention-mask)

past_key_values (`~cache_utils.Cache`, *opsional*) : Hidden-states yang telah 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](/docs/transformers/main/id/internal/generation_utils#transformers.Cache) yang diizinkan sebagai input, lihat [panduan kv cache](https://huggingface.co/docs/transformers/en/kv_cache) kami. Jika tidak ada `past_key_values` yang diteruskan, [DynamicCache](/docs/transformers/main/id/internal/generation_utils#transformers.DynamicCache) akan diinisialisasi secara default. Model akan mengoutput format cache yang sama dengan yang diberikan sebagai input. Jika `past_key_values` digunakan, pengguna diharapkan untuk hanya menginput `input_ids` yang belum diproses (yang tidak memiliki state past key value mereka 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. Ini berguna jika Anda ingin lebih banyak kendali atas cara mengonversi indeks `input_ids` menjadi vektor terkait daripada matriks pencarian penanaman internal model.

use_cache (`bool`, *opsional*) : Jika diatur ke `True`, state kunci-nilai `past_key_values` akan dikembalikan dan dapat digunakan untuk mempercepat decoding (lihat `past_key_values`).

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 dalam `[-100, 0, ..., config.vocab_size]` Semua label yang diatur ke `-100` diabaikan (dipertahankan), kerugian hanya dihitung untuk label dalam `[0, ..., config.vocab_size]`

**Mengembalikan:** `MusicgenMelodyOutputWithPast` atau `tuple(torch.Tensor)`

A `MusicgenMelodyOutputWithPast` atau tuple dari `torch.Tensor` (jika `return_dict=False` dilewatkan atau ketika `config.return_dict=False`) yang terdiri dari berbagai elemen tergantung pada konfigurasi ([MusicgenMelodyConfig](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyConfig)) dan input.

Metode forward dari [MusicgenMelodyForCausalLM](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyForCausalLM) 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).
- **past_key_values** (`Cache`, *opsional*, dikembalikan saat `use_cache=True` dilewatkan atau saat `config.use_cache=True`) -- Ini adalah instance [Cache](/docs/transformers/main/id/internal/generation_utils#transformers.Cache). Untuk detail lebih lanjut, lihat [panduan kv cache](https://huggingface.co/docs/transformers/en/kv_cache) kami.

  Berisi hidden-states yang telah dihitung sebelumnya (key dan values di blok self-attention) yang dapat digunakan (lihat input `past_key_values`) untuk mempercepat decoding berurutan.
- **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 model pada output setiap layer ditambah output embedding awal yang opsional.
- **attentions** (`tuple[torch.Tensor]`, *opsional*, dikembalikan ketika `output_attentions=True` dilewatkan atau ketika `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 self-attention.
- **encoder_hidden_states** (`torch.Tensor` dengan bentuk `(batch_size, encoder_sequence_length, hidden_size)`, *opsional*) -- Urutan hidden-states bersyarat yang merepresentasikan konkatenasi dari output encoder teks yang diproyeksikan dan output encoder audio yang diproyeksikan. Digunakan sebagai sinyal bersyarat.

Contoh:

```python
```

## MusicgenMelodyForConditionalGeneration[[transformers.MusicgenMelodyForConditionalGeneration]]

#### transformers.MusicgenMelodyForConditionalGeneration[[transformers.MusicgenMelodyForConditionalGeneration]]

```python
transformers.MusicgenMelodyForConditionalGeneration(config: MusicgenMelodyConfig = None, text_encoder: transformers.modeling_utils.PreTrainedModel | None = None, audio_encoder: transformers.modeling_utils.PreTrainedModel | None = None, decoder: transformers.models.musicgen_melody.modeling_musicgen_melody.MusicgenMelodyForCausalLM | None = None)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/modeling_musicgen_melody.py#L1091)

**Parameter:**

config ([MusicgenMelodyConfig](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyConfig), *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()](/docs/transformers/main/id/main_classes/model#transformers.PreTrainedModel.from_pretrained) untuk memuat bobot model.

text_encoder (`PreTrainedModel`, *opsional*) : Model encoder teks yang mengkodekan teks menjadi hidden states untuk kondisioning.

audio_encoder (`PreTrainedModel`, *opsional*) : Model encoder audio yang mengkodekan audio menjadi hidden states untuk kondisioning.

decoder (`MusicgenMelodyForCausalLM`, *opsional*) : Model decoder yang menghasilkan token audio berdasarkan sinyal kondisioning.

Model Musicgen Melody untuk generasi token yang dikondisikan pada modalitas lain (misalnya, generasi dari gambar-teks ke teks).

Model ini mewarisi dari [PreTrainedModel](/docs/transformers/main/id/main_classes/model#transformers.PreTrainedModel). Periksa dokumentasi kelas induk untuk metode generik yang diimplementasikan oleh pustaka ini untuk semua model (seperti mengunduh atau menyimpan, mengubah ukuran input embeddings, memangkas heads, dll.)

Model ini juga merupakan subclass dari [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#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[[transformers.MusicgenMelodyForConditionalGeneration.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.BoolTensor] = None, input_features: typing.Optional[torch.Tensor] = None, decoder_input_ids: typing.Optional[torch.LongTensor] = None, decoder_attention_mask: typing.Optional[torch.BoolTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, encoder_hidden_states: typing.Optional[torch.Tensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, decoder_inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Sumber](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen_melody/modeling_musicgen_melody.py#L1388)

**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](/docs/transformers/main/id/model_doc/auto#transformers.AutoTokenizer). Lihat [PreTrainedTokenizer.encode()](/docs/transformers/main/id/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) dan [PreTrainedTokenizer.__call__()](/docs/transformers/main/id/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) untuk detailnya. [Apa itu input IDs?](../glossary#input-ids)

attention_mask (`torch.BoolTensor` dengan bentuk `(batch_size, sequence_length)`, *opsional*) : Mask untuk menghindari pelaksanaan attention pada indeks token padding. Nilai mask dipilih dalam `[0, 1]`:  - 1 untuk token yang **tidak di-mask**, - 0 untuk token yang **di-mask**.  [Apa itu attention masks?](../glossary#attention-mask)

input_features (`torch.Tensor` dengan bentuk `(batch_size, sequence_length, feature_dim)`, *opsional*) : Tensor yang sesuai dengan fitur audio input. Fitur audio dapat diperoleh menggunakan [MusicgenMelodyFeatureExtractor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyFeatureExtractor). Lihat `MusicgenMelodyFeatureExtractor.__call__()` untuk detailnya ([MusicgenMelodyProcessor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyProcessor) menggunakan [MusicgenMelodyFeatureExtractor](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyFeatureExtractor) untuk memproses audio).

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](/docs/transformers/main/id/model_doc/encodec#transformers.EncodecModel). Lihat [EncodecModel.encode()](/docs/transformers/main/id/model_doc/encodec#transformers.EncodecModel.encode) untuk detailnya. [Apa itu ID input decoder?](../glossary#decoder-input-ids) `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](/docs/transformers/main/id/model_doc/encodec#transformers.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 melewatkannya 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`. Mask kausal juga akan digunakan secara default.

past_key_values (`~cache_utils.Cache`, *opsional*) : Hidden-states yang telah 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](/docs/transformers/main/id/internal/generation_utils#transformers.Cache) yang diizinkan sebagai input, lihat [panduan kv cache](https://huggingface.co/docs/transformers/en/kv_cache) kami. Jika tidak ada `past_key_values` yang diteruskan, [DynamicCache](/docs/transformers/main/id/internal/generation_utils#transformers.DynamicCache) akan diinisialisasi secara default. Model akan mengoutput format cache yang sama dengan yang diberikan sebagai input. Jika `past_key_values` digunakan, pengguna diharapkan untuk hanya menginput `input_ids` yang belum diproses (yang tidak memiliki state past key value mereka diberikan ke model ini) dengan bentuk `(batch_size, unprocessed_length)` alih-alih semua `input_ids` dengan bentuk `(batch_size, sequence_length)`.

encoder_hidden_states (`torch.Tensor` dengan bentuk `(batch_size, encoder_sequence_length, hidden_size)`, *opsional*) : Urutan hidden-states bersyarat yang merepresentasikan konkatenasi dari output encoder teks yang diproyeksikan dan output encoder audio yang diproyeksikan. Digunakan sebagai sinyal bersyarat sehingga akan dikonkatenasi dengan `decoder_input_ids` yang diproyeksikan.

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. Ini berguna jika Anda ingin lebih banyak kendali atas cara mengonversi indeks `input_ids` menjadi vektor terkait daripada 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` terakhir yang perlu diinput (lihat `past_key_values`). Ini berguna jika Anda ingin lebih banyak kendali atas cara mengonversi indeks `decoder_input_ids` menjadi vektor terkait daripada matriks pencarian penanaman 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 dalam `[-100, 0, ..., config.vocab_size]` Semua label yang diatur ke `-100` diabaikan (dipertahankan), kerugian hanya dihitung untuk label dalam `[0, ..., config.vocab_size]`

use_cache (`bool`, *opsional*) : Jika diatur ke `True`, state kunci-nilai `past_key_values` akan dikembalikan dan dapat digunakan untuk mempercepat decoding (lihat `past_key_values`).

**Mengembalikan:** `MusicgenMelodyOutputWithPast` atau `tuple(torch.Tensor)`

A `MusicgenMelodyOutputWithPast` atau tuple dari `torch.Tensor` (jika `return_dict=False` dilewatkan atau ketika `config.return_dict=False`) yang terdiri dari berbagai elemen tergantung pada konfigurasi ([MusicgenMelodyConfig](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyConfig)) dan input.

Metode forward dari [MusicgenMelodyForConditionalGeneration](/docs/transformers/main/id/model_doc/musicgen_melody#transformers.MusicgenMelodyForConditionalGeneration) 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).
- **past_key_values** (`Cache`, *opsional*, dikembalikan saat `use_cache=True` dilewatkan atau saat `config.use_cache=True`) -- Ini adalah instance [Cache](/docs/transformers/main/id/internal/generation_utils#transformers.Cache). Untuk detail lebih lanjut, lihat [panduan kv cache](https://huggingface.co/docs/transformers/en/kv_cache) kami.

  Berisi hidden-states yang telah dihitung sebelumnya (key dan values di blok self-attention) yang dapat digunakan (lihat input `past_key_values`) untuk mempercepat decoding berurutan.
- **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 model pada output setiap layer ditambah output embedding awal yang opsional.
- **attentions** (`tuple[torch.Tensor]`, *opsional*, dikembalikan ketika `output_attentions=True` dilewatkan atau ketika `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 self-attention.
- **encoder_hidden_states** (`torch.Tensor` dengan bentuk `(batch_size, encoder_sequence_length, hidden_size)`, *opsional*) -- Urutan hidden-states kondisional yang merepresentasikan konkatenasi dari output text encoder yang diproyeksikan dan output audio encoder yang diproyeksikan. Digunakan sebagai sinyal kondisional.

Contoh:
```python
>>> 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])
```