# MusicGen

## Tổng quan

Mô hình MusicGen được đề xuất trong bài báo [Simple and Controllable Music Generation](https://huggingface.co/papers/2306.05284) của Jade Copet, Felix Kreuk, Itai Gat, Tal Remez, David Kant, Gabriel Synnaeve, Yossi Adi và Alexandre Défossez.

MusicGen là một mô hình Transformer tự hồi quy một giai đoạn, có khả năng tạo ra các mẫu âm nhạc chất lượng cao dựa trên mô tả bằng văn bản hoặc các gợi ý âm thanh. Các mô tả văn bản được đưa qua một mô hình mã hóa văn bản đóng băng để thu được một chuỗi các biểu diễn trạng thái ẩn. Sau đó, MusicGen được huấn luyện để dự đoán các token âm thanh rời rạc, hay *mã âm thanh*, dựa trên các trạng thái ẩn này. Các token âm thanh này sau đó được giải mã bằng một mô hình nén âm thanh, chẳng hạn như EnCodec, để khôi phục dạng sóng âm thanh.

Thông qua một mẫu xen kẽ token hiệu quả, MusicGen không yêu cầu biểu diễn ngữ nghĩa tự giám sát của các prompt văn bản/âm thanh, do đó loại bỏ nhu cầu kết nối nhiều mô hình để dự đoán một tập hợp các codebook (ví dụ: theo cấp bậc hoặc upsampling). Thay vào đó, nó có thể tạo ra tất cả các codebook trong một lần forward pass duy nhất.

Tóm tắt từ bài báo như sau:

*Chúng tôi giải quyết bài toán tạo nhạc có điều kiện. Chúng tôi giới thiệu MusicGen, một mô hình ngôn ngữ (LM) đơn lẻ hoạt động trên nhiều luồng của biểu diễn nhạc rời rạc đã nén, tức là các token. Khác với các công trình trước, MusicGen bao gồm một LM transformer một giai đoạn cùng với các mẫu xen kẽ token hiệu quả, loại bỏ nhu cầu kết nối nhiều mô hình, chẳng hạn theo cấp bậc hoặc upsampling. Theo cách tiếp cận này, chúng tôi chứng minh cách MusicGen có thể tạo ra các mẫu chất lượng cao, trong khi được điều kiện bởi mô tả văn bản hoặc các đặc trưng giai điệu, cho phép kiểm soát tốt hơn đối với đầu ra được tạo. Chúng tôi tiến hành đánh giá thực nghiệm rộng rãi, xem xét cả các nghiên cứu tự động và nghiên cứu con người, cho thấy cách tiếp cận đề xuất vượt trội hơn so với các baseline được đánh giá trên một benchmark chuẩn về text-to-music. Thông qua các nghiên cứu ablation, chúng tôi làm sáng tỏ tầm quan trọng của từng thành phần cấu thành MusicGen.*

Mô hình này được đóng góp bởi [sanchit-gandhi](https://huggingface.co/sanchit-gandhi). Mã gốc có thể được tìm thấy [tại đây](https://github.com/facebookresearch/audiocraft). Các checkpoint được huấn luyện trước có thể được tìm thấy trên [Hugging Face Hub](https://huggingface.co/models?sort=downloads&search=facebook%2Fmusicgen-).

## Mẹo sử dụng

- Sau khi tải xuống các checkpoint gốc từ [đây](https://github.com/facebookresearch/audiocraft/blob/main/docs/MUSICGEN.md#importing--exporting-models) , bạn có thể chuyển đổi chúng bằng **script chuyển đổi** có sẵn tại
`src/transformers/models/musicgen/convert_musicgen_transformers.py` với lệnh sau:

```bash
python src/transformers/models/musicgen/convert_musicgen_transformers.py \
    --checkpoint small --pytorch_dump_folder /output/path
```

## Sinh

MusicGen tương thích với hai chế độ sinh: greedy và sampling. Trên thực tế, sampling cho kết quả tốt hơn đáng kể so với greedy, do đó chúng tôi khuyến khích sử dụng chế độ sampling khi có thể. Sampling được bật theo mặc định và có thể được chỉ định rõ ràng bằng cách đặt `do_sample=True` trong lời gọi `MusicgenForConditionalGeneration.generate()`, hoặc bằng cách ghi đè cấu hình sinh của model (xem bên dưới).

Việc tạo ra âm thanh bị giới hạn ở đầu vào 30 giây do các nhúng vị trí hình sin. Điều này có nghĩa là MusicGen không thể tạo ra hơn 30 giây âm thanh (1503 token), và âm thanh đầu vào được truyền qua Audio-Prompted Generation cũng đóng góp vào giới hạn này, do đó, với đầu vào là 20 giây âm thanh, MusicGen không thể tạo ra thêm hơn 10 giây âm thanh.

Transformers hỗ trợ cả các biến thể mono (1 kênh) và stereo (2 kênh) của MusicGen. Các phiên bản kênh mono tạo ra một bộ codebooks duy nhất. Các phiên bản stereo tạo ra 2 bộ codebooks, 1 cho mỗi kênh (trái/phải), và mỗi bộ codebooks được giải mã độc lập thông qua mô hình nén âm thanh. Các luồng âm thanh cho mỗi kênh được kết hợp để tạo ra đầu ra stereo cuối cùng.

### Tạo không điều kiện

Các đầu vào cho việc tạo không điều kiện (hoặc 'null') có thể được lấy thông qua phương thức `MusicgenForConditionalGeneration.get_unconditional_inputs()`:

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

Đầu ra âm thanh là một tensor Torch ba chiều có hình dạng `(batch_size, num_channels, sequence_length)`. Để nghe các mẫu âm thanh đã tạo, bạn có thể phát chúng trong một notebook ipynb:

```python
from IPython.display import Audio

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

Hoặc lưu chúng dưới dạng tệp `.wav` bằng thư viện bên thứ ba, ví dụ `scipy`:

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

### Tạo có điều kiện theo văn bản

Mô hình có thể tạo ra một mẫu âm thanh có điều kiện dựa trên một câu lệnh văn bản thông qua việc sử dụng [MusicgenProcessor](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenProcessor) để tiền xử lý các đầu vào:

```python
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` được sử dụng trong classifier free guidance (CFG), thiết lập trọng số giữa các logits có điều kiện (được dự đoán từ các prompt văn bản) và các logits không điều kiện (được dự đoán từ một prompt không điều kiện hoặc 'null'). Giá trị guidance scale cao hơn khuyến khích mô hình tạo ra các mẫu liên kết chặt chẽ hơn với prompt đầu vào, thường phải đánh đổi bằng chất lượng âm thanh kém hơn. CFG được kích hoạt bằng cách đặt `guidance_scale > 1`. Để đạt kết quả tốt nhất, hãy sử dụng `guidance_scale=3` (mặc định).

### Tạo theo lời nhắc âm thanh

Cùng một [MusicgenProcessor](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenProcessor) có thể được sử dụng để tiền xử lý một prompt âm thanh dùng cho việc tiếp nối âm thanh. Trong ví dụ sau, chúng ta tải một tệp âm thanh bằng thư viện 🤗 Datasets, có thể cài đặt qua pip bằng lệnh bên dưới:

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

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

Đối với tạo mẫu có âm thanh theo lô, `audio_values` được tạo ra có thể được xử lý hậu kỳ để loại bỏ phần đệm bằng cách sử dụng lớp [MusicgenProcessor](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenProcessor):

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

### Cấu hình sinh

Các tham số mặc định kiểm soát quá trình sinh, chẳng hạn như lấy mẫu, thang độ dẫn hướng và số lượng token được sinh, có thể được tìm thấy trong cấu hình sinh của mô hình và được cập nhật theo mong muốn:

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

Lưu ý rằng bất kỳ đối số nào được truyền vào phương thức generate sẽ **thay thế** các đối số trong cấu hình sinh, do đó việc đặt `do_sample=False` trong lời gọi generate sẽ thay thế cài đặt `model.generation_config.do_sample` trong cấu hình sinh.

## Cấu trúc Mô hình

Mô hình MusicGen có thể được tách thành ba giai đoạn riêng biệt:

1. Text encoder: ánh xạ các đầu vào văn bản thành một chuỗi các biểu diễn trạng thái ẩn. Các mô hình MusicGen được huấn luyện trước sử dụng một text encoder đóng băng từ T5 hoặc Flan-T5
2. MusicGen decoder: một mô hình ngôn ngữ (LM) tạo ra các token âm thanh (hoặc mã) theo cách tự hồi quy, có điều kiện dựa trên các biểu diễn trạng thái ẩn của bộ mã hóa
3. Bộ mã hóa/giải mã âm thanh: được sử dụng để mã hóa một prompt âm thanh nhằm dùng làm các token prompt, và khôi phục dạng sóng âm thanh từ các token âm thanh do bộ giải mã dự đoán

Do đó, mô hình MusicGen có thể được sử dụng như một mô hình decoder độc lập, tương ứng với lớp [MusicgenForCausalLM](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenForCausalLM), hoặc như một mô hình tổng hợp bao gồm text encoder và audio encoder/decoder, tương ứng với lớp [MusicgenForConditionalGeneration](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenForConditionalGeneration). Nếu chỉ cần nạp decoder từ checkpoint đã huấn luyện trước, nó có thể được nạp bằng cách đầu tiên chỉ định config chính xác, hoặc được truy cập thông qua thuộc tính `.decoder` của mô hình tổng hợp:

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

Vì các mô hình text encoder và audio encoder/decoder được đóng băng trong quá trình huấn luyện, mô hình decoder MusicGen [MusicgenForCausalLM](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenForCausalLM) có thể được huấn luyện độc lập trên một tập dữ liệu gồm encoder hidden-states và audio codes. Khi suy luận, decoder đã được huấn luyện có thể được kết hợp với text encoder và audio encoder/decoder đã đóng băng để khôi phục mô hình tổng hợp [MusicgenForConditionalGeneration](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenForConditionalGeneration).

Mẹo:

* MusicGen được huấn luyện trên checkpoint 32kHz của Encodec. Bạn nên đảm bảo sử dụng phiên bản Encodec tương thích.
* Chế độ Sampling thường cho kết quả tốt hơn so với greedy - bạn có thể bật/tắt sampling bằng biến `do_sample` trong lời gọi `MusicgenForConditionalGeneration.generate()`

## MusicgenDecoderConfig[[transformers.MusicgenDecoderConfig]]

#### transformers.MusicgenDecoderConfig[[transformers.MusicgenDecoderConfig]]

```python
transformers.MusicgenDecoderConfig(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, cross_attention_hidden_size: int | None = None)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/configuration_musicgen.py#L30)

**Tham số:**

vocab_size (`int`, *tùy chọn*, mặc định là `2048`) : Kích thước từ vựng của mô hình. Xác định số lượng token khác nhau có thể được biểu diễn bởi `input_ids`.

max_position_embeddings (`int`, *tuỳ chọn*, mặc định là `2048`) : Độ dài chuỗi tối đa mà mô hình này có thể được sử dụng.

num_hidden_layers (`int`, *tuỳ chọn*, mặc định là `24`) : Số lượng lớp ẩn trong bộ giải mã Transformer.

ffn_dim (`int`, *tuỳ chọn*, mặc định là `4096`) : Kích thước của các biểu diễn MLP.

num_attention_heads (`int`, *tuỳ chọn*, mặc định là `16`) : Số lượng đầu chú ý cho mỗi lớp chú ý trong bộ giải mã Transformer.

layerdrop (`Union[float, int]`, *tùy chọn*, mặc định là `0.0`) : Xác suất LayerDrop. Xem [bài báo LayerDrop](see https://huggingface.co/papers/1909.11556) để biết thêm chi tiết.

use_cache (`bool`, *tùy chọn*, mặc định là `True`) : Xác định xem mô hình có nên trả về các chú ý key/values cuối cùng hay không (không được sử dụng bởi tất cả các mô hình). Chỉ liên quan nếu `config.is_decoder=True` hoặc khi mô hình là mô hình sinh chỉ có decoder.

activation_function (`str`, *tùy chọn*, mặc định là `gelu`) : Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, `"gelu"`, `"relu"`, `"silu"`, v.v.

hidden_size (`int`, *tuỳ chọn*, mặc định là `1024`) : Kích thước của các biểu diễn ẩn.

dropout (`Union[float, int]`, *tùy chọn*, mặc định là `0.1`) : Tỷ lệ cho tất cả các lớp dropout.

attention_dropout (`Union[float, int]`, *tùy chọn*, mặc định là `0.0`) : Tỷ lệ dropout cho các xác suất chú ý.

activation_dropout (`Union[float, int]`, *tùy chọn*, mặc định là `0.0`) : Tỷ lệ dropout cho các kích hoạt bên trong lớp liên kết đầy đủ.

initializer_factor (`float`, *optional*, mặc định là `0.02`) : Hệ số để khởi tạo tất cả các ma trận trọng số (nên giữ ở mức 1, được sử dụng bên trong cho việc kiểm tra khởi tạo).

scale_embedding (`bool`, *tùy chọn*, mặc định là `False`) : Có nên chia embeddings cho sqrt(d_model) để chuẩn hóa hay không.

num_codebooks (`int`, *tuỳ chọn*, mặc định là `4`) : Số lượng codebook song song được mô hình sử dụng.

audio_channels (`int`, *tuỳ chọn*, mặc định là `1`) : Số lượng kênh đầu vào.

pad_token_id (`int`, *tuỳ chọn*, mặc định là `2048`) : Id của token được sử dụng để đệm (padding) trong từ vựng.

bos_token_id (`int`, *tuỳ chọn*, mặc định là `2048`) : Token id được sử dụng cho đầu luồng (beginning-of-stream) trong bảng từ vựng.

eos_token_id (`Union[int, list[int]]`, *tùy chọn*) : Id của token được sử dụng cho end-of-stream trong bảng từ vựng.

tie_word_embeddings (`bool`, *tùy chọn*, mặc định là `False`) : Có nên gắn kết các nhúng trọng số theo ánh xạ `tied_weights_keys` của mô hình hay không.

is_decoder (`bool`, *tùy chọn*, mặc định là `False`) : Xác định xem mô hình có được sử dụng như một bộ giải mã (decoder) hay không. Nếu `False`, mô hình sẽ được sử dụng như một bộ mã hóa (encoder).

add_cross_attention (`bool`, *tùy chọn*, mặc định là `False`) : Xác định xem có nên thêm các lớp cross-attention vào mô hình hay không.

cross_attention_hidden_size (`int`, *optional*) : Kích thước ẩn của đầu ra bộ mã hóa được chiếu vào không gian khóa/giá trị của chú ý chéo trong bộ giải mã. Được sử dụng khi bộ mã hóa và bộ giải mã có kích thước ẩn khác nhau.

Đây là lớp cấu hình để lưu trữ cấu hình của MusicgenModel. Nó được sử dụng để khởi tạo một mô hình Musicgen theo các đối số được chỉ định, xác định kiến trúc mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như của [facebook/musicgen-small](https://huggingface.co/facebook/musicgen-small)

Các đối tượng cấu hình kế thừa từ [PreTrainedConfig](/docs/transformers/main/vi/main_classes/configuration#transformers.PreTrainedConfig) và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ [PreTrainedConfig](/docs/transformers/main/vi/main_classes/configuration#transformers.PreTrainedConfig) để biết thêm thông tin.

## MusicgenConfig[[transformers.MusicgenConfig]]

#### transformers.MusicgenConfig[[transformers.MusicgenConfig]]

```python
transformers.MusicgenConfig(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, initializer_factor: float = 0.02)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/configuration_musicgen.py#L83)

**Tham số:**

text_encoder (`Union[dict, `PretrainedConfig`]`) : Một instance của đối tượng cấu hình định nghĩa cấu hình text encoder.

audio_encoder (`Union[dict, `PretrainedConfig`]`) : Một instance của đối tượng cấu hình xác định cấu hình bộ mã hóa âm thanh.

decoder (`Union[dict, `PretrainedConfig`]`) : Một instance của đối tượng cấu hình định nghĩa cấu hình decoder.

initializer_factor (`float`, *optional*, mặc định là `0.02`) : Hệ số để khởi tạo tất cả các ma trận trọng số (nên giữ ở mức 1, được sử dụng bên trong cho việc kiểm tra khởi tạo).

Đây là lớp cấu hình để lưu trữ cấu hình của MusicgenModel. Nó được sử dụng để khởi tạo một mô hình Musicgen theo các đối số được chỉ định, xác định kiến trúc mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như của [facebook/musicgen-small](https://huggingface.co/facebook/musicgen-small)

Các đối tượng cấu hình kế thừa từ [PreTrainedConfig](/docs/transformers/main/vi/main_classes/configuration#transformers.PreTrainedConfig) và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ [PreTrainedConfig](/docs/transformers/main/vi/main_classes/configuration#transformers.PreTrainedConfig) để biết thêm thông tin.

Ví dụ:

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

#### transformers.MusicgenProcessor[[transformers.MusicgenProcessor]]

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

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/processing_musicgen.py#L27)

**Tham số:**

feature_extractor (`EncodecFeatureExtractor`) : Bộ trích xuất đặc trưng là một đầu vào bắt buộc.

tokenizer (`T5Tokenizer`) : Tokenizer là đầu vào bắt buộc.

Tạo một MusicgenProcessor đóng gói một bộ trích xuất đặc trưng và một bộ phân từ thành một bộ xử lý duy nhất.

[MusicgenProcessor](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenProcessor) cung cấp đầy đủ các chức năng của [EncodecFeatureExtractor](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecFeatureExtractor) và [T5Tokenizer](/docs/transformers/main/vi/model_doc/t5#transformers.T5Tokenizer). Xem [~EncodecFeatureExtractor](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecFeatureExtractor) và [~T5Tokenizer](/docs/transformers/main/vi/model_doc/t5#transformers.T5Tokenizer) để biết thêm thông tin.

#### __call__[[transformers.MusicgenProcessor.__call__]]

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

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/processing_musicgen.py#L34)

**Tham số:**

return_tensors (`str` hoặc [TensorType](/docs/transformers/main/vi/internal/file_utils#transformers.TensorType), *optional*) : Nếu được đặt, sẽ trả về các tensor của một framework cụ thể. Các giá trị chấp nhận được là:  - `'pt'`: Trả về các đối tượng `torch.Tensor` của PyTorch. - `'np'`: Trả về các đối tượng `np.ndarray` của NumPy.

## MusicgenModel[[transformers.MusicgenModel]]

#### transformers.MusicgenModel[[transformers.MusicgenModel]]

```python
transformers.MusicgenModel(config: MusicgenDecoderConfig)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L551)

**Tham số:**

config ([MusicgenDecoderConfig](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenDecoderConfig)) : Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình sẽ không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức [from_pretrained()](/docs/transformers/main/vi/main_classes/model#transformers.PreTrainedModel.from_pretrained) để tải trọng số mô hình.

Mô hình Musicgen cơ bản, tạo ra các hidden-state thô mà không có bất kỳ head cụ thể nào ở phía trên.

Mô hình này kế thừa từ [PreTrainedModel](/docs/transformers/main/vi/main_classes/model#transformers.PreTrainedModel). Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu ra, v.v.)

Mô hình này cũng là một lớp con của [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

#### forward[[transformers.MusicgenModel.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'>)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L564)

**Tham số:**

input_ids (`torch.LongTensor` có shape `(batch_size * num_codebooks, sequence_length)`) : Chỉ số của các token trong chuỗi đầu vào thuộc từ vựng, tương ứng với chuỗi mã âm thanh.  Các chỉ số này có thể được lấy bằng cách mã hóa một prompt âm thanh bằng mô hình mã hóa âm thanh để dự đoán các mã âm thanh, chẳng hạn như sử dụng [EncodecModel](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel). Xem [EncodecModel.encode()](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel.encode) để biết chi tiết.  [Các input IDs là gì?](../glossary#input-ids)    `input_ids` sẽ được tự động chuyển đổi từ shape `(batch_size * num_codebooks, target_sequence_length)` sang `(batch_size, num_codebooks, target_sequence_length)` trong quá trình forward pass. Nếu bạn lấy các mã âm thanh từ một mô hình mã hóa âm thanh, chẳng hạn như [EncodecModel](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel), hãy đảm bảo rằng số lượng frames bằng 1, và rằng bạn đã reshape các mã âm thanh từ `(frames, batch_size, num_codebooks, target_sequence_length)` sang `(batch_size * num_codebooks, target_sequence_length)` trước khi truyền chúng dưới dạng `input_ids`.

attention_mask (`torch.Tensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong `[0, 1]`:  - 1 cho các token **không bị che**, - 0 cho các token **bị che**.  [Mặt nạ chú ý là gì?](../glossary#attention-mask)

encoder_hidden_states (`torch.Tensor` có shape `(batch_size, encoder_sequence_length, hidden_size)`, *tùy chọn*) : Chuỗi hidden-states tại đầu ra của lớp cuối cùng của encoder. Được sử dụng trong cross-attention của decoder.

encoder_attention_mask (`torch.LongTensor` có hình dạng `(batch_size, encoder_sequence_length)`, *tùy chọn*) : Mặt nạ để tránh thực hiện cross-attention trên các chỉ số token padding của encoder input_ids. Các giá trị mặt nạ được chọn trong `[0, 1]`:  - 1 cho các token **không bị che**, - 0 cho các token **bị che**.  [Mặt nạ chú ý là gì?](../glossary#attention-mask)

past_key_values (`~cache_utils.Cache`, *tùy chọn*) : Các hidden-states đã tính trước (key và values trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm `past_key_values` do mô hình trả về ở một giai đoạn giải mã trước đó, khi `use_cache=True` hoặc `config.use_cache=True`.  Chỉ cho phép [Cache](/docs/transformers/main/vi/internal/generation_utils#transformers.Cache) instance làm đầu vào, xem [hướng dẫn kv cache](https://huggingface.co/docs/transformers/en/kv_cache) của chúng tôi. Nếu không truyền `past_key_values`, [DynamicCache](/docs/transformers/main/vi/internal/generation_utils#transformers.DynamicCache) sẽ được khởi tạo theo mặc định.  Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.  Nếu sử dụng `past_key_values`, người dùng được kỳ vọng chỉ nhập các `input_ids` chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có shape `(batch_size, unprocessed_length)` thay vì tất cả `input_ids` có shape `(batch_size, sequence_length)`.

inputs_embeds (`torch.Tensor` có hình dạng `(batch_size, sequence_length, hidden_size)`, *tùy chọn*) : Tùy chọn, thay vì truyền `input_ids`, bạn có thể chọn cách truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số `input_ids` thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.

use_cache (`bool`, *tùy chọn*) : Nếu được đặt thành `True`, các trạng thái khóa và giá trị `past_key_values` sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem `past_key_values`).

**Trả về:** [BaseModelOutputWithPastAndCrossAttentions](/docs/transformers/main/vi/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions) hoặc `tuple(torch.Tensor)`

Một [BaseModelOutputWithPastAndCrossAttentions](/docs/transformers/main/vi/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions) hoặc một tuple của `torch.Tensor` (nếu `return_dict=False` được truyền hoặc khi `config.return_dict=False`) bao gồm các phần tử khác nhau tùy thuộc vào cấu hình ([MusicgenConfig](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenConfig)) và đầu vào.

Phương thức forward của [MusicgenModel](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenModel) ghi đè lên phương thức đặc biệt `__call__`.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, bạn nên gọi instance của `Module` sau đó thay vì gọi hàm này, vì instance `Module` sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ bỏ qua chúng một cách im lặng.

- **last_hidden_state** (`torch.Tensor` có hình dạng `(batch_size, sequence_length, hidden_size)`) -- Chuỗi các hidden-state tại đầu ra của lớp cuối cùng của mô hình.

  Nếu `past_key_values` được sử dụng, chỉ có hidden-state cuối cùng của các chuỗi có shape `(batch_size, 1, hidden_size)` được xuất ra.
- **past_key_values** (`Cache`, *tùy chọn*, được trả về khi `use_cache=True` được truyền vào hoặc khi `config.use_cache=True`) -- Đây là một instance của [Cache](/docs/transformers/main/vi/internal/generation_utils#transformers.Cache). Để biết thêm chi tiết, hãy xem [hướng dẫn về kv cache](https://huggingface.co/docs/transformers/en/kv_cache) của chúng tôi.

  Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention và tùy chọn nếu `config.is_encoder_decoder=True` trong các khối cross-attention) có thể được sử dụng (xem đầu vào `past_key_values`) để tăng tốc độ giải mã tuần tự.
- **hidden_states** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_hidden_states=True` được truyền vào hoặc khi `config.output_hidden_states=True`) -- Bộ tuple của `torch.Tensor` (một cho đầu ra của các embedding, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng `(batch_size, sequence_length, hidden_size)`.

  Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.
- **attentions** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_attentions=True` được truyền vào hoặc khi `config.output_attentions=True`) -- Bộ tuple của `torch.Tensor` (một cho mỗi lớp) có hình dạng `(batch_size, num_heads, sequence_length, sequence_length)`.

  Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.
- **cross_attentions** (`tuple(torch.Tensor)`, *tùy chọn*, được trả về khi `output_attentions=True` và `config.add_cross_attention=True` được truyền vào hoặc khi `config.output_attentions=True`) -- Bộ tuple của `torch.Tensor` (một cho mỗi lớp) có hình dạng `(batch_size, num_heads, sequence_length, sequence_length)`.

  Trọng số chú ý của lớp cross-attention của bộ giải mã, sau softmax chú ý, được sử dụng để tính trung bình có trọng số trong các đầu chú ý chéo.

## MusicgenForCausalLM[[transformers.MusicgenForCausalLM]]

#### transformers.MusicgenForCausalLM[[transformers.MusicgenForCausalLM]]

```python
transformers.MusicgenForCausalLM(config: MusicgenDecoderConfig)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L628)

**Tham số:**

config ([MusicgenDecoderConfig](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenDecoderConfig)) : Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình sẽ không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức [from_pretrained()](/docs/transformers/main/vi/main_classes/model#transformers.PreTrainedModel.from_pretrained) để tải trọng số mô hình.

Mô hình giải mã MusicGen có đầu mô hình hóa ngôn ngữ phía trên.

Mô hình này kế thừa từ [PreTrainedModel](/docs/transformers/main/vi/main_classes/model#transformers.PreTrainedModel). Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu ra, v.v.)

Mô hình này cũng là một lớp con của [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

#### forward[[transformers.MusicgenForCausalLM.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, labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L656)

**Tham số:**

input_ids (`torch.LongTensor` có shape `(batch_size * num_codebooks, sequence_length)`) : Chỉ số của các token trong chuỗi đầu vào thuộc từ vựng, tương ứng với chuỗi mã âm thanh.  Các chỉ số này có thể được lấy bằng cách mã hóa một prompt âm thanh bằng mô hình mã hóa âm thanh để dự đoán các mã âm thanh, chẳng hạn như sử dụng [EncodecModel](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel). Xem [EncodecModel.encode()](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel.encode) để biết chi tiết.  [Các input IDs là gì?](../glossary#input-ids)    `input_ids` sẽ được tự động chuyển đổi từ shape `(batch_size * num_codebooks, target_sequence_length)` sang `(batch_size, num_codebooks, target_sequence_length)` trong quá trình forward pass. Nếu bạn lấy các mã âm thanh từ một mô hình mã hóa âm thanh, chẳng hạn như [EncodecModel](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel), hãy đảm bảo rằng số lượng frames bằng 1, và rằng bạn đã reshape các mã âm thanh từ `(frames, batch_size, num_codebooks, target_sequence_length)` sang `(batch_size * num_codebooks, target_sequence_length)` trước khi truyền chúng dưới dạng `input_ids`.

attention_mask (`torch.Tensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong `[0, 1]`:  - 1 cho các token **không bị che**, - 0 cho các token **bị che**.  [Mặt nạ chú ý là gì?](../glossary#attention-mask)

encoder_hidden_states (`torch.Tensor` có hình dạng `(batch_size, encoder_sequence_length, hidden_size)`, *tùy chọn*) : Chuỗi hidden-states tại đầu ra của lớp cuối cùng của encoder. Được sử dụng trong cross-attention của decoder.

encoder_attention_mask (`torch.LongTensor` có hình dạng `(batch_size, encoder_sequence_length)`, *tùy chọn*) : Mặt nạ để tránh thực hiện cross-attention trên các chỉ số token padding của encoder input_ids. Các giá trị mặt nạ được chọn trong `[0, 1]`:  - 1 cho các token **không bị che**, - 0 cho các token **bị che**.  [Mặt nạ chú ý là gì?](../glossary#attention-mask)

past_key_values (`~cache_utils.Cache`, *tùy chọn*) : Các hidden-states đã tính trước (key và values trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm `past_key_values` do mô hình trả về ở một giai đoạn giải mã trước đó, khi `use_cache=True` hoặc `config.use_cache=True`.  Chỉ cho phép [Cache](/docs/transformers/main/vi/internal/generation_utils#transformers.Cache) instance làm đầu vào, xem [hướng dẫn kv cache](https://huggingface.co/docs/transformers/en/kv_cache) của chúng tôi. Nếu không truyền `past_key_values`, [DynamicCache](/docs/transformers/main/vi/internal/generation_utils#transformers.DynamicCache) sẽ được khởi tạo theo mặc định.  Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.  Nếu sử dụng `past_key_values`, người dùng được kỳ vọng chỉ nhập các `input_ids` chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có shape `(batch_size, unprocessed_length)` thay vì tất cả `input_ids` có shape `(batch_size, sequence_length)`.

inputs_embeds (`torch.Tensor` có hình dạng `(batch_size, sequence_length, hidden_size)`, *tùy chọn*) : Tùy chọn, thay vì truyền `input_ids`, bạn có thể chọn cách truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số `input_ids` thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.

labels (`torch.LongTensor` có hình dạng `(batch_size, sequence_length, num_codebooks)`, *tùy chọn*) : Nhãn cho mô hình hóa ngôn ngữ. Lưu ý rằng các nhãn **được dịch chuyển** bên trong mô hình, tức là bạn có thể đặt `labels = input_ids` Các chỉ số được chọn trong `[-100, 0, ..., config.vocab_size]` Tất cả các nhãn được đặt thành `-100` sẽ bị bỏ qua (che), tổn thất chỉ được tính cho các nhãn trong `[0, ..., config.vocab_size]`

use_cache (`bool`, *tùy chọn*) : Nếu được đặt thành `True`, các trạng thái khóa và giá trị `past_key_values` sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem `past_key_values`).

**Trả về:** [CausalLMOutputWithCrossAttentions](/docs/transformers/main/vi/main_classes/output#transformers.modeling_outputs.CausalLMOutputWithCrossAttentions) hoặc `tuple(torch.Tensor)`

Một [CausalLMOutputWithCrossAttentions](/docs/transformers/main/vi/main_classes/output#transformers.modeling_outputs.CausalLMOutputWithCrossAttentions) hoặc một tuple của `torch.Tensor` (nếu `return_dict=False` được truyền hoặc khi `config.return_dict=False`) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình ([MusicgenConfig](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenConfig)) và đầu vào.

Phương thức forward của [MusicgenForCausalLM](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenForCausalLM) ghi đè lên phương thức đặc biệt `__call__`.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, bạn nên gọi instance của `Module` sau đó thay vì gọi hàm này, vì instance `Module` sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ bỏ qua chúng một cách im lặng.

- **loss** (`torch.Tensor` có shape `(1,)`, *optional*, được trả về khi `labels` được cung cấp) -- Loss của language modeling (cho next-token prediction).
- **logits** (`torch.Tensor` có hình dạng `(batch_size, sequence_length, config.vocab_size)`) -- Điểm dự đoán của đầu mô hình hóa ngôn ngữ (điểm cho mỗi token từ vựng trước SoftMax).
- **hidden_states** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_hidden_states=True` được truyền vào hoặc khi `config.output_hidden_states=True`) -- Bộ tuple của `torch.Tensor` (một cho đầu ra của các embedding, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng `(batch_size, sequence_length, hidden_size)`.

  Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.
- **attentions** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_attentions=True` được truyền vào hoặc khi `config.output_attentions=True`) -- Bộ tuple của `torch.Tensor` (một cho mỗi lớp) có hình dạng `(batch_size, num_heads, sequence_length, sequence_length)`.

  Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.
- **cross_attentions** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_attentions=True` được truyền vào hoặc khi `config.output_attentions=True`) -- Bộ tuple của `torch.Tensor` (một cho mỗi lớp) có hình dạng `(batch_size, num_heads, sequence_length, sequence_length)`.

  Trọng số của cross attention sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu cross-attention.
- **past_key_values** (`Cache`, *tùy chọn*, được trả về khi `use_cache=True` được truyền vào hoặc khi `config.use_cache=True`) -- Đây là một instance của [Cache](/docs/transformers/main/vi/internal/generation_utils#transformers.Cache). Để biết thêm chi tiết, hãy xem [hướng dẫn về kv cache](https://huggingface.co/docs/transformers/en/kv_cache) của chúng tôi.

  Chứa các hidden-states đã được tính trước (key và values trong các khối attention) có thể được sử dụng (xem đầu vào `past_key_values`) để tăng tốc độ giải mã tuần tự.

Ví dụ:

```python
```

## MusicgenForConditionalGeneration[[transformers.MusicgenForConditionalGeneration]]

#### transformers.MusicgenForConditionalGeneration[[transformers.MusicgenForConditionalGeneration]]

```python
transformers.MusicgenForConditionalGeneration(config: transformers.models.musicgen.configuration_musicgen.MusicgenConfig | None = None, text_encoder: transformers.modeling_utils.PreTrainedModel | None = None, audio_encoder: transformers.modeling_utils.PreTrainedModel | None = None, decoder: transformers.models.musicgen.modeling_musicgen.MusicgenForCausalLM | None = None)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L1104)

**Tham số:**

config ([MusicgenConfig](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenConfig), *optional*) : Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình sẽ không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức [from_pretrained()](/docs/transformers/main/vi/main_classes/model#transformers.PreTrainedModel.from_pretrained) để tải trọng số mô hình.

text_encoder (`PreTrainedModel`, *tùy chọn*) : Mô hình mã hóa văn bản, mã hóa văn bản thành các trạng thái ẩn để điều kiện hóa.

audio_encoder (`PreTrainedModel`, *tùy chọn*) : Mô hình mã hóa âm thanh mã hóa âm thanh thành các trạng thái ẩn để điều kiện.

decoder (`MusicgenForCausalLM`, *tùy chọn*) : Mô hình giải mã tạo ra các token âm thanh dựa trên các tín hiệu điều kiện.

Mô hình MusicGen tổng hợp với bộ mã hóa văn bản, bộ mã hóa âm thanh và bộ giải mã Musicgen,

Mô hình này kế thừa từ [PreTrainedModel](/docs/transformers/main/vi/main_classes/model#transformers.PreTrainedModel). Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu ra, v.v.)

Mô hình này cũng là một lớp con của [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

#### forward[[transformers.MusicgenForConditionalGeneration.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.BoolTensor] = None, input_values: typing.Optional[torch.Tensor] = None, padding_mask: typing.Optional[torch.BoolTensor] = None, decoder_input_ids: typing.Optional[torch.LongTensor] = None, decoder_attention_mask: typing.Optional[torch.BoolTensor] = None, encoder_outputs: tuple[torch.Tensor] | None = None, past_key_values: transformers.cache_utils.Cache | None = 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'>)
```

[Nguồn](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L1420)

**Tham số:**

input_ids (`torch.LongTensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Mặc định, các token đệm (padding) sẽ bị bỏ qua. Có thể lấy chỉ số bằng cách sử dụng [AutoTokenizer](/docs/transformers/main/vi/model_doc/auto#transformers.AutoTokenizer). Xem [PreTrainedTokenizer.encode()](/docs/transformers/main/vi/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) và [PreTrainedTokenizer.__call__()](/docs/transformers/main/vi/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) để biết chi tiết. [ID đầu vào là gì?](../glossary#input-ids)

attention_mask (`torch.BoolTensor` có shape `(batch_size, sequence_length)`, *tùy chọn*) : Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong `[0, 1]`:  - 1 cho các token **không bị che**, - 0 cho các token **bị che**.  [Mặt nạ chú ý là gì?](../glossary#attention-mask)

input_values (`torch.Tensor` có shape `(batch_size, sequence_length)`, *tùy chọn*) : Các giá trị float của dạng sóng âm thanh thô đầu vào. Các giá trị này có thể được lấy bằng cách nạp tệp âm thanh `.flac` hoặc `.wav` vào một mảng có kiểu `list[float]`, một `numpy.ndarray` hoặc một `torch.Tensor`, *ví dụ* thông qua thư viện torchcodec (`pip install torchcodec`) hoặc thư viện soundfile (`pip install soundfile`). Để chuẩn bị mảng thành `input_values`, cần sử dụng [AutoProcessor](/docs/transformers/main/vi/model_doc/auto#transformers.AutoProcessor) để thực hiện padding và chuyển đổi thành tensor có kiểu `torch.Tensor`. Xem [MusicgenProcessor.__call__()](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenProcessor.__call__) để biết thêm chi tiết.

padding_mask (`torch.BoolTensor` có shape `(batch_size, sequence_length)`, *tùy chọn*) : Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong `[0, 1]`:  - 1 cho các token **không bị che**, - 0 cho các token **bị che**.  [Mặt nạ chú ý là gì?](../glossary#attention-mask)

decoder_input_ids (`torch.LongTensor` có shape `(batch_size * num_codebooks, target_sequence_length)`, *optional*) : Chỉ số của các token trong chuỗi đầu vào của decoder trong bảng từ vựng, tương ứng với chuỗi mã âm thanh.  Các chỉ số có thể được lấy bằng cách mã hóa một prompt âm thanh bằng mô hình mã hóa âm thanh để dự đoán các mã âm thanh, chẳng hạn như với [EncodecModel](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel). Xem [EncodecModel.encode()](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel.encode) để biết chi tiết.  [Các ID đầu vào của decoder là gì?](../glossary#decoder-input-ids)    `decoder_input_ids` sẽ được tự động chuyển đổi từ shape `(batch_size * num_codebooks, target_sequence_length)` sang `(batch_size, num_codebooks, target_sequence_length)` trong quá trình forward pass. Nếu bạn lấy các mã âm thanh từ một mô hình mã hóa âm thanh, chẳng hạn như [EncodecModel](/docs/transformers/main/vi/model_doc/encodec#transformers.EncodecModel), hãy đảm bảo rằng số lượng khung (frames) bằng 1, và rằng bạn thay đổi shape của các mã âm thanh từ `(frames, batch_size, num_codebooks, target_sequence_length)` sang `(batch_size * num_codebooks, target_sequence_length)` trước khi truyền chúng dưới dạng `decoder_input_ids`.

decoder_attention_mask (`torch.LongTensor` có hình dạng `(batch_size, target_sequence_length)`, *tùy chọn*) : Hành vi mặc định: tạo một tensor bỏ qua các token pad trong `decoder_input_ids`. Mặt nạ nhân quả (causal mask) cũng sẽ được sử dụng theo mặc định.

encoder_outputs (`tuple[torch.Tensor]`, *tuỳ chọn*) : Tuple bao gồm (`last_hidden_state`, *tuỳ chọn*: `hidden_states`, *tuỳ chọn*: `attentions`) `last_hidden_state` có hình dạng `(batch_size, sequence_length, hidden_size)`, *tuỳ chọn*) là một chuỗi các hidden-states tại đầu ra của lớp cuối cùng của encoder. Được sử dụng trong cross-attention của decoder.

past_key_values (`~cache_utils.Cache`, *tùy chọn*) : Các hidden-states đã tính trước (key và values trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc giải mã tuần tự. Điều này thường bao gồm `past_key_values` do mô hình trả về ở một giai đoạn giải mã trước đó, khi `use_cache=True` hoặc `config.use_cache=True`.  Chỉ cho phép [Cache](/docs/transformers/main/vi/internal/generation_utils#transformers.Cache) instance làm đầu vào, xem [hướng dẫn kv cache](https://huggingface.co/docs/transformers/en/kv_cache) của chúng tôi. Nếu không truyền `past_key_values`, [DynamicCache](/docs/transformers/main/vi/internal/generation_utils#transformers.DynamicCache) sẽ được khởi tạo theo mặc định.  Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào.  Nếu sử dụng `past_key_values`, người dùng được kỳ vọng chỉ nhập các `input_ids` chưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có shape `(batch_size, unprocessed_length)` thay vì tất cả `input_ids` có shape `(batch_size, sequence_length)`.

inputs_embeds (`torch.Tensor` có hình dạng `(batch_size, sequence_length, hidden_size)`, *tùy chọn*) : Tùy chọn, thay vì truyền `input_ids`, bạn có thể chọn cách truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số `input_ids` thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.

decoder_inputs_embeds (`torch.Tensor` có shape `(batch_size, target_sequence_length, hidden_size)`, *tùy chọn*) : Tùy chọn, thay vì truyền `decoder_input_ids`, bạn có thể chọn truyền trực tiếp một biểu diễn nhúng. Nếu `past_key_values` được sử dụng, tùy chọn chỉ cần nhập `decoder_inputs_embeds` cuối cùng (xem `past_key_values`). Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số `decoder_input_ids` thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình. Nếu cả `decoder_input_ids` và `decoder_inputs_embeds` đều không được đặt, `decoder_inputs_embeds` sẽ nhận giá trị của `inputs_embeds`.

labels (`torch.LongTensor` có hình dạng `(batch_size, sequence_length, num_codebooks)`, *tùy chọn*) : Nhãn cho mô hình hóa ngôn ngữ. Lưu ý rằng các nhãn **được dịch chuyển** bên trong mô hình, tức là bạn có thể đặt `labels = input_ids` Các chỉ số được chọn trong `[-100, 0, ..., config.vocab_size]` Tất cả các nhãn được đặt thành `-100` sẽ bị bỏ qua (che), tổn thất chỉ được tính cho các nhãn trong `[0, ..., config.vocab_size]`

use_cache (`bool`, *tùy chọn*) : Nếu được đặt thành `True`, các trạng thái khóa và giá trị `past_key_values` sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem `past_key_values`).

**Trả về:** [Seq2SeqLMOutput](/docs/transformers/main/vi/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput) hoặc `tuple(torch.Tensor)`

Một [Seq2SeqLMOutput](/docs/transformers/main/vi/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput) hoặc một tuple của `torch.Tensor` (nếu `return_dict=False` được truyền hoặc khi `config.return_dict=False`) bao gồm các phần tử khác nhau tùy thuộc vào cấu hình ([MusicgenConfig](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenConfig)) và đầu vào.

Phương thức forward của [MusicgenForConditionalGeneration](/docs/transformers/main/vi/model_doc/musicgen#transformers.MusicgenForConditionalGeneration) ghi đè lên phương thức đặc biệt `__call__`.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, bạn nên gọi instance của `Module` sau đó thay vì gọi hàm này, vì instance `Module` sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ bỏ qua chúng một cách im lặng.

- **loss** (`torch.Tensor` có shape `(1,)`, *tuỳ chọn*, được trả về khi `labels` được cung cấp) -- Loss của language modeling.
- **logits** (`torch.Tensor` có hình dạng `(batch_size, sequence_length, config.vocab_size)`) -- Điểm dự đoán của đầu mô hình hóa ngôn ngữ (điểm cho mỗi token từ vựng trước SoftMax).
- **past_key_values** (`EncoderDecoderCache`, *tùy chọn*, được trả về khi `use_cache=True` được truyền vào hoặc khi `config.use_cache=True`) -- Đây là một instance của [EncoderDecoderCache](/docs/transformers/main/vi/internal/generation_utils#transformers.EncoderDecoderCache). Để biết thêm chi tiết, hãy xem [hướng dẫn về kv cache](https://huggingface.co/docs/transformers/en/kv_cache) của chúng tôi.

  Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention và trong các khối cross-attention) có thể được sử dụng (xem đầu vào `past_key_values`) để tăng tốc độ giải mã tuần tự.
- **decoder_hidden_states** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_hidden_states=True` được truyền vào hoặc khi `config.output_hidden_states=True`) -- Bộ tuple của `torch.Tensor` (một cho đầu ra của các embedding, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng `(batch_size, sequence_length, hidden_size)`.

  Trạng thái ẩn của bộ giải mã tại đầu ra của mỗi lớp cùng với đầu ra của nhúng ban đầu.
- **decoder_attentions** (`tuple(torch.Tensor)`, *tùy chọn*, được trả về khi `output_attentions=True` được truyền vào hoặc khi `config.output_attentions=True`) -- Bộ tuple của `torch.Tensor` (một cho mỗi lớp) có hình dạng `(batch_size, num_heads, sequence_length, sequence_length)`.

  Trọng số chú ý của bộ giải mã, sau softmax chú ý, được sử dụng để tính trung bình có trọng số trong các đầu chú ý tự (self-attention).
- **cross_attentions** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_attentions=True` được truyền vào hoặc khi `config.output_attentions=True`) -- Bộ tuple của `torch.Tensor` (một cho mỗi lớp) có hình dạng `(batch_size, num_heads, sequence_length, sequence_length)`.

  Trọng số chú ý của lớp cross-attention của bộ giải mã, sau softmax chú ý, được sử dụng để tính trung bình có trọng số trong các đầu chú ý chéo.
- **encoder_last_hidden_state** (`torch.Tensor` có hình dạng `(batch_size, sequence_length, hidden_size)`, *tùy chọn*) -- Chuỗi các trạng thái ẩn tại đầu ra của lớp cuối cùng của bộ mã hóa trong mô hình.
- **encoder_hidden_states** (`tuple(torch.Tensor)`, *tuỳ chọn*, được trả về khi `output_hidden_states=True` được truyền vào hoặc khi `config.output_hidden_states=True`) -- Bộ tuple các `torch.Tensor` (một cho đầu ra của các embedding, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng `(batch_size, sequence_length, hidden_size)`.

  Trạng thái ẩn của bộ mã hóa tại đầu ra của mỗi lớp cùng với đầu ra của nhúng ban đầu.
- **encoder_attentions** (`tuple(torch.Tensor)`, *tùy chọn*, được trả về khi `output_attentions=True` được truyền vào hoặc khi `config.output_attentions=True`) -- Bộ tuple của `torch.Tensor` (một cho mỗi lớp) có hình dạng `(batch_size, num_heads, sequence_length, sequence_length)`.

  Trọng số chú ý của bộ mã hóa, sau softmax chú ý, được sử dụng để tính trung bình có trọng số trong các đầu chú ý tự thân.

Ví dụ:
```python
>>> 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])
```