# Muse Spark Open ## 概要 Muse Spark Openは、Metaが開発したマルチモーダルなmixture-of-experts (MoE)モデルです。テキスト、画像、音声、動画をインプットとして受け取り、テキストを生成します。総パラメータ数は8160億、トークンごとにアクティブなパラメータ数は420億で、すべての入力モダリティにわたって最大1,048,576トークンまでのコンテキストウィンドウをサポートします。このモデルは、マルチファイルのコード編集、デバッグ、ツール利用を含むエージェント型コーディングタスクのために学習されています。 言語バックボーンは62層のtransformer層で構成され、各層がトークンを256のエクスパートのうち8つにルーティングします。クエリ・キー正規化、アテンション出力ゲーティングおよび正規化、学習済み残差ゲートを備えたgrouped-query attentionを使用しています。共有パーセプションエンコーダーが画像と動画フレームを処理し、畳み込み型オーディオエンコーダーが1秒あたり12.5トークンのオーディオ表現を生成します。[Muse Glimmer](./muse_glimmer)とトークナイザーおよび語彙を共有し、マルチモーダル入力に対応するようチャットテンプレートが拡張されています。チェックポイントはBF16および[NVFP4形式](#nvfp4-weights)で利用可能です。 ## リソース - [Hugging Face コレクション](https://huggingface.co/collections/meta-models/muse-spark-open) - [Hugging Face ブログ](http://hf.co/blog/meta-muse-spark-open) - [TRLでポストトレーニング](https://github.com/huggingface/trl/tree/main/examples/sft_muse_spark_open) ```python import os from transformers import AutoModelForMultimodalLM, AutoProcessor, DistributedConfig distributed_config = DistributedConfig( tp_size=int(os.environ["WORLD_SIZE"]), # Number of devices across which the dense layers are sharded ep_size=int(os.environ["WORLD_SIZE"]), # Number of devices across which the experts are distributed ) processor = AutoProcessor.from_pretrained("meta-models/Muse-Spark-Open-816B-A42B") model = AutoModelForMultimodalLM.from_pretrained( "meta-models/Muse-Spark-Open-816B-A42B", distributed_config=distributed_config, ) messages = [ {"role": "user", "content": "Explain in one sentence why the sky is usually blue."}, ] inputs = processor.apply_chat_template( messages, reasoning_effort="low", # default: xhigh, options: low/medium/high/xhigh add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device).to(model.dtype) input_len = inputs["input_ids"].shape[-1] outputs = model.generate(**inputs, max_new_tokens=512) print(processor.decode(outputs[0][input_len:], skip_special_tokens=False)) # to=self<|message|>Explain in one sentence why the sky is usually blue. # ... # <|eom|><|start|>assistant to=user<|message|>The sky is usually blue because molecules in Earth's atmosphere scatter shorter-wavelength blue sunlight in all directions much more strongly than longer-wavelength red light.<|eot|> ``` ```python import os from transformers import AutoModelForMultimodalLM, AutoProcessor, DistributedConfig distributed_config = DistributedConfig( tp_size=int(os.environ["WORLD_SIZE"]), ep_size=int(os.environ["WORLD_SIZE"]), ) processor = AutoProcessor.from_pretrained("meta-models/Muse-Spark-Open-816B-A42B") model = AutoModelForMultimodalLM.from_pretrained( "meta-models/Muse-Spark-Open-816B-A42B", distributed_config=distributed_config, ) messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/pipeline-cat-chonk.jpeg"}, {"type": "text", "text": "What is shown in this image?"}, ], }, ] inputs = processor.apply_chat_template( messages, reasoning_effort="medium", # default: xhigh, options: low/medium/high/xhigh add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device).to(model.dtype) input_len = inputs["input_ids"].shape[-1] outputs = model.generate(**inputs, max_new_tokens=512) response = processor.decode(outputs[0][input_len:], skip_special_tokens=False) print(response) # to=self<|message|>What is shown in this image? # ... # <|eom|><|start|>assistant to=user<|message|>The image shows a **Pallas's cat — also known as a manul, *Otocolobus manul*** — walking through snow. # # It is a small, stocky wild cat recognizable by: # # * **Its extremely dense, long, greyish-brown winter coat** with faint dark stripes and a dusting of snow on its back # * **Its flat, broad face** with low-set ears, a short muzzle, and dark stripes on the cheeks # * **Its short legs and thick, plump body** adapted for cold climates # # The cat is captured mid-stride on a snow-covered surface, with one front paw lifted. In the background are white birch tree trunks with black markings and a chain-link fence on the left, indicating the animal is in a zoo or wildlife enclosure in winter.<|eot|> ``` ```python import os from transformers import AutoModelForMultimodalLM, AutoProcessor, DistributedConfig distributed_config = DistributedConfig( tp_size=int(os.environ["WORLD_SIZE"]), ep_size=int(os.environ["WORLD_SIZE"]), ) processor = AutoProcessor.from_pretrained("meta-models/Muse-Spark-Open-816B-A42B") model = AutoModelForMultimodalLM.from_pretrained( "meta-models/Muse-Spark-Open-816B-A42B", distributed_config=distributed_config, ) messages = [ { "role": "user", "content": [ {"type": "video", "url": "https://huggingface.co/datasets/hf-internal-testing/fixtures_videos/resolve/main/tennis.mp4"}, {"type": "text", "text": "What is happening in this video?"}, ], }, ] inputs = processor.apply_chat_template( messages, reasoning_effort="medium", # default: xhigh, options: low/medium/high/xhigh processor_kwargs={ "fps": 2, # default: 2, number of frames sampled per second "num_frames": 8, # default: 94, maximum number of frames sampled from the video }, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device).to(model.dtype) input_len = inputs["input_ids"].shape[-1] outputs = model.generate(**inputs, max_new_tokens=512) print(processor.decode(outputs[0][input_len:], skip_special_tokens=False)) # to=self<|message|>What is happening in this video? # ... # <|eom|><|start|>assistant to=user<|message|>In this video two people are playing tennis on an indoor court. # # The shot is taken from behind one of the players - a man in a white t-shirt, black shorts and white shoes and socks. He is standing near the baseline on an orange hard court with white lines, in a ready position with his knees bent and his racket held in front of him. # # Across the net, on the far side of the court, is his opponent, also dressed in light-colored clothing. # # The sequence shows a short rally: # # * The opponent hits the ball over the net. # * The man in the foreground shuffles to his left, turns his body, and prepares for a shot. # * He executes a two-handed backhand, swinging the racket across his body and following through as he hits the ball back over the net. # # The setting is a large indoor tennis hall with a high, arched ceiling with exposed wooden beams and overhead fluorescent lights. The court is surrounded by a grey run-off area, green windscreening on the walls, and netting that separates it from adjacent courts. On the right side you can see an umpire's chair and a few yellow and black benches. An "Adobe Stock" watermark is visible in the center of the frame.<|eot|> ``` ```python import os from transformers import AutoModelForMultimodalLM, AutoProcessor, DistributedConfig distributed_config = DistributedConfig( tp_size=int(os.environ["WORLD_SIZE"]), ep_size=int(os.environ["WORLD_SIZE"]), ) processor = AutoProcessor.from_pretrained("meta-models/Muse-Spark-Open-816B-A42B") model = AutoModelForMultimodalLM.from_pretrained( "meta-models/Muse-Spark-Open-816B-A42B", distributed_config=distributed_config, ) messages = [ { "role": "user", "content": [ {"type": "audio", "url": "https://huggingface.co/datasets/hf-internal-testing/dummy-audio-samples/resolve/main/glass_breaking.mp3"}, {"type": "text", "text": "What is said in this recording?"}, ], }, ] inputs = processor.apply_chat_template( messages, reasoning_effort="low", # default: xhigh, options: low/medium/high/xhigh processor_kwargs={"sampling_rate": 24000}, # sampling rate the model was trained with add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device).to(model.dtype) input_len = inputs["input_ids"].shape[-1] outputs = model.generate(**inputs, max_new_tokens=512) print(processor.decode(outputs[0][input_len:], skip_special_tokens=False)) # to=self<|message|>We need to respond to user request: "What is said in this recording?" # ... # <|eom|><|start|>assistant to=user<|message|>In the recording the person says: # # > "Just picked up this glass and the people at the store told me that if I dropped it it wouldn't break." # # Then the glass is dropped and shatters.<|eot|> ``` ## NVFP4 重み メモリ要件が低いNVFP4 [量子化重み](https://huggingface.co/meta-models/Muse-Spark-Open-816B-A42B-NVFP4)がハブで利用可能です。コードを変更することなく、NVFP4対応の任意のデバイスでモデルを読み込むことができます。量子化設定は読み込み時に自動的に適用されます。 > [!IMPORTANT] > NVFP4のサポートには、[このブランチ](https://github.com/huggingface/transformers/pull/49015)からtransformersをインストールする必要があります。 > > ```bash > pip install git+https://github.com/huggingface/transformers.git@finegrained-per-scheme-demo > ``` ```python import os from transformers import AutoModelForMultimodalLM, AutoProcessor, DistributedConfig distributed_config = DistributedConfig( tp_size=int(os.environ["WORLD_SIZE"]), ep_size=int(os.environ["WORLD_SIZE"]), ) processor = AutoProcessor.from_pretrained("meta-models/Muse-Spark-Open-816B-A42B-NVFP4") model = AutoModelForMultimodalLM.from_pretrained( "meta-models/Muse-Spark-Open-816B-A42B-NVFP4", distributed_config=distributed_config, ) # ... ``` ## MuseSparkConfig[[transformers.MuseSparkConfig]] #### transformers.MuseSparkConfig[[transformers.MuseSparkConfig]] ```python transformers.MuseSparkConfig(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_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, vision_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, image_token_id: int = 200092, video_token_id: int = 200091, out_hidden_size: int = 6144, projector_hidden_size: int = 4096, projector_hidden_act: str = 'gelu', audio_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, audio_token_id: int = 200038) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/configuration_muse_spark.py#L251) **パラメータ:** text_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`, *任意*) : テキストバックボーンの config オブジェクトまたは辞書。 vision_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`, *任意*) : ビジョンバックボーンの config オブジェクトまたは辞書。 image_token_id (`int`、*optional*、デフォルトは`200092`) : 入力画像のプレースホルダーとして使用される画像トークンのインデックス。 video_token_id (`int`、*任意*、デフォルトは`200091`) : 入力動画のプレースホルダーとして使用される動画トークンのインデックス。 out_hidden_size (`int`、*optional*、デフォルトは 6144) : パッチマージ後のビジョンエンコーダーの出力次元（マルチモーダル投影の入力幅）。 projector_hidden_size (`int`、*optional*、デフォルトは 4096) : マルチモーダル投影の中間次元数。 projector_hidden_act (`str`、*任意*、デフォルトは `gelu`) : マルチモーダルプロジェクターで使用する活性化関数。 audio_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`, *任意*) : 音声バックボーンの config オブジェクトまたは辞書。 audio_token_id (`int`、*optional*、デフォルトは`200038`) : 入力音声のプレースホルダーとして使用されるオーディオトークンのインデックス。 これはMuseSparkModelの設定を保存するための設定クラスです。指定された引数に基づいてMuse Sparkモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[meta-models/Muse-Spark-Open-816B-A42B](https://huggingface.co/meta-models/Muse-Spark-Open-816B-A42B)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 例: ```python >>> from transformers import MuseSparkForConditionalGeneration, MuseSparkConfig >>> # Initializing an MuseSpark style configuration >>> configuration = MuseSparkConfig() >>> # Initializing a model from the configuration >>> model = MuseSparkForConditionalGeneration(configuration) >>> # Accessing the model configuration >>> configuration = model.config ``` ## MuseSparkTextConfig[[transformers.MuseSparkTextConfig]] #### transformers.MuseSparkTextConfig[[transformers.MuseSparkTextConfig]] ```python transformers.MuseSparkTextConfig(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 = 202048, hidden_size: int = 8192, intermediate_size: int = 16384, num_hidden_layers: int = 62, num_attention_heads: int = 128, num_key_value_heads: int = 16, head_dim: int = 64, max_position_embeddings: int = 1048576, initializer_range: float = 0.02, rms_norm_eps: float = 1e-05, use_cache: bool = True, pad_token_id: int | None = None, eos_token_id: int | list[int] | None = 200001, bos_token_id: int | None = 200000, tie_word_embeddings: bool = False, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, attention_bias: bool = False, attention_dropout: int | float | None = 0.0, sliding_window: int | None = 2048, layer_types: list[str] | None = None, final_logit_softcapping: float = 20.0, qk_scale_factor: float = 5.4730064863875, output_multiplier: float = 0.1767766952966369, post_norm_eps: float = 1e-08, layer_rope_theta: list[float | int] | None = None, hidden_act: str = 'silu', moe_intermediate_size: int = 4096, num_local_experts: int = 256, num_experts_per_tok: int = 8, routed_scaling_factor: float = 1.0, moe_hidden_size: int = 4096, mlp_layer_types: list[str] | None = None, residual_gate_temperature: float = 0.3, output_router_logits: bool = False) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/configuration_muse_spark.py#L75) **パラメータ:** vocab_size (`int`、*任意*、デフォルトは`202048`) : モデルの語彙サイズ。`input_ids`で表現できるトークンの種類数を定義します。 hidden_size (`int`、*任意*、デフォルトは`8192`) : 隠れ表現の次元数。 intermediate_size (`int`, *任意*, デフォルトは `16384`) : MLP 表現の次元数。 num_hidden_layers (`int`、*任意*、デフォルトは`62`) : Transformer デコーダーの隠れ層の数。 num_attention_heads (`int`、*任意*、デフォルトは`128`) : Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。 num_key_value_heads (`int`, *任意*, デフォルトは `16`) : Grouped Query Attention を実装するために使用する key_value ヘッドの数です。`num_key_value_heads=num_attention_heads` の場合、モデルは Multi Head Attention (MHA) を使用し、`num_key_value_heads=1` の場合は Multi Query Attention (MQA) を使用し、それ以外の場合は GQA が使用されます。マルチヘッドのチェックポイントを GQA のチェックポイントに変換する際は、各グループの key ヘッドと value ヘッドは、そのグループ内の元のすべてのヘッドを平均プーリングして構築する必要があります。詳細については、[この論文](https://huggingface.co/papers/2305.13245)を参照してください。指定されない場合、デフォルトで `num_attention_heads` が使用されます。 head_dim (`int`、*任意*、デフォルトは`64`) : アテンションヘッドの次元数。None の場合、hidden_size // num_attention_heads がデフォルトとして使用されます。 max_position_embeddings (`int`、*任意*、デフォルトは `1048576`) : このモデルが使用される可能性のある最大シーケンス長です。 initializer_range (`float`、*任意*、デフォルトは`0.02`) : すべての重み行列を初期化するためのtruncated_normal_initializerの標準偏差です。 rms_norm_eps (`float`、*任意*、デフォルトは`1e-05`) : rms 正規化レイヤーで使用する epsilon。 use_cache (`bool`、*任意*、デフォルトは `True`) : モデルが最後のキー/バリューアテンションを返すかどうか（すべてのモデルで利用されるわけではありません）。`config.is_decoder=True` の場合、またはモデルがデコーダー専用の生成モデルである場合にのみ関連します。 pad_token_id (`int`, *任意*) : 語彙内でパディングに使用されるトークンID。 eos_token_id (`Union[int, list[int]]`、*任意*、デフォルトは`200001`) : 語彙内でストリームの終了に使用されるトークン ID。 bos_token_id (`int`, *任意*, デフォルトは `200000`) : 語彙内でストリームの開始に使用されるトークン ID。 tie_word_embeddings (`bool`, *任意*, デフォルトは `False`) : モデルの `tied_weights_keys` マッピングに従って重み埋め込みを共有するかどうか。 rope_parameters (`Union[~modeling_rope_utils.RopeParameters, dict]`, *optional*) : RoPE 埋め込みの設定パラメータを含む辞書です。この辞書には `rope_theta` の値が含まれていなければならず、より長い `max_position_embeddings` で RoPE を使用する場合、スケーリングに使用されるパラメータが任意で含まれます。 attention_bias (`bool`、*任意*、デフォルトは`False`) : セルフアテンションにおけるクエリ、キー、バリュー、出力の投影層でバイアスを使用するかどうか。 attention_dropout (`Union[int, float]`、*任意*、デフォルトは`0.0`) : 注意確率のドロップアウト率。 sliding_window (`int`、*任意*、デフォルトは`2048`) : スライディングウィンドウアテンションのウィンドウサイズ。`None`の場合、スライディングウィンドウは適用されません。 layer_types (`list[str]`、*任意*) : 各レイヤーのインデックスとそのレイヤータイプを明示的にマッピングするリストです。指定しない場合、config の値に基づいて自動的に生成されます。 final_logit_softcapping (`float`、*optional*、デフォルトは`20.0`) : 確率分布を計算する前に最終的なlogitsに適用されるソフトキャップの値。logitsは`tanh(logit / cap) * cap`によってスケーリングされます。 qk_scale_factor (`float`、*optional*、デフォルト値は 5.4730064863875) : スケールなしの QK-norm の後に Q に適用される乗数です。標準的な `1/sqrt(head_dim)` によるアテンションのスケーリングに加えて適用されます。 output_multiplier (`float`、*optional*、デフォルト値は 0.1767766952966369) : 最終的な tanh softcap を適用する前に logits に適用されるスケール。公開されているチェックポイントでは `1/sqrt(hidden_size / 256)` に等しい。 post_norm_eps (`float`、*optional*、デフォルトは 1e-8) : post-attention と post-FFN の norm（サブレイヤーの出力と残差の間に位置するもの）で使用する Epsilon。 layer_rope_theta (`list[float]`, *optional*) : 各レイヤーの RoPE ベース theta; `0` を設定すると、そのレイヤーの回転位置エンコーディング (NoPE) が無効になります。グローバルの `rope_parameters["rope_theta"]` を上書きします。デフォルトでは、最後のレイヤーから数えて 4 番目のレイヤーが NoPE になる以外は、すべてグローバルの theta が使用されます。 hidden_act (`str`、*任意*、デフォルトは`silu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"`など。 moe_intermediate_size (`int`, *optional*, デフォルトは `4096`) : ルーティングされたエキスパートのMLPの中間サイズ。 num_local_experts (`int`、*任意*、デフォルトは`256`) : 各デバイス上のローカルエキスパートの数。`num_experts`は`num_local_experts`で割り切れる必要があります。 num_experts_per_tok (`int`、*任意*、デフォルトは`8`) : 各トークンをルーティングするエキスパートの数です。これは、トークン選択ルーティングにおける top-k の値です。 routed_scaling_factor (`float`、*任意*、デフォルトは`1.0`) : スケーリング係数またはルーティングされたエキスパート。 moe_hidden_size (`int`, *optional*, デフォルトは 4096) : MoE ブロックが、ルーティングされたエキスパートの前に `hidden_size` をこの幅までプーリングし、その後にアンプーリングする幅です。エキスパートはこの幅で完全に動作します。 mlp_layer_types (`list[str]`、*任意*) : 層ごとの MLP タイプ — `"dense"` または `"sparse"`。長さは `num_hidden_layers` と等しくなければなりません。デフォルトではすべて sparse です。 residual_gate_temperature (`float`、*任意*、デフォルト値は 0.3) : シグモイド関数を適用する前に、残差ゲートパラメータに適用される温度。 output_router_logits (`bool`, *任意*, デフォルトは `False`) : モデルがルーターのロジスティック値を返すかどうかを指定します。これを有効にすると、モデルはロードバランシングロスやルーターのzロスを含む補助ロスの出力も可能になります。 これはMuseSparkModelの設定を保存するための設定クラスです。指定された引数に基づいてMuse Sparkモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[meta-models/Muse-Spark-Open-816B-A42B](https://huggingface.co/meta-models/Muse-Spark-Open-816B-A42B)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 ## MuseSparkVisionConfig[[transformers.MuseSparkVisionConfig]] #### transformers.MuseSparkVisionConfig[[transformers.MuseSparkVisionConfig]] ```python transformers.MuseSparkVisionConfig(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, patch_size: int = 14, pos_emb_height: int = 32, pos_emb_width: int = 32, num_attention_heads: int = 16, num_hidden_layers: int = 50, hidden_size: int = 1536, intermediate_size: int = 8960, hidden_act: str = 'gelu', rope_parameters: dict | None = None, patch_temporal: int = 2, merge_size: int = 2, max_position_embeddings: int = 1024, layer_norm_eps: float = 1e-05, layer_types: list[str] | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/configuration_muse_spark.py#L31) **パラメータ:** patch_size (`int`、*任意*、デフォルトは`14`) : 各パッチのサイズ（解像度）。 pos_emb_height (`int`, *任意*) : 初期の位置埋め込みの高さ。 pos_emb_width (`int`, *任意*) : 初期の位置埋め込みの幅。 num_attention_heads (`int`、*任意*、デフォルトは`16`) : Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。 num_hidden_layers (`int`、*optional*、デフォルトは`50`) : Transformer デコーダーの隠れ層の数。 hidden_size (`int`、*任意*、デフォルトは`1536`) : 隠れ表現の次元数。 intermediate_size (`int`, *optional*, デフォルトは `8960`) : MLP 表現の次元数。 hidden_act (`str`、*任意*、デフォルトは`gelu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"`など。 rope_parameters (`dict`, *任意*) : RoPE 埋め込みの設定パラメータを含む辞書です。この辞書には `rope_theta` の値が含まれており、より長い `max_position_embeddings` で RoPE を使用する場合にスケーリングに使用されるパラメータが任意で含まれます。 patch_temporal (`int`, *optional*) : 入力を埋め込む際に使用される時間方向のパッチサイズ。 merge_size (`tuple[int] | list[int]`、*任意*) : パッチマージ用のカーネルサイズ。 max_position_embeddings (`int`、*任意*、デフォルトは`1024`) : このモデルが使用される可能性のある最大シーケンス長。 layer_norm_eps (`float`、*任意*、デフォルトは`1e-05`) : Layer Normalization 層で使用する epsilon。 layer_types (`list[str]`、*任意*) : 各レイヤーのインデックスとそのレイヤータイプを明示的にマッピングするリストです。指定しない場合、config の値に基づいて自動的に生成されます。 これはMuseSparkModelの設定を保存するための設定クラスです。指定された引数に基づいてMuse Sparkモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[meta-models/Muse-Spark-Open-816B-A42B](https://huggingface.co/meta-models/Muse-Spark-Open-816B-A42B)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 ## MuseSparkAudioConfig[[transformers.MuseSparkAudioConfig]] #### transformers.MuseSparkAudioConfig[[transformers.MuseSparkAudioConfig]] ```python transformers.MuseSparkAudioConfig(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, patch_sizes: list[int] | tuple[int, ...] = (16, 6, 5, 4), hidden_sizes: list[int] | tuple[int, ...] = (256, 512, 1024, 2048), depths: list[int] | tuple[int, ...] = (2, 2, 2, 2), num_hidden_layers: int = 4, mlp_ratio: float = 4.0, conv_kernel_size: int = 7, hidden_act: str = 'gelu', rms_norm_eps: float = 1e-06, out_hidden_size: int = 8192, initializer_range: float = 0.02) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/configuration_muse_spark.py#L192) **パラメータ:** patch_sizes (`list[int] | tuple[int, ...]`、*任意*、デフォルトは`(16, 6, 5, 4)`) : 各ステージのpatch embeddingによって適用される時間方向のダウンサンプリング係数です。これらの積は、1つの出力トークンに集約される波形サンプルの数に相当します。 hidden_sizes (`list[int] | tuple[int, ...]`、*任意*、デフォルトは`(256, 512, 1024, 2048)`) : 各ステージの隠れ幅。 depths (`list[int] | tuple[int, ...]`、*任意*、デフォルトは`(2, 2, 2, 2)`) : 各レイヤーにおける conv ブロックの数。 num_hidden_layers (`int`、*optional*、デフォルトは 4) : `MuseSparkAudioLayer` の数、つまりピラミッドの解像度レベルの数です。`len(hidden_sizes)` と重複しており、それに対して検証されるため、カスタムピラミッドを使用する場合は両方を設定する必要があります。 mlp_ratio (`float`、*任意*、デフォルトは 4.0) : レイヤーの MLP 中間幅と隠れ幅の比率。 conv_kernel_size (`int`, *任意*, デフォルトは 7) : depthwise causal convolution のカーネルサイズ。 hidden_act (`str`、*任意*、デフォルトは`gelu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"`など。 rms_norm_eps (`float`、*任意*、デフォルトは`1e-06`) : rms 正規化レイヤーで使用する epsilon。 out_hidden_size (`int`, *optional*, デフォルトは 8192) : 最終的な投影がマッピングされる幅、つまりテキストモデルの隠れ層サイズです。 initializer_range (`float`、*任意*、デフォルトは`0.02`) : すべての重み行列を初期化するためのtruncated_normal_initializerの標準偏差です。 これはMuseSparkModelの設定を保存するための設定クラスです。指定された引数に基づいてMuse Sparkモデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[meta-models/Muse-Spark-Open-816B-A42B](https://huggingface.co/meta-models/Muse-Spark-Open-816B-A42B)と類似した設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 例: ```python >>> from transformers import MuseSparkAudioConfig, MuseSparkAudioModel >>> configuration = MuseSparkAudioConfig() >>> model = MuseSparkAudioModel(configuration) >>> configuration = model.config ``` ## MuseSparkFeatureExtractor[[transformers.MuseSparkFeatureExtractor]] #### transformers.MuseSparkFeatureExtractor[[transformers.MuseSparkFeatureExtractor]] ```python transformers.MuseSparkFeatureExtractor(feature_size = 1, sampling_rate = 24000, padding_value = 0.0, samples_per_token = 1920, return_attention_mask = True, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/feature_extraction_muse_spark.py#L28) **パラメータ:** feature_size (`int`、*optional*、デフォルトは 1) : 抽出された特徴量の次元数です。Muse Spark Open はモノラル音声を使用します。 sampling_rate (`int`, *optional*, デフォルトは 24000) : 音声の想定されるサンプリングレート（ヘルツ）です。他のレートで録音された音声は、このクラスに渡す前にリサンプリングする必要があります。 padding_value (`float`、*optional*、デフォルト値は 0.0) : 右側のパディングに使用される値。 samples_per_token (`int`, *optional*, デフォルト値は 1920) : エンコーダーが 1 つの埋め込みベクトルに集約する波形サンプル数です。これは、オーディオ設定の `patch_sizes` (16 * 6 * 5 * 4) の積に相当します。バッチは、この値の倍数になるようパディングされます。 return_attention_mask (`bool`、*任意*、デフォルトは`True`) : `__call__()`が`input_values_mask`を返すかどうか。オーディオタワーは完全に畳み込み型であり、これを消費しません。デフォルトでは無効です。 Muse Spark Open の特徴量抽出器を構築します。 Muse Spark Opensのオーディオタワーは生波形を直接消費します。スペクトログラムのフロントエンドは存在しないため、この処理はバッチ化、パディング、および（任意で）切り詰めを行うだけです。この処理の中で自明でない唯一の作業は、すべてのバッチを`samples_per_token`の倍数にパディングすることです。エンコーダーはちょうどそのサンプル数を1つの埋め込みに圧縮し、それ以外の場合は例外を発生させます。 このフィーチャーエクストラクターは、主要なメソッドの大部分を含む [SequenceFeatureExtractor](/docs/transformers/main/ja/main_classes/feature_extractor#transformers.SequenceFeatureExtractor) を継承しています。これらのメソッドに関する詳細については、このスーパークラスを参照してください。 ## MuseSparkProcessor[[transformers.MuseSparkProcessor]] #### transformers.MuseSparkProcessor[[transformers.MuseSparkProcessor]] ```python transformers.MuseSparkProcessor(image_processor = None, video_processor = None, tokenizer = None, feature_extractor = None, chat_template = None, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/processing_muse_spark.py#L28) **パラメータ:** image_processor (`MuseGlimmerImageProcessor`) : 画像プロセッサは必須の入力です。 video_processor (`MuseGlimmerVideoProcessor`) : 動画プロセッサは必須の入力です。 tokenizer (`tokenizer_class`) : トークナイザーは必須の入力です。 feature_extractor (`MuseSparkFeatureExtractor`) : 特徴量抽出器は必須の入力です。 chat_template (`str`) : チャット内のメッセージのリストをトークン化可能な文字列に変換するための Jinja テンプレート。 画像プロセッサ、動画プロセッサ、トークナイザー、特徴抽出器を単一のプロセッサにラップする MuseSparkProcessor を構築します。 [MuseSparkProcessor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkProcessor) は、[MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor)、[MuseGlimmerVideoProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerVideoProcessor)、`tokenizer_class`、および [MuseSparkFeatureExtractor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkFeatureExtractor) のすべての機能を提供します。詳細については、[~MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor)、[~MuseGlimmerVideoProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerVideoProcessor)、`~tokenizer_class`、および [~MuseSparkFeatureExtractor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkFeatureExtractor) を参照してください。 ## MuseSparkPreTrainedModel[[transformers.MuseSparkPreTrainedModel]] #### transformers.MuseSparkPreTrainedModel[[transformers.MuseSparkPreTrainedModel]] ```python transformers.MuseSparkPreTrainedModel(config: PreTrainedConfig, *inputs, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L494) **パラメータ:** config ([PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 このモデルは [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のドキュメントを参照してください。 ## MuseSparkTextModel[[transformers.MuseSparkTextModel]] #### transformers.MuseSparkTextModel[[transformers.MuseSparkTextModel]] ```python transformers.MuseSparkTextModel(config: MuseSparkTextConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L590) **パラメータ:** config ([MuseSparkTextConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkTextConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 裸の Muse Spark Text Modelは、特定のヘッドを上に載せずに生の hidden-states を出力します。 このモデルは [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.MuseSparkTextModel.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, use_cache: bool | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L615) **パラメータ:** 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.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) position_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックスです。`[0, config.n_positions - 1]` の範囲から選択されます。 [位置 ID とは何か？](../glossary#position-ids) 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.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 **戻り値:** `MoeModelOutputWithPast` または `tuple(torch.FloatTensor)` `MoeModelOutputWithPast`、または`torch.FloatTensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。構成要素は設定（[MuseSparkConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkConfig)）や入力に応じて異なります。 [MuseSparkTextModel](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkTextModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, 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.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。 - **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 - **router_logits** (`tuple(torch.FloatTensor)`、*optional*、`output_router_probs=True` と `config.add_router_probs=True` が渡された場合、または `config.output_router_probs=True` の場合に返されます) -- `torch.FloatTensor` のタプル（レイヤーごとに1つ）、形状は `(batch_size, sequence_length, num_experts)`。 MoE ルーターによって計算される生（raw）のルーター logits（softmax 後）であり、Mixture of Experts モデルの補助損失を計算するためにこれらの用語が使用されます。 ## MuseSparkVisionModel[[transformers.MuseSparkVisionModel]] #### transformers.MuseSparkVisionModel[[transformers.MuseSparkVisionModel]] ```python transformers.MuseSparkVisionModel(config: MuseSparkVisionConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L948) **パラメータ:** config ([MuseSparkVisionConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkVisionConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 裸の Muse Spark Modelは、特定のヘッドを上に載せずに生の hidden-states を出力します。 このモデルは [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.MuseSparkVisionModel.forward]] ```python forward(pixel_values: FloatTensor, grid_thw: LongTensor, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L979) **パラメータ:** pixel_values (`torch.FloatTensor`、shape `(batch_size, num_channels, image_size, image_size)`) : 入力画像に対応するテンソルです。ピクセル値は [MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor) を使用して取得できます。詳細は [MuseGlimmerImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[MuseSparkProcessor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkProcessor) は画像の処理に [MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor) を使用します）。 grid_thw (`torch.LongTensor`、形状 `(num_images_or_videos, 3)`) : 各パックされた画像または動画の時間、高さ、幅のパッチグリッド次元。 **戻り値:** [BaseModelOutputWithPooling](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPooling) または `tuple(torch.FloatTensor)` `torch.FloatTensor` のタプル（`return_dict=False` が渡された場合、または `config.return_dict=False` の場合）または [BaseModelOutputWithPooling](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPooling)。構成（[MuseSparkConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkConfig)）と入力に応じて、さまざまな要素で構成されます。 [MuseSparkVisionModel](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkVisionModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`) -- モデルの最終層の出力における隠れ状態のシーケンス。 - **pooler_output** (`torch.FloatTensor`、shape `(batch_size, hidden_size)`) -- 補助事前学習タスクに使用される層をさらに通して処理された後、シーケンスの最初のトークン（分類トークン）の最終層の隠れ状態です。例えば、BERT 系のモデルでは、線形層と tanh 活性化関数を経て処理された後の分類トークンを返します。この線形層の重みは、事前学習中の次文予測（分類）目的から学習されます。 - **hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。 - **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 ## MuseSparkAudioModel[[transformers.MuseSparkAudioModel]] #### transformers.MuseSparkAudioModel[[transformers.MuseSparkAudioModel]] ```python transformers.MuseSparkAudioModel(config: MuseSparkAudioConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L1213) **パラメータ:** config ([MuseSparkAudioConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkAudioConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 Muse Spark Open波形音声エンコーダー: 生モノラル24 kHz音声を1920サンプル（80 ms、すなわち12.5 Hz）ごとに1つの埋め込みベクトルへ変換する、完全に因果的な畳み込みピラミッドです。出力はすでにテキストモデルの隠れ層サイズに一致しています。アテンション機構やスペクトログラムの前処理は使用していません。 このモデルは [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.MuseSparkAudioModel.forward]] ```python forward(input_values: Tensor, padding_cache: transformers.models.muse_spark.modeling_muse_spark.MuseSparkAudioConv1dPaddingCache | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L1228) **パラメータ:** 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.FloatTensor` 型への変換のために [AutoProcessor](/docs/transformers/main/ja/model_doc/auto#transformers.AutoProcessor) を使用してください。詳細は [MuseSparkProcessor.__call__()](/docs/transformers/main/ja/main_classes/processors#transformers.ProcessorMixin.__call__) を参照してください。 padding_cache (`MuseSparkAudioConv1dPaddingCache`, *任意*) : 畳み込み層のパディング用キャッシュ。ストリーミングチャンク間で状態を維持するために使用されます。 **戻り値:** [BaseModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutput) または `tuple(torch.FloatTensor)` `torch.FloatTensor` のタプル、または [BaseModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.BaseModelOutput)（`return_dict=False` が渡された場合、または `config.return_dict=False` の場合）。構成は、設定（[MuseSparkConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkConfig)）と入力に応じて、さまざまな要素からなります。 [MuseSparkAudioModel](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkAudioModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`) -- モデルの最終層の出力における隠れ状態のシーケンス。 - **hidden_states** (`tuple(torch.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。 - **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 ## MuseSparkModel[[transformers.MuseSparkModel]] #### transformers.MuseSparkModel[[transformers.MuseSparkModel]] ```python transformers.MuseSparkModel(config: MuseSparkConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L1269) **パラメータ:** config ([MuseSparkConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 裸の Muse Spark Modelは、特定のヘッドを上に載せずに生の hidden-states を出力します。 このモデルは [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.MuseSparkModel.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, use_cache: bool | None = None, pixel_values: typing.Optional[torch.Tensor] = None, image_grid_thw: typing.Optional[torch.LongTensor] = None, pixel_values_videos: typing.Optional[torch.Tensor] = None, video_grid_thw: typing.Optional[torch.LongTensor] = None, input_values: typing.Optional[torch.Tensor] = None, input_values_mask: typing.Optional[torch.Tensor] = None, mm_encoder_outputs: dict[str, transformers.modeling_outputs.BaseModelOutputWithPooling] | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L1362) **パラメータ:** 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.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) position_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックスです。`[0, config.n_positions - 1]` の範囲から選択されます。 [位置 ID とは何か？](../glossary#position-ids) 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.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 pixel_values (`torch.Tensor`、形状 `(batch_size, num_channels, image_size, image_size)`、*任意*) : 入力画像に対応するテンソルです。ピクセル値は [MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor) を使用して取得できます。詳細は [MuseGlimmerImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[MuseSparkProcessor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkProcessor) は画像の処理に [MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor) を使用します）。 image_grid_thw (`torch.LongTensor`、形状 `(num_images, 3)`、*任意*) : LLM における各画像のフィーチャー形状の時間軸、高さ、幅。 pixel_values_videos (`torch.Tensor`、形状 `(batch_size, num_frames, num_channels, frame_size, frame_size)`、*任意*) : 入力動画に対応するテンソルです。動画のピクセル値は [MuseGlimmerVideoProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerVideoProcessor) を使用して取得できます。詳細については [MuseGlimmerVideoProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2VideoProcessor.__call__) を参照してください（[MuseSparkProcessor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkProcessor) は動画の処理に [MuseGlimmerVideoProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerVideoProcessor) を使用します）。 video_grid_thw (`torch.LongTensor`、形状 `(num_videos, 3)`、*任意*) : LLM における各動画のフィーチャー形状の時間軸、高さ、幅。 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.FloatTensor` 型への変換のために [AutoProcessor](/docs/transformers/main/ja/model_doc/auto#transformers.AutoProcessor) を使用してください。詳細は [MuseSparkProcessor.__call__()](/docs/transformers/main/ja/main_classes/processors#transformers.ProcessorMixin.__call__) を参照してください。 input_values_mask (`torch.Tensor`、形状 `(batch_size, num_samples)`、*任意*) : `input_values` のどのエントリがパディングではなく実際のオーディオかを表します。[MuseSparkFeatureExtractor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkFeatureExtractor) によって生成されます。長さが異なるクリップをバッチ処理する場合は必須です。 mm_encoder_outputs (`dict[str, ~modeling_outputs.BaseModelOutputWithPooling]`, *任意*) : キーがサポートされているモダリティ、値がそのモダリティのエンコード済み出力である辞書。各エンコード済み出力は、(`pooler_output`、*任意*: `last_hidden_states`、*任意*: `hidden_states`、*任意*: `attentions`) という形式のタプルで、`pooler_output` の形状は `(batch_size, sequence_length, hidden_size)`、*任意*) であり、エンコーダーのマルチモーダル特徴量をテキスト埋め込みにマージしたシーケンスです。 **戻り値:** `MuseSparkModelOutputWithPast` または `tuple(torch.FloatTensor)` `MuseSparkModelOutputWithPast` または、`torch.FloatTensor` のタプル（`return_dict=False` が渡された場合、または `config.return_dict=False` の場合）。構成は、設定（[MuseSparkConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkConfig)）や入力に応じて、さまざまな要素からなります。 [MuseSparkModel](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkModel)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **last_hidden_state** (`torch.FloatTensor`、shape `(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.FloatTensor)`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（埋め込み層を持つモデルの場合、埋め込みの出力用が 1 つ、各層の出力用が 1 つずつ）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。 - **attentions** (`tuple(torch.FloatTensor)`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）で、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 - **image_hidden_states** (`torch.FloatTensor`、*任意*) -- サイズが`(batch_size, num_images, sequence_length, hidden_size)`の`torch.FloatTensor`。ビジョンエンコーダーによって生成され、最後の隠れ状態を投影した後のモデルの image_hidden_states です。 - **router_logits** (`tuple[torch.FloatTensor]`、*optional*、`output_router_logits=True` が渡された場合または `config.add_router_probs=True` の場合に返されます) -- `torch.FloatTensor` のタプル（レイヤーごとに1つ）、形状は `(batch_size, sequence_length, num_experts)`。 モデルのRouter logits。Mixture of Expertsモデルの補助損失を計算するのに役立ちます。 例: ```python >>> import os >>> from transformers import AutoProcessor, DistributedConfig, MuseSparkModel >>> distributed_config = DistributedConfig( ... tp_size=int(os.environ["WORLD_SIZE"]), ... ep_size=int(os.environ["WORLD_SIZE"]), ... ) >>> processor = AutoProcessor.from_pretrained("meta-models/Muse-Spark-Open-816B-A42B") >>> model = MuseSparkModel.from_pretrained( ... "meta-models/Muse-Spark-Open-816B-A42B", ... dtype="auto", ... distributed_config=distributed_config, ... ) >>> messages = [ ... { ... "role": "user", ... "content": [ ... {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/pipeline-cat-chonk.jpeg"}, ... {"type": "text", "text": "What is shown in this image?"}, ... ], ... }, ... ] >>> inputs = processor.apply_chat_template( ... messages, ... reasoning_effort="medium", ... add_generation_prompt=True, ... tokenize=True, ... return_dict=True, ... return_tensors="pt", ... ).to(model.device).to(model.dtype) >>> outputs = model(**inputs) >>> last_hidden_state = outputs.last_hidden_state ``` ## MuseSparkForConditionalGeneration[[transformers.MuseSparkForConditionalGeneration]] #### transformers.MuseSparkForConditionalGeneration[[transformers.MuseSparkForConditionalGeneration]] ```python transformers.MuseSparkForConditionalGeneration(config: MuseSparkConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L1552) **パラメータ:** config ([MuseSparkConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkConfig)) : モデルのパラメータをすべて含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを確認してください。 Muse Spark Modelは、他のモダリティ（例：画像とテキストからテキストを生成する）に条件付けられたトークン生成用のモデルです。 このモデルは [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.MuseSparkForConditionalGeneration.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, pixel_values: typing.Optional[torch.FloatTensor] = None, image_grid_thw: typing.Optional[torch.LongTensor] = None, pixel_values_videos: typing.Optional[torch.FloatTensor] = None, video_grid_thw: typing.Optional[torch.LongTensor] = None, input_values: typing.Optional[torch.Tensor] = None, input_values_mask: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, inputs_embeds: typing.Optional[torch.FloatTensor] = None, labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, logits_to_keep: typing.Union[int, torch.Tensor] = 0, mm_encoder_outputs: dict[str, transformers.modeling_outputs.BaseModelOutputWithPooling] | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/muse_spark/modeling_muse_spark.py#L1590) **パラメータ:** 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) pixel_values (`torch.FloatTensor`、形状 `(batch_size, num_channels, image_size, image_size)`、*任意*) : 入力画像に対応するテンソルです。ピクセル値は [MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor) を使用して取得できます。詳細は [MuseGlimmerImageProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2ImageProcessor.__call__) を参照してください（[MuseSparkProcessor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkProcessor) は画像の処理に [MuseGlimmerImageProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerImageProcessor) を使用します）。 image_grid_thw (`torch.LongTensor`、形状 `(num_images, 3)`、*任意*) : LLM における各画像のフィーチャー形状の時間軸、高さ、幅。 pixel_values_videos (`torch.FloatTensor`、形状 `(batch_size, num_frames, num_channels, frame_size, frame_size)`、*任意*) : 入力動画に対応するテンソルです。動画のピクセル値は [MuseGlimmerVideoProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerVideoProcessor) を使用して取得できます。詳細は [MuseGlimmerVideoProcessor.__call__()](/docs/transformers/main/ja/model_doc/molmo2#transformers.Molmo2VideoProcessor.__call__) を参照してください（[MuseSparkProcessor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkProcessor) は動画の処理に [MuseGlimmerVideoProcessor](/docs/transformers/main/ja/model_doc/muse_glimmer#transformers.MuseGlimmerVideoProcessor) を使用します）。 video_grid_thw (`torch.LongTensor`、形状 `(num_videos, 3)`、*任意*) : LLM における各動画のフィーチャー形状の時間軸、高さ、幅。 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.FloatTensor` 型への変換のために [AutoProcessor](/docs/transformers/main/ja/model_doc/auto#transformers.AutoProcessor) を使用してください。詳細は [MuseSparkProcessor.__call__()](/docs/transformers/main/ja/main_classes/processors#transformers.ProcessorMixin.__call__) を参照してください。 input_values_mask (`torch.Tensor`、形状 `(batch_size, num_samples)`、*任意*) : `input_values` のどのエントリがパディングではなく実際のオーディオかを表します。[MuseSparkFeatureExtractor](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkFeatureExtractor) によって生成されます。長さが異なるクリップをバッチ処理する場合は必須です。 attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) position_ids (`torch.LongTensor`、shape `(batch_size, sequence_length)`、*任意*) : 各入力シーケンスのトークンが位置埋め込み内で占める位置のインデックスです。`[0, config.n_positions - 1]` の範囲から選択されます。 [位置 ID とは何か？](../glossary#position-ids) 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.FloatTensor`、shape `(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids` を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込み参照行列よりも、`input_ids` のインデックスを対応するベクトルに変換する方法をより細かく制御したい場合に有用です。 labels (`torch.LongTensor`、形状 `(batch_size, sequence_length)`、*任意*) : マスク言語モデリング損失を計算するためのラベル。インデックスは `[0, ..., config.vocab_size]` の範囲内であるか、-100 である必要があります（`input_ids` のドキュメント文字列を参照）。インデックスが `-100` に設定されたトークンは無視（マスク）され、損失は `[0, ..., config.vocab_size]` の範囲内のラベルを持つトークンに対してのみ計算されます。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 logits_to_keep (`Union[int, torch.Tensor]`、*任意*、デフォルトは `0`) : `int` の場合、最後の `logits_to_keep` トークンについて logits を計算します。`0` の場合、すべての `input_ids` について logits を計算します（特殊ケース）。生成には最後のトークンの logits だけで十分であり、そのトークンのみについて計算することでメモリを節約できます。これは、長いシーケンスや大規模な語彙サイズの場合に特に顕著な効果があります。`torch.Tensor` の場合、シーケンス長次元で保持するインデックスに対応する 1 次元である必要があります。これは、パックされたテンソル形式（バッチとシーケンス長を単一の次元にまとめる形式）を使用する場合に有用です。 mm_encoder_outputs (`dict[str, ~modeling_outputs.BaseModelOutputWithPooling]`, *任意*) : キーがサポートされているモダリティ、値がそのモダリティのエンコード済み出力である辞書。各エンコード済み出力は、(`pooler_output`、*任意*: `last_hidden_states`、*任意*: `hidden_states`、*任意*: `attentions`) という形式のタプルで、`pooler_output` の形状は `(batch_size, sequence_length, hidden_size)`、*任意*) であり、エンコーダーのマルチモーダル特徴量をテキスト埋め込みにマージしたシーケンスです。 **戻り値:** `MuseSparkCausalLMOutputWithPast` または `tuple(torch.FloatTensor)` `MuseSparkCausalLMOutputWithPast`、または`torch.FloatTensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。構成要素は、設定（[MuseSparkConfig](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkConfig)）と入力に応じて異なります。 [MuseSparkForConditionalGeneration](/docs/transformers/main/ja/model_doc/muse_spark#transformers.MuseSparkForConditionalGeneration)のforwardメソッドは、`__call__`特殊メソッドをオーバーライドします。 この関数内でフォワードパスの手順を定義する必要がありますが、その後、この関数ではなく`Module`インスタンスを呼び出すべきです。前者は前処理と後処理の実行を適切に処理するのに対し、後者はそれらを無視してしまいます。 - **loss** (`torch.FloatTensor`、shape `(1,)`、*optional*、`labels` が指定された場合に返されます) -- 言語モデリングの損失(次のトークンの予測用)。 - **logits** (`torch.FloatTensor`、shape `(batch_size, sequence_length, config.text_config.vocab_size)`) -- 言語モデリングヘッドの予測スコア（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** (`tuple[torch.FloatTensor]`、*optional*、`output_hidden_states=True` が渡された場合または `config.output_hidden_states=True` の場合に返されます) -- `torch.FloatTensor` のタプル（モデルに埋め込み層がある場合はその出力用 + 各層の出力用）で、形状は `(batch_size, sequence_length, hidden_size)` です。 各層の出力におけるモデルのHidden-states、および任意の初期埋め込み出力。 - **attentions** (`tuple[torch.FloatTensor]`、*optional*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- `torch.FloatTensor` のタプル（各レイヤーごとに1つ）、形状は `(batch_size, num_heads, sequence_length, sequence_length)`。 アテンションのsoftmax後のアテンション重み。自己アテンションヘッド内で加重平均を計算するために使用されます。 - **image_hidden_states** (`torch.FloatTensor`、*任意*) -- サイズが `(batch_size, num_images, sequence_length, hidden_size)` の `torch.FloatTensor`。ビジュアルエンコーダーによって生成されたモデルの image_hidden_states。最後の隠れ状態を投影した後のものです。 - **router_logits** (`tuple[torch.FloatTensor]`、*optional*、`output_router_logits=True` が渡された場合または `config.add_router_probs=True` の場合に返されます) -- `torch.FloatTensor` のタプル（レイヤーごとに1つ）、形状は `(batch_size, sequence_length, num_experts)`。 モデルのRouter logits。Mixture of Expertsモデルの補助損失を計算するのに役立ちます。 例: ```python >>> import os >>> from transformers import AutoProcessor, DistributedConfig, MuseSparkForConditionalGeneration >>> distributed_config = DistributedConfig( ... tp_size=int(os.environ["WORLD_SIZE"]), ... ep_size=int(os.environ["WORLD_SIZE"]), ... ) >>> processor = AutoProcessor.from_pretrained("meta-models/Muse-Spark-Open-816B-A42B") >>> model = MuseSparkForConditionalGeneration.from_pretrained( ... "meta-models/Muse-Spark-Open-816B-A42B", ... dtype="auto", ... distributed_config=distributed_config, ... ) >>> messages = [ ... { ... "role": "user", ... "content": [ ... {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/pipeline-cat-chonk.jpeg"}, ... {"type": "text", "text": "What is shown in this image?"}, ... ], ... }, ... ] >>> inputs = processor.apply_chat_template( ... messages, ... reasoning_effort="medium", ... add_generation_prompt=True, ... tokenize=True, ... return_dict=True, ... return_tensors="pt", ... ).to(model.device).to(model.dtype) >>> input_len = inputs["input_ids"].shape[-1] >>> outputs = model.generate(**inputs, max_new_tokens=512) >>> response = processor.decode(outputs[0][input_len:], skip_special_tokens=False) >>> print(response) The image shows a **Pallas's cat — also known as a manul, *Otocolobus manul*** — walking through snow. ... ```