# MusicGen

## 概要

MusicGenモデルは、Jade Copet、Felix Kreuk、Itai Gat、Tal Remez、David Kant、Gabriel Synnaeve、Yossi Adi、Alexandre Défossez による論文 [Simple and Controllable Music Generation](https://huggingface.co/papers/2306.05284) で提案されました。

MusicGenは、テキストの説明やオーディオのプロンプトを条件として、高品質な音楽サンプルを生成できる単一段階の自己回帰型Transformerモデルです。テキストの説明は、凍結されたテキストエンコーダーモデルを介して処理され、隠れ状態の表現のシーケンスが得られます。その後、MusicGenはこれらの隠れ状態を条件として、離散オーディオトークン、すなわち*オーディオコード*を予測するように学習されます。これらのオーディオトークンは、EnCodecなどのオーディオ圧縮モデルを使用してデコードされ、オーディオ波形が復元されます。

効率的なトークンインターリーブパターンにより、MusicGenはテキスト/オーディオプロンプトの自己教師ありセマンティック表現を必要としません。これにより、コードブックのセットを予測するために複数のモデルをカスケード接続する（階層的に、またはアップサンプリングを行うなど）必要がなくなります。代わりに、単一のフォワードパスですべてのコードブックを生成できます。

論文の抄録は以下の通りです。

*本稿では、条件付き音楽生成タスクに取り組む。我々は、圧縮された離散音楽表現（すなわちトークン）の複数のストリーム上で動作する単一の言語モデル（LM）である MusicGen を提案する。先行研究とは異なり、MusicGen は単一ステージの Transformer LM と効率的なトークンインターリーブパターンで構成されており、階層的な処理やアップサンプリングなど、複数のモデルをカスケードさせる必要を排除する。このアプローチにより、MusicGen がテキストの説明やメロディックな特徴を条件として、高品質なサンプルを生成できることを示す。これにより、生成される出力に対するより良い制御が可能となる。標準的なテキストから音楽への生成ベンチマークにおいて、提案手法が評価対象のベースラインを上回ることを、自動評価と人間による評価の両方を用いた広範な実証評価を通じて示す。さらに、アブレーションスタディを通じて、MusicGen を構成する各コンポーネントの重要性を明らかにする。*

このモデルは [sanchit-gandhi](https://huggingface.co/sanchit-gandhi) によって提供されました。元のコードは [こちら](https://github.com/facebookresearch/audiocraft) で確認できます。事前学習済みチェックポイントは [Hugging Face Hub](https://huggingface.co/models?sort=downloads&search=facebook%2Fmusicgen-) で利用できます。

## 使用のコツ

- [こちら](https://github.com/facebookresearch/audiocraft/blob/main/docs/MUSICGEN.md#importing--exporting-models)から元のチェックポイントをダウンロードした後、**変換スクリプト**を使用して変換できます。
以下のコマンドで`src/transformers/models/musicgen/convert_musicgen_transformers.py`を実行します:

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

## 生成

MusicGenは、greedyとsamplingの2つの生成モードに対応しています。実際には、samplingはgreedyよりもはるかに良い結果をもたらすため、可能な限りsamplingモードの使用を推奨します。samplingはデフォルトで有効になっており、`MusicgenForConditionalGeneration.generate()`の呼び出しで`do_sample=True`を設定するか、モデルの生成設定を上書きすること（下記参照）によって明示的に指定できます。

Generationは正弦波位置埋め込みにより30秒の入力に制限されています。つまり、MusicGenは30秒（1503トークン）を超えるオーディオを生成できません。また、Audio-Prompted Generationで渡される入力オーディオもこの制限にカウントされるため、20秒のオーディオを入力した場合、MusicGenは追加で10秒を超えるオーディオを生成できません。

Transformersは、MusicGenのモノラル（1チャネル）版とステレオ（2チャネル）版の両方をサポートしています。モノラル版は1セットのコードブックを生成します。ステレオ版は2セットのコードブックを生成し、それぞれが1チャネル（左/右）に対応します。各コードブックセットは、オーディオ圧縮モデルを通じて独立してデコードされます。各チャネルのオーディオストリームが結合され、最終的なステレオ出力が得られます。

### 無条件生成

無条件（または「null」）生成の入力は、メソッド`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)
```

オーディオ出力は、`(batch_size, num_channels, sequence_length)` の形状を持つ3次元の Torch テンソルです。生成されたオーディオサンプルを再生するには、ipynb ノートブックで再生するか、

```python
from IPython.display import Audio

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

または、`scipy`などのサードパーティ製ライブラリを使用して`.wav`ファイルとして保存します:

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

### テキスト条件付き生成

モデルは、[MusicgenProcessor](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenProcessor) を使用して入力を前処理することで、テキストプロンプトに条件付けられた音声サンプルを生成できます:

```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` は、classifier free guidance (CFG) で使用され、条件付き logits（テキストプロンプトから予測されるもの）と無条件 logits（無条件または「null」プロンプトから予測されるもの）の間の重みを設定します。guidance scale を高くすると、モデルは入力プロンプトとより密接に関連するサンプルを生成するようになり、通常は音声品質の低下を伴います。CFG は `guidance_scale > 1` を設定することで有効になります。最適な結果を得るには、`guidance_scale=3`（デフォルト）を使用してください。

### オーディオプロンプトによる生成

同じ[MusicgenProcessor](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenProcessor)を使用して、オーディオ継続に使用されるオーディオプロンプトの前処理を行うことができます。次の例では、以下のコマンドでpipインストールできる🤗 Datasetsライブラリを使用してオーディオファイルを読み込みます。

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

バッチ処理による音声プロンプト付き生成では、[MusicgenProcessor](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenProcessor) クラスを使用して後処理を行うことで、生成された`audio_values`からパディングを除去できます。

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

### 生成設定

サンプリング、ガイダンススケール、生成トークン数など、生成プロセスを制御するデフォルトのパラメータは、モデルの生成設定に格納されており、必要に応じて更新できます。

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

generate メソッドに渡される引数は、generation config の設定を**上書き**します。したがって、generate の呼び出しで`do_sample=False`を設定すると、generation config 内の`model.generation_config.do_sample`の設定が上書きされます。

## モデル構造

MusicGenモデルは、3つの異なる段階に分解できます。

1. Text encoder: テキスト入力を、隠れ状態の表現のシーケンスにマッピングします。事前学習済みの MusicGen モデルは、T5 または Flan-T5 のいずれかの凍結された text encoder を使用しています。
2. MusicGen デコーダー: エンコーダーの隠れ状態表現を条件として、オートレグレッシブにオーディオトークン（またはコード）を生成する言語モデル（LM）
3. Audio encoder/decoder: プロンプトとして使用するトークンにオーディオプロンプトをエンコードし、デコーダーが予測したオーディオトークンからオーディオ波形を復元するために使用されます

したがって、MusicGenモデルは、クラス[MusicgenForCausalLM](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenForCausalLM)に対応する単体のデコーダーモデルとして、またはテキストエンコーダーとオーディオエンコーダー/デコーダーを含む複合モデルとして、クラス[MusicgenForConditionalGeneration](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenForConditionalGeneration)に対応して使用できます。デコーダーのみを事前学習済みチェックポイントから読み込む必要がある場合は、まず正しいconfigを指定して読み込むか、複合モデルの`.decoder`属性を介してアクセスできます。

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

学習中はテキストエンコーダーとオーディオエンコーダー/デコーダーモデルが固定されるため、MusicGenデコーダーの[MusicgenForCausalLM](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenForCausalLM)は、エンコーダーの隠れ状態とオーディオコードのデータセット上で単独で学習できます。推論時には、学習済みデコーダーを固定されたテキストエンコーダーおよびオーディオエンコーダー/デコーダーと組み合わせることで、複合モデルである[MusicgenForConditionalGeneration](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenForConditionalGeneration)を再構築できます。

ヒント:

* MusicGen は、Encodec の 32kHz チェックポイントで学習されています。互換性のあるバージョンの Encodec モデルを使用することを確認してください。
* Sampling モードは greedy よりも良い結果をもたらす傾向があります。`MusicgenForConditionalGeneration.generate()` の呼び出し内で変数 `do_sample` を切り替えることで、sampling を有効化できます。

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/configuration_musicgen.py#L30)

**パラメータ:**

vocab_size (`int`、*任意*、デフォルトは`2048`) : モデルの語彙サイズ。`input_ids`で表現できるトークンの種類数を定義します。

max_position_embeddings (`int`、*任意*、デフォルトは`2048`)：このモデルが使用される可能性のある最大シーケンス長です。

num_hidden_layers (`int`、*optional*、デフォルトは `24`) : Transformer デコーダーの隠れ層の数。

ffn_dim (`int`、*任意*、デフォルトは`4096`) : MLP 表現の次元数。

num_attention_heads (`int`、*任意*、デフォルトは`16`) : Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。

layerdrop (`Union[float, int]`、*任意*、デフォルトは `0.0`) : LayerDrop の確率です。詳細については、[LayerDrop の論文](see https://huggingface.co/papers/1909.11556)を参照してください。

use_cache (`bool`、*任意*、デフォルトは `True`) : モデルが最後のキー/バリューアテンションを返すかどうか（すべてのモデルで利用されるわけではありません）。`config.is_decoder=True` の場合、またはモデルがデコーダー専用の生成モデルである場合にのみ関連します。

activation_function (`str`、*任意*、デフォルトは`gelu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"`など。

hidden_size (`int`、*任意*、デフォルトは`1024`) : 隠れ表現の次元数。

dropout (`Union[float, int]`、*任意*、デフォルトは`0.1`) : すべての dropout 層の比率。

attention_dropout (`Union[float, int]`、*任意*、デフォルトは`0.0`) : 注意確率のドロップアウト率。

activation_dropout (`Union[float, int]`、*任意*、デフォルトは`0.0`) : 全結合層内の活性化に対する dropout 率。

initializer_factor (`float`、*任意*、デフォルトは `0.02`) : すべての重み行列を初期化する係数です（1 に保つ必要があります。初期化テスト用に内部で使用されます）。

scale_embedding (`bool`、*任意*、デフォルトは`False`) : sqrt(d_model) で割って埋め込みをスケーリングするかどうか。

num_codebooks (`int`、*optional*、デフォルトは`4`) : モデルが使用する並列コードブックの数。

audio_channels (`int`、*任意*、デフォルトは`1`) : 入力チャネル数。

pad_token_id (`int`, *任意*, デフォルトは `2048`) : 語彙内でパディングに使用されるトークンID。

bos_token_id (`int`、*optional*、デフォルトは`2048`) : 語彙内でストリームの開始に使用されるトークン ID。

eos_token_id (`Union[int, list[int]]`、*任意*) : 語彙内でストリームの終了に使用されるトークン ID。

tie_word_embeddings (`bool`, *任意*, デフォルトは `False`) : モデルの `tied_weights_keys` マッピングに従って重み埋め込みを共有するかどうか。

is_decoder (`bool`, *任意*, デフォルトは `False`) : モデルがデコーダーとして使用されるかどうかを指定します。`False` の場合、モデルはエンコーダーとして使用されます。

add_cross_attention (`bool`、*任意*、デフォルトは`False`) : モデルにクロスアテンション層を追加するかどうか。

cross_attention_hidden_size (`int`, *optional*) : エンコーダーの出力の隠れ層サイズを、デコーダーのクロスアテンションのキー/バリュー空間に射影したサイズ。エンコーダーとデコーダーの隠れ層サイズが異なる場合に使用します。

これはMusicgenModelの設定を保存するための設定クラスです。指定された引数に基づいてMusicgenモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[facebook/musicgen-small](https://huggingface.co/facebook/musicgen-small)と類似した設定が得られます。

設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/configuration_musicgen.py#L83)

**パラメータ:**

text_encoder (`Union[dict, `PretrainedConfig`]`) : テキストエンコーダーの設定を定義する設定オブジェクトのインスタンス。

audio_encoder (`Union[dict, `PretrainedConfig`]`) : 音声エンコーダーの設定を定義する設定オブジェクトのインスタンス。

decoder (`Union[dict, `PretrainedConfig`]`) : デコーダー設定を定義する設定オブジェクトのインスタンス。

initializer_factor (`float`、*任意*、デフォルトは `0.02`) : すべての重み行列を初期化する係数です（1 に保つ必要があります。初期化テスト用に内部で使用されます）。

これはMusicgenModelの設定を保存するための設定クラスです。指定された引数に基づいてMusicgenモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[facebook/musicgen-small](https://huggingface.co/facebook/musicgen-small)と類似した設定が得られます。

設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。

例:

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/processing_musicgen.py#L27)

**パラメータ:**

feature_extractor (`EncodecFeatureExtractor`) : 特徴量抽出器は必須の入力です。

tokenizer (`T5Tokenizer`) : トークナイザーは必須の入力です。

を構築します。このクラスは、フィーチャーエクストラクターとトークナイザーを単一のプロセッサーにラップします。

[MusicgenProcessor](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenProcessor) は、[EncodecFeatureExtractor](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecFeatureExtractor) と [T5Tokenizer](/docs/transformers/main/ja/model_doc/t5#transformers.T5Tokenizer) のすべての機能を提供します。詳細については、[~EncodecFeatureExtractor](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecFeatureExtractor) および [~T5Tokenizer](/docs/transformers/main/ja/model_doc/t5#transformers.T5Tokenizer) を参照してください。

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

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/processing_musicgen.py#L34)

**パラメータ:**

return_tensors (`str` または [TensorType](/docs/transformers/main/ja/internal/file_utils#transformers.TensorType)、*optional*) : 設定されている場合、特定のフレームワークのテンソルを返します。受け入れ可能な値は以下の通りです:  - `'pt'`: PyTorch の `torch.Tensor` オブジェクトを返します。 - `'np'`: NumPy の `np.ndarray` オブジェクトを返します。

## MusicgenModel[[transformers.MusicgenModel]]

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

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L551)

**パラメータ:**

config ([MusicgenDecoderConfig](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenDecoderConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。

特定のヘッドを上に配置せずに、生の隠れ状態を出力する素の Musicgen モデル。

このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。

このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L564)

**パラメータ:**

input_ids (`torch.LongTensor`、shape `(batch_size * num_codebooks, sequence_length)`) : 語彙における入力シーケンスのトークンインデックス。音声コードのシーケンスに対応します。インデックスは、[EncodecModel](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel) などを使用して音声プロンプトを音声エンコーダーモデルでエンコードし、音声コードを予測することで取得できます。詳細は [EncodecModel.encode()](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel.encode) を参照してください。 [入力 ID とは何か？](../glossary#input-ids)    `input_ids` は、フォワードパスにおいて shape `(batch_size * num_codebooks, target_sequence_length)` から自動的に `(batch_size, num_codebooks, target_sequence_length)` に変換されます。[EncodecModel](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel) などの音声エンコーディングモデルから音声コードを取得する場合は、フレーム数が 1 であることを確認し、`input_ids` として渡す前に、音声コードを `(frames, batch_size, num_codebooks, target_sequence_length)` から `(batch_size * num_codebooks, target_sequence_length)` にリシェイプしてください。

attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます:  - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。  [attention マスクとは?](../glossary#attention-mask)

encoder_hidden_states (`torch.Tensor`、形状 `(batch_size, encoder_sequence_length, hidden_size)`、*任意*) : エンコーダーの最終層の出力における隠れ状態のシーケンス。デコーダーのクロスアテンションで使用されます。

encoder_attention_mask (`torch.LongTensor`、形状 `(batch_size, encoder_sequence_length)`、*任意*) : エンコーダーの input_ids のパディングトークンインデックスに対するクロスアテンションの実行を回避するためのマスク。`[0, 1]` から選択されるマスク値:  - **マスクされていない** トークンは 1、 - **マスクされている** トークンは 0。  [アテンションマスクとは?](../glossary#attention-mask)

past_key_values (`~cache_utils.Cache`, *任意*) : 逐次デコードを高速化するために使用できる、事前計算された hidden-states（self-attention ブロックおよび cross-attention ブロック内の key と value）です。通常、`use_cache=True` または `config.use_cache=True` の場合、モデルがデコードの以前の段階で返した `past_key_values` で構成されます。入力として許可されるのは [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) インスタンスのみです。[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。`past_key_values` が渡されない場合、デフォルトで [DynamicCache](/docs/transformers/main/ja/internal/generation_utils#transformers.DynamicCache) が初期化されます。モデルは、入力として与えられたのと同じキャッシュ形式を出力します。`past_key_values` を使用する場合は、すべての `input_ids`（形状 `(batch_size, sequence_length)`）の代わりに、このモデルに過去の key value 状態が与えられていない未処理の `input_ids`（形状 `(batch_size, unprocessed_length)`）のみを入力する必要があります。

inputs_embeds (`torch.Tensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。

use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。

**戻り値:** [BaseModelOutputWithPastAndCrossAttentions](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions) または `tuple(torch.Tensor)`

[BaseModelOutputWithPastAndCrossAttentions](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions)、または`torch.Tensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。設定（[MusicgenConfig](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenConfig)）や入力に応じて、さまざまな要素で構成されます。

[MusicgenModel](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。

この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。

- **last_hidden_state** (`torch.Tensor`、形状 `(batch_size, sequence_length, hidden_size)`) -- モデルの最終層の出力における隠れ状態のシーケンス。

  `past_key_values`が使用されている場合、出力されるのは、形状`(batch_size, 1, hidden_size)`のシーケンスの最後の隠れ状態のみです。
- **past_key_values** (`Cache`、*任意*、`use_cache=True` が渡された場合または `config.use_cache=True` の場合に返されます) -- [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) のインスタンスです。詳細については、[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。

  自己アテンションブロック（および `config.is_encoder_decoder=True` の場合、クロスカレンションブロック）の事前計算済みヒドゥンステート（キーとバリュー）を保持します。これらは逐次デコーディングを高速化するために使用できます（`past_key_values` 入力参照）。
- **hidden_states** (`tuple(torch.Tensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.Tensor` のタプル（モデルに埋め込み層がある場合はその出力用 1 つ、各層の出力用 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。

  各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。
- **attentions** (`tuple(torch.Tensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.Tensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。

  アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。
- **cross_attentions** (`tuple(torch.Tensor)`、*optional*、`output_attentions=True` と `config.add_cross_attention=True` が渡された場合、または `config.output_attentions=True` の場合に返されます) -- 各層に対応する `torch.Tensor` のタプルで、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。

  クロスアテンション層のアテンション重みは、アテンションのsoftmax適用後に計算され、クロスアテンションヘッドにおける加重平均の計算に使用されます。

## MusicgenForCausalLM[[transformers.MusicgenForCausalLM]]

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

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L628)

**パラメータ:**

config ([MusicgenDecoderConfig](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenDecoderConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。

言語モデリングヘッドを上部に備えた MusicGen デコーダーモデル。

このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。

このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L656)

**パラメータ:**

input_ids (`torch.LongTensor`、shape `(batch_size * num_codebooks, sequence_length)`) : 語彙における入力シーケンスのトークンインデックス。音声コードのシーケンスに対応します。インデックスは、[EncodecModel](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel) などを使用して音声プロンプトを音声エンコーダーモデルでエンコードし、音声コードを予測することで取得できます。詳細は [EncodecModel.encode()](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel.encode) を参照してください。 [入力 ID とは何か？](../glossary#input-ids)    `input_ids` は、フォワードパスにおいて shape `(batch_size * num_codebooks, target_sequence_length)` から自動的に `(batch_size, num_codebooks, target_sequence_length)` に変換されます。[EncodecModel](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel) などの音声エンコーディングモデルから音声コードを取得する場合は、フレーム数が 1 であることを確認し、`input_ids` として渡す前に、音声コードを `(frames, batch_size, num_codebooks, target_sequence_length)` から `(batch_size * num_codebooks, target_sequence_length)` にリシェイプしてください。

attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます:  - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。  [attention マスクとは?](../glossary#attention-mask)

encoder_hidden_states (`torch.Tensor`、形状 `(batch_size, encoder_sequence_length, hidden_size)`、*任意*) : エンコーダーの最終層の出力における隠れ状態のシーケンス。デコーダーのクロスアテンションで使用されます。

encoder_attention_mask (`torch.LongTensor`、形状 `(batch_size, encoder_sequence_length)`、*任意*) : エンコーダーの input_ids のパディングトークンインデックスに対するクロスアテンションの実行を回避するためのマスク。`[0, 1]` から選択されるマスク値:  - **マスクされていない** トークンは 1、 - **マスクされている** トークンは 0。  [アテンションマスクとは?](../glossary#attention-mask)

past_key_values (`~cache_utils.Cache`, *任意*) : 逐次デコードを高速化するために使用できる、事前計算された hidden-states（self-attention ブロックおよび cross-attention ブロック内の key と value）です。通常、`use_cache=True` または `config.use_cache=True` の場合、モデルがデコードの以前の段階で返した `past_key_values` で構成されます。入力として許可されるのは [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) インスタンスのみです。[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。`past_key_values` が渡されない場合、デフォルトで [DynamicCache](/docs/transformers/main/ja/internal/generation_utils#transformers.DynamicCache) が初期化されます。モデルは、入力として与えられたのと同じキャッシュ形式を出力します。`past_key_values` を使用する場合は、すべての `input_ids`（形状 `(batch_size, sequence_length)`）の代わりに、このモデルに過去の key value 状態が与えられていない未処理の `input_ids`（形状 `(batch_size, unprocessed_length)`）のみを入力する必要があります。

inputs_embeds (`torch.Tensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。

labels (`torch.LongTensor`、形状 `(batch_size, sequence_length, num_codebooks)`、*任意*) : 言語モデリング用のラベル。モデル内部でラベルは**シフト**されるため、`labels = input_ids` と設定できます。インデックスは `[-100, 0, ..., config.vocab_size]` から選択されます。`-100` に設定されたすべてのラベルは無視（マスク）され、損失は `[0, ..., config.vocab_size]` 内のラベルに対してのみ計算されます。

use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。

**戻り値:** [CausalLMOutputWithCrossAttentions](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.CausalLMOutputWithCrossAttentions) または `tuple(torch.Tensor)`

[MusicgenConfig](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenConfig) や入力に応じて、さまざまな要素で構成される [CausalLMOutputWithCrossAttentions](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.CausalLMOutputWithCrossAttentions) または `torch.Tensor` のタプル（`return_dict=False` が渡された場合、または `config.return_dict=False` の場合）。

[MusicgenForCausalLM](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenForCausalLM)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。

この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。

- **loss** (`torch.Tensor`、形状 `(1,)`、*任意*、`labels` が指定された場合に返されます) -- 言語モデリングの損失(次のトークンの予測用)。
- **logits** (`torch.Tensor`、形状 `(batch_size, sequence_length, config.vocab_size)`) -- 言語モデリングヘッドの予測スコア（SoftMax 適用前の各語彙トークンのスコア）。
- **hidden_states** (`tuple(torch.Tensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.Tensor` のタプル（モデルに埋め込み層がある場合はその出力用 1 つ、各層の出力用 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。

  各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。
- **attentions** (`tuple(torch.Tensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.Tensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。

  アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。
- **cross_attentions** (`tuple(torch.Tensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.Tensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。

  クロスアテンションのsoftmax後の重み。クロスアテンションヘッドにおける加重平均の計算に使用されます。
- **past_key_values** (`Cache`、*任意*、`use_cache=True` が渡された場合または `config.use_cache=True` の場合に返されます) -- [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) のインスタンスです。詳細については、[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。

  シーケンシャルなデコーディングを高速化するために使用できる（`past_key_values` 入力参照）、事前計算済みの hidden-states（アテンションブロック内のキーとバリュー）が含まれます。

例:

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L1104)

**パラメータ:**

config ([MusicgenConfig](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenConfig)、*任意*) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。

text_encoder (`PreTrainedModel`, *任意*) : テキストを条件付け用の隠れ状態にエンコードするテキストエンコーダーモデルです。

audio_encoder (`PreTrainedModel`, *任意*) : 条件付けのために、オーディオを隠れ状態にエンコードするオーディオエンコーダーモデルです。

decoder (`MusicgenForCausalLM`, *任意*) : 条件信号に基づいてオーディオトークンを生成するデコーダーモデル。

テキストエンコーダー、オーディオエンコーダー、Musicgenデコーダーを備えた複合Musicgenモデル、

このモデルは [PreTrainedModel](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel) を継承しています。ライブラリがすべてのモデルに対して実装している汎用的なメソッド（ダウンロードや保存、入力埋め込みのリサイズ、ヘッドのプルーニングなど）については、スーパークラスのドキュメントを参照してください。

このモデルは、PyTorchの[torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module)のサブクラスでもあります。通常のPyTorch Moduleとして使用し、一般的な使用方法や動作に関する詳細については、PyTorchのドキュメントを参照してください。

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

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/musicgen/modeling_musicgen.py#L1420)

**パラメータ:**

input_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 語彙における入力シーケンスのトークンインデックスです。デフォルトでは、パディングは無視されます。インデックスは [AutoTokenizer](/docs/transformers/main/ja/model_doc/auto#transformers.AutoTokenizer) を使用して取得できます。詳細については、[PreTrainedTokenizer.encode()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) および [PreTrainedTokenizer.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) を参照してください。 [入力IDとは何ですか？](../glossary#input-ids)

attention_mask (`torch.BoolTensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスク。`[0, 1]` から選択されるマスクの値:  - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。  [attention マスクとは?](../glossary#attention-mask)

input_values (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : 入力生の音声波形の浮動小数点数値。値は、`.flac` または `.wav` 形式のオーディオファイルを `list[float]` 型、`numpy.ndarray` 型、または `torch.Tensor` 型の配列として読み込むことで取得できます。*例えば*、torchcodec ライブラリ（`pip install torchcodec`）や soundfile ライブラリ（`pip install soundfile`）を通じて行います。`input_values` として配列を準備するには、パディングと `torch.Tensor` 型への変換のために [AutoProcessor](/docs/transformers/main/ja/model_doc/auto#transformers.AutoProcessor) を使用してください。詳細は [MusicgenProcessor.__call__()](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenProcessor.__call__) を参照してください。

padding_mask (`torch.BoolTensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスク。`[0, 1]` から選択されるマスクの値:  - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。  [attention マスクとは?](../glossary#attention-mask)

decoder_input_ids (`torch.LongTensor`、shape `(batch_size * num_codebooks, target_sequence_length)`、*optional*) : 語彙におけるデコーダー入力シーケンスのトークンインデックスで、オーディオコードのシーケンスに対応します。インデックスは、[EncodecModel](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel) などを使用してオーディオプロンプトをオーディオエンコーダーモデルでエンコードし、オーディオコードを予測することで取得できます。詳細は [EncodecModel.encode()](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel.encode) を参照してください。 [デコーダー入力 ID とは？](../glossary#decoder-input-ids)    `decoder_input_ids` は、フォワードパスにおいて shape `(batch_size * num_codebooks, target_sequence_length)` から `(batch_size, num_codebooks, target_sequence_length)` に自動的に変換されます。[EncodecModel](/docs/transformers/main/ja/model_doc/encodec#transformers.EncodecModel) などのオーディオエンコーディングモデルからオーディオコードを取得する場合は、フレーム数が 1 であることを確認し、`decoder_input_ids` として渡す前に、オーディオコードを `(frames, batch_size, num_codebooks, target_sequence_length)` から `(batch_size * num_codebooks, target_sequence_length)` にリシェイプしてください。

decoder_attention_mask (`torch.LongTensor`、形状 `(batch_size, target_sequence_length)`、*任意*) : デフォルトの動作: `decoder_input_ids` 内の pad トークンを無視するテンソルを生成します。デフォルトでは、causal mask も使用されます。

encoder_outputs (`tuple[torch.Tensor]`, *任意*) : (`last_hidden_state`, *任意*: `hidden_states`, *任意*: `attentions`) のタプル。`last_hidden_state` は形状 `(batch_size, sequence_length, hidden_size)` を持ち、エンコーダーの最終層の出力における隠れ状態のシーケンスです。*任意*) デコーダーのクロスアテンションで使用されます。

past_key_values (`~cache_utils.Cache`, *任意*) : 逐次デコードを高速化するために使用できる、事前計算された hidden-states（self-attention ブロックおよび cross-attention ブロック内の key と value）です。通常、`use_cache=True` または `config.use_cache=True` の場合、モデルがデコードの以前の段階で返した `past_key_values` で構成されます。入力として許可されるのは [Cache](/docs/transformers/main/ja/internal/generation_utils#transformers.Cache) インスタンスのみです。[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。`past_key_values` が渡されない場合、デフォルトで [DynamicCache](/docs/transformers/main/ja/internal/generation_utils#transformers.DynamicCache) が初期化されます。モデルは、入力として与えられたのと同じキャッシュ形式を出力します。`past_key_values` を使用する場合は、すべての `input_ids`（形状 `(batch_size, sequence_length)`）の代わりに、このモデルに過去の key value 状態が与えられていない未処理の `input_ids`（形状 `(batch_size, unprocessed_length)`）のみを入力する必要があります。

inputs_embeds (`torch.Tensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。

decoder_inputs_embeds (`torch.Tensor`、shape `(batch_size, target_sequence_length, hidden_size)`、*任意*) : `decoder_input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。`past_key_values` を使用する場合、`decoder_inputs_embeds` の最後の部分のみを入力すればよい場合があります（`past_key_values` を参照）。`decoder_input_ids` のインデックスを関連するベクトルに変換する方法を、モデル内部の埋め込みルックアップ行列よりも細かく制御したい場合に便利です。 `decoder_input_ids` と `decoder_inputs_embeds` の両方が設定されていない場合、`decoder_inputs_embeds` は `inputs_embeds` の値を採ります。

labels (`torch.LongTensor`、形状 `(batch_size, sequence_length, num_codebooks)`、*任意*) : 言語モデリング用のラベル。モデル内部でラベルは**シフト**されるため、`labels = input_ids` と設定できます。インデックスは `[-100, 0, ..., config.vocab_size]` から選択されます。`-100` に設定されたすべてのラベルは無視（マスク）され、損失は `[0, ..., config.vocab_size]` 内のラベルに対してのみ計算されます。

use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。

**戻り値:** [Seq2SeqLMOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput) または `tuple(torch.Tensor)`

設定（[MusicgenConfig](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenConfig)）や入力に応じて、さまざまな要素で構成される、[Seq2SeqLMOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput)または`torch.Tensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。

[MusicgenForConditionalGeneration](/docs/transformers/main/ja/model_doc/musicgen#transformers.MusicgenForConditionalGeneration)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。

この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。

- **loss** (`torch.Tensor`、形状 `(1,)`、*任意*、`labels` が指定された場合に返されます) -- 言語モデリングの損失。
- **logits** (`torch.Tensor`、形状 `(batch_size, sequence_length, config.vocab_size)`) -- 言語モデリングヘッドの予測スコア（SoftMax 適用前の各語彙トークンのスコア）。
- **past_key_values** (`EncoderDecoderCache`、*任意*、`use_cache=True` が渡された場合または `config.use_cache=True` の場合に返されます) -- [EncoderDecoderCache](/docs/transformers/main/ja/internal/generation_utils#transformers.EncoderDecoderCache) のインスタンスです。詳細については、[kv cache ガイド](https://huggingface.co/docs/transformers/en/kv_cache)を参照してください。

  逐次デコーディングを高速化するために使用できる（`past_key_values` 入力参照）、事前計算済みの隠れ状態（自己アテンションブロックおよびクロスアテンションブロックのキーとバリュー）が含まれます。
- **decoder_hidden_states** (`tuple(torch.Tensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.Tensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用 1 つ + 各層の出力用 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。

  各層の出力および初期埋め込み出力における、デコーダーの隠れ状態。
- **decoder_attentions** (`tuple(torch.Tensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.Tensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。

  自己アテンションヘッドにおける加重平均を計算するために使用される、アテンションのsoftmax後のデコーダーのアテンション重み。
- **cross_attentions** (`tuple(torch.Tensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.Tensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。

  クロスアテンション層のアテンション重みは、アテンションのsoftmax適用後に計算され、クロスアテンションヘッドにおける加重平均の計算に使用されます。
- **encoder_last_hidden_state** (`torch.Tensor`、形状 `(batch_size, sequence_length, hidden_size)`、*任意*) -- モデルのエンコーダーの最終層の出力における隠れ状態のシーケンス。
- **encoder_hidden_states** (`tuple(torch.Tensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.Tensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用 1 つ + 各層の出力用 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。

  各層の出力および初期埋め込み出力におけるエンコーダーの隠れ状態。
- **encoder_attentions** (`tuple(torch.Tensor)`、*任意*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- 各レイヤーごとに 1 つの `torch.Tensor` からなるタプルで、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。

  アテンションのsoftmaxを適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。

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