# SeamlessM4T ## 概要 SeamlessM4Tモデルは、Meta AIのSeamless Communicationチームによって、[SeamlessM4T — Massively Multilingual & Multimodal Machine Translation](https://huggingface.co/papers/2308.11596)の中で提案されました。 これはモデルの**version 1**リリースです。更新された**version 2**リリースについては、[Seamless M4T v2 docs](./seamless_m4t_v2)を参照してください。 SeamlessM4Tは、高品質な翻訳を提供するために設計されたモデルのコレクションです。これにより、異なる言語コミュニティの人々が音声やテキストを通じて、自然にコミュニケーションを取ることができます。 SeamlessM4T は、個別のモデルに依存せずに複数のタスクを可能にします: - 音声対音声翻訳 (S2ST) - 音声からテキストへの翻訳（S2TT） - テキストから音声への翻訳（T2ST） - テキストからテキストへの翻訳 (T2TT) - 自動音声認識 (ASR) [SeamlessM4TModel](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TModel) は上記のすべてのタスクを実行できますが、各タスクにはそれぞれ専用のサブモデルが用意されています。 論文の抄録は以下の通りです。 *2つの言語間の音声翻訳を支援するツールである Babel Fish を作成するには何が必要でしょうか？ 最近のテキストベースのモデルにおけるブレイクスルーにより、機械翻訳の対応言語は200言語以上に拡大しましたが、統合型の音声対音声翻訳モデルは同様の進歩をまだ達成していません。より具体的には、従来の音声対音声翻訳システムは、翻訳を段階的に実行するカスケード型システムに依存しており、高性能な統合型システムの実現が困難な状況でした。これらのギャップを埋めるため、最大100言語に対応する音声対音声翻訳、音声対テキスト翻訳、テキスト対音声翻訳、テキスト対テキスト翻訳、および自動音声認識をサポートする単一のモデル、SeamlessM4T を紹介します。この構築にあたり、w2v-BERT 2.0 を用いて自己教師ありの音声表現を学習するために、100万時間分のオープンな音声オーディオデータを使用しました。その後、自動アラインされた音声翻訳のマルチモーダルコーパスを作成しました。フィルタリングし、人間によるラベル付けデータと疑似ラベル付けデータを組み合わせることで、音声とテキストの両方で英語から翻訳し、英語に翻訳できる最初の多言語システムを開発しました。FLEURS において、SeamlessM4T は複数のターゲット言語への翻訳において新たな基準を確立し、直接の音声対テキスト翻訳において従来の SOTA に対して BLEU 20% の改善を達成しました。強力なカスケード型モデルと比較して、SeamlessM4T は音声対テキストの英語への翻訳品質を BLEU 1.3 ポイント、音声対音声を ASR-BLEU 2.6 ポイント向上させます。頑健性をテストした結果、当社のシステムは、現在の SOTA モデルと比較して、音声対テキストタスクにおいて背景ノイズや話者の変動に対して優れたパフォーマンスを発揮します。さらに重要なのは、SeamlessM4T をジェンダーバイアスに対して評価し、毒性を追加して翻訳の安全性を評価した点です。最後に、本作業のすべての貢献はオープンソース化されており、https://github.com/facebookresearch/seamless_communication でアクセスできます。* ## 使用方法 まず、プロセッサーとモデルのチェックポイントを読み込みます: ```python from transformers import AutoProcessor, SeamlessM4TModel processor = AutoProcessor.from_pretrained("facebook/hf-seamless-m4t-medium") model = SeamlessM4TModel.from_pretrained("facebook/hf-seamless-m4t-medium", device_map="auto") ``` このモデルは、テキストまたはオーディオをシームレスに使用でき、翻訳されたテキストまたは翻訳されたオーディオを生成できます。 プロセッサを使用してテキストとオーディオを処理する方法は以下の通りです。 ```python # let's load an audio sample from an Arabic speech corpus from datasets import load_dataset dataset = load_dataset("halabi2016/arabic_speech_corpus", split="test", streaming=True) audio_sample = next(iter(dataset))["audio"] # now, process it audio_inputs = processor(audio=audio_sample["array"], return_tensors="pt").to(model.device) # now, process some English test as well text_inputs = processor(text = "Hello, my dog is cute", src_lang="eng", return_tensors="pt").to(model.device) ``` ### 音声 [SeamlessM4TModel](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TModel) は、ほとんど変更を加えずに、*シームレスに*テキストや音声の生成を行うことができます。ここでは、ロシア語への音声翻訳をターゲットとします。 ```python audio_array_from_text = model.generate(**text_inputs, tgt_lang="rus")[0].cpu().numpy().squeeze() audio_array_from_audio = model.generate(**audio_inputs, tgt_lang="rus")[0].cpu().numpy().squeeze() ``` ほぼ同じコードで、英語のテキストとアラビア語の音声からロシア語の音声サンプルを生成しました。 ### テキスト 同様に、同じモデルで音声ファイルやテキストから翻訳テキストを生成できます。[SeamlessM4TModel.generate()](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TModel.generate)に`generate_speech=False`を渡すだけです。今回はフランス語に翻訳します。 ```python # from audio output_tokens = model.generate(**audio_inputs, tgt_lang="fra", generate_speech=False) translated_text_from_audio = processor.decode(output_tokens[0].tolist()[0], skip_special_tokens=True) # from text output_tokens = model.generate(**text_inputs, tgt_lang="fra", generate_speech=False) translated_text_from_text = processor.decode(output_tokens[0].tolist()[0], skip_special_tokens=True) ``` ### ヒント #### 1. 専用モデルを使用する [SeamlessM4TModel](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TModel) は、音声とテキストを生成するための transformers のトップレベルモデルです。ただし、追加のコンポーネントなしでタスクを実行できる専用モデルも使用でき、これによりメモリフットプリントを削減できます。例えば、音声から音声への生成のスニペットを、S2ST タスクに特化したモデルに置き換えることができます。残りのコードは完全に同じです。 ```python from transformers import SeamlessM4TForSpeechToSpeech model = SeamlessM4TForSpeechToSpeech.from_pretrained("facebook/hf-seamless-m4t-medium", device_map="auto") ``` または、テキストからテキストへの生成スニペットを、T2TTタスクに特化したモデルに置き換えることもできます。その場合、`generate_speech=False`を削除するだけです。 ```python from transformers import SeamlessM4TForTextToText model = SeamlessM4TForTextToText.from_pretrained("facebook/hf-seamless-m4t-medium", device_map="auto") ``` [SeamlessM4TForSpeechToText](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForSpeechToText)や[SeamlessM4TForTextToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForTextToSpeech)もぜひ試してみてください。 #### 2. 話者IDを変更する `spkr_id` 引数を変更することで、音声合成に使用するスピーカーを変更できます。一部の `spkr_id` は、他の `spkr_id` よりも特定の言語でより良い結果をもたらします! #### 3. 生成戦略を変更する 音声生成とテキスト生成には、それぞれ異なる[生成戦略](../generation_strategies)を使用できます。例えば、`.generate(input_ids=input_ids, text_num_beams=4, speech_do_sample=True)`では、テキストモデルに対してビームサーチデコーディングを、音声モデルに対して多項分布サンプリングを順次実行します。 #### 4. 音声とテキストを同時に生成する `return_intermediate_token_ids=True` を [SeamlessM4TModel](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TModel) と併用すると、音声とテキストの両方を返すことができます! ## モデルアーキテクチャ SeamlessM4Tは、テキストと音声の逐次的な生成を滑らかに処理する多用途なアーキテクチャを備えています。この構成は、2つのシーケンスツーシーケンス（seq2seq）モデルで構成されています。最初のモデルは入力モーダルを翻訳済みテキストに変換し、2番目のモデルは翻訳済みテキストから「ユニットトークン」と呼ばれる音声トークンを生成します。 各モダリティには、独自のアーキテクチャを持つ専用のエンコーダーが用意されています。また、音声出力については、[HiFi-GAN](https://huggingface.co/papers/2010.05646)アーキテクチャに着想を得たボコーダーが、2番目のseq2seqモデルの上に配置されています。 生成プロセスの仕組みは以下の通りです： - 入力されたテキストまたは音声は、それぞれに対応するエンコーダーによって処理されます。 - デコーダーは、希望する言語のテキストトークンを生成します。 - 音声生成が必要な場合、標準的なエンコーダー-デコーダー構造を持つ2番目のseq2seqモデルがユニットトークンを生成します。 - これらのユニットトークンは、最終的なボコーダーを通過して、実際の音声として生成されます。 このモデルは[ylacombe](https://huggingface.co/ylacombe)によって提供されました。元のコードは[こちら](https://github.com/facebookresearch/seamless_communication)で確認できます。 ## SeamlessM4TModel[[transformers.SeamlessM4TModel]] #### transformers.SeamlessM4TModel[[transformers.SeamlessM4TModel]] ```python transformers.SeamlessM4TModel(config: SeamlessM4TConfig, current_modality = 'text') ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L3360) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 current_modality (`str`、*任意*、デフォルトは`"text"`) : デフォルトのモダリティ。モデルの初期化に使用されます。 利用可能なすべてのタスク（S2ST、S2TT、T2TT、T2ST）に使用できる、元のSeamlessM4Tモデルのtransformerです。 このモデルは [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のドキュメントを参照してください。 #### generate[[transformers.SeamlessM4TModel.generate]] ```python generate(input_ids: typing.Optional[torch.Tensor] = None, input_features: typing.Optional[torch.Tensor] = None, return_intermediate_token_ids: bool | None = None, tgt_lang: str | None = None, spkr_id: int | None = 0, generate_speech: bool | None = True, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L3548) **パラメータ:** input_ids (`torch.LongTensor`、形状 `(batch_size, sequence_length)`、*任意*) : 語彙における入力シーケンスのトークンインデックス。[SeamlessM4TTokenizer](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTokenizer) または [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) を使用してインデックスを取得できます。詳細は [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) input_features (`torch.Tensor`、形状 `(batch_size, sequence_length, num_banks)`、*任意*) : 入力音声特徴量。[SeamlessM4TFeatureExtractor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor) クラスまたは [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) クラスによって返されるべきものです。詳細は [SeamlessM4TFeatureExtractor.__call__()](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor.__call__) を参照してください。 return_intermediate_token_ids (`bool`, *任意*) : `True`の場合、中間の生成テキストとユニットトークンも返します。音声とともに翻訳されたテキストも取得したい場合は、`True`に設定してください。なお、`generate_speech=False`の場合、このパラメータは無視され、テキストトークンが返されます。 tgt_lang (`str`, *任意*) : 翻訳のターゲット言語として使用する言語。 spkr_id (`int`、*optional*、デフォルトは 0) : 音声合成に使用される話者の ID。`config.vocoder_num_spkrs` より小さい値である必要があります。 generate_speech (`bool`、*任意*、デフォルトは`True`) : `False`の場合、テキストトークンのみを返し、音声は生成されません。 kwargs (*任意*) : [GenerationMixin.generate()](/docs/transformers/main/ja/main_classes/text_generation#transformers.GenerationMixin.generate) に渡される残りのキーワード引数の辞書です。キーワード引数は2つのタイプがあります。 - プレフィックスなしの場合、`decoder_input_ids` を除く各サブモデルの `generate` メソッドに `**kwargs` として入力されます。`decoder_input_ids` はテキストコンポーネントのみを介して渡されます。 - *text_* または *speech_* プレフィックス付きの場合、それぞれテキストモデルと音声モデルの `generate` メソッドへの入力として使用されます。プレフィックスなしのキーワードよりも優先されます。 したがって、例えば1つの生成には生成戦略を指定し、もう1つの生成には指定しない、といったことが可能です。 **戻り値:** `Union[SeamlessM4TGenerationOutput, tuple[Tensor], ModelOutput]` - `generate_speech`と`return_intermediate_token_ids`が指定されている場合、`SeamlessM4TGenerationOutput`を返します。 - `generate_speech`が呼び出され、`return_intermediate_token_ids`がFalseの場合、形状`(batch_size, sequence_length)`の波形と、各サンプルの長さを示す`waveform_lengths`からなるタプルを返します。 - `generate_speech=False` の場合、`ModelOutput` が返されます。 翻訳されたトークンIDおよび/または翻訳された音声波形を生成します。 このメソッドは、2つの異なるサブモデルの`.generate`関数を順次呼び出します。キーワード引数は2つの異なるレベルで指定できます。両方のモデルに渡される一般的な引数、または片方のモデルにのみ渡されるプレフィックス付きの引数です。 例えば、`.generate(input_ids=input_ids, num_beams=4, speech_do_sample=True)`を呼び出すと、テキストモデルに対してビームサーチデコーディングを、音声モデルに対して多項分布ビームサーチサンプリングを、それぞれ順次実行します。 生成戦略の概要とコード例については、[次のガイド](./generation_strategies)を参照してください。 ## SeamlessM4TForTextToSpeech[[transformers.SeamlessM4TForTextToSpeech]] #### transformers.SeamlessM4TForTextToSpeech[[transformers.SeamlessM4TForTextToSpeech]] ```python transformers.SeamlessM4TForTextToSpeech(config: SeamlessM4TConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2752) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 T2STに使用できるテキストから音声への変換用のSeamlessM4Tモデルtransformerです。 このモデルは [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のドキュメントを参照してください。 #### generate[[transformers.SeamlessM4TForTextToSpeech.generate]] ```python generate(input_ids: typing.Optional[torch.Tensor] = None, return_intermediate_token_ids: bool | None = None, tgt_lang: str | None = None, spkr_id: int | None = 0, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2880) **パラメータ:** input_ids (`torch.LongTensor`、形状 `(batch_size, sequence_length)`) : 語彙における入力シーケンスのトークンインデックス。[SeamlessM4TTokenizer](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTokenizer) または [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) を使用してインデックスを取得できます。詳細は [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) return_intermediate_token_ids (`bool`, *任意*) : `True`の場合、中間生成テキストとユニットトークンも返します。音声とともに翻訳テキストも取得したい場合は、`True`に設定してください。 tgt_lang (`str`, *任意*) : 翻訳のターゲット言語として使用する言語。 spkr_id (`int`、*optional*、デフォルトは 0) : 音声合成に使用される話者の ID。`config.vocoder_num_spkrs` より小さい値である必要があります。 kwargs (*任意*) : [GenerationMixin.generate()](/docs/transformers/main/ja/main_classes/text_generation#transformers.GenerationMixin.generate) に渡される残りのキーワード引数の辞書です。キーワード引数は2つのタイプがあります。 - プレフィックスなしの場合、`decoder_input_ids` を除く各サブモデルの `generate` メソッドに `**kwargs` として入力されます。`decoder_input_ids` はテキストコンポーネントのみを介して渡されます。 - *text_* または *speech_* プレフィックス付きの場合、それぞれテキストモデルと音声モデルの `generate` メソッドへの入力として使用されます。プレフィックスなしのキーワードよりも優先されます。 したがって、例えば1つの生成には生成戦略を指定し、もう1つの生成には指定しない、といったことが可能です。 **戻り値:** `Union[SeamlessM4TGenerationOutput, tuple[Tensor]]` - `return_intermediate_token_ids`が設定されている場合、`SeamlessM4TGenerationOutput`を返します。 - `return_intermediate_token_ids` が False の場合、`(batch_size, sequence_length)` の形状の波形と、各サンプルの長さを示す `waveform_lengths` からなるタプルを返します。 翻訳された音声波形を生成します。 このメソッドは、2つの異なるサブモデルの`.generate`関数を順次呼び出します。キーワード引数は2つの異なるレベルで指定できます。両方のモデルに渡される一般的な引数、または片方のモデルにのみ渡されるプレフィックス付きの引数です。 例えば、`.generate(input_ids, num_beams=4, speech_do_sample=True)`を呼び出すと、テキストモデルに対してビームサーチデコーディングを、音声モデルに対して多項分布ビームサーチサンプリングを、それぞれ順次実行します。 生成戦略の概要とコード例については、[次のガイド](./generation_strategies)を参照してください。 ## SeamlessM4TForSpeechToSpeech[[transformers.SeamlessM4TForSpeechToSpeech]] #### transformers.SeamlessM4TForSpeechToSpeech[[transformers.SeamlessM4TForSpeechToSpeech]] ```python transformers.SeamlessM4TForSpeechToSpeech(config: SeamlessM4TConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L3053) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 S2STに使用できる音声対話用のSeamlessM4Tモデルのtransformerです。 このモデルは [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のドキュメントを参照してください。 #### generate[[transformers.SeamlessM4TForSpeechToSpeech.generate]] ```python generate(input_features: typing.Optional[torch.Tensor] = None, return_intermediate_token_ids: bool | None = None, tgt_lang: str | None = None, spkr_id: int | None = 0, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L3180) **パラメータ:** input_features (`torch.Tensor`、形状 `(batch_size, sequence_length, num_banks)`) : 入力音声特徴量。[SeamlessM4TFeatureExtractor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor) クラスまたは [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) クラスによって返されるべきです。詳細は [SeamlessM4TFeatureExtractor.__call__()](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor.__call__) を参照してください。 return_intermediate_token_ids (`bool`, *任意*) : `True`の場合、中間生成テキストとユニットトークンも返します。音声とともに翻訳テキストも取得したい場合は、`True`に設定してください。 tgt_lang (`str`, *任意*) : 翻訳のターゲット言語として使用する言語。 spkr_id (`int`、*optional*、デフォルトは 0) : 音声合成に使用される話者の ID。`config.vocoder_num_spkrs` より小さい値である必要があります。 kwargs (*任意*) : [GenerationMixin.generate()](/docs/transformers/main/ja/main_classes/text_generation#transformers.GenerationMixin.generate) に渡される残りのキーワード引数の辞書です。キーワード引数は2つのタイプがあります。 - プレフィックスなしの場合、`decoder_input_ids` を除く各サブモデルの `generate` メソッドに `**kwargs` として入力されます。`decoder_input_ids` はテキストコンポーネントのみを介して渡されます。 - *text_* または *speech_* プレフィックス付きの場合、それぞれテキストモデルと音声モデルの `generate` メソッドへの入力として使用されます。プレフィックスなしのキーワードよりも優先されます。 したがって、例えば1つの生成には生成戦略を指定し、もう1つの生成には指定しない、といったことが可能です。 **戻り値:** `Union[SeamlessM4TGenerationOutput, tuple[Tensor]]` - `return_intermediate_token_ids`が設定されている場合、`SeamlessM4TGenerationOutput`を返します。 - `return_intermediate_token_ids` が False の場合、`(batch_size, sequence_length)` の形状の波形と、各サンプルの長さを示す `waveform_lengths` からなるタプルを返します。 翻訳された音声波形を生成します。 このメソッドは、2つの異なるサブモデルの`.generate`関数を順次呼び出します。キーワード引数は2つの異なるレベルで指定できます。両方のモデルに渡される一般的な引数、または片方のモデルにのみ渡されるプレフィックス付きの引数です。 例えば、`.generate(input_features, num_beams=4, speech_do_sample=True)` を呼び出すと、テキストモデルに対してビームサーチデコーディングを、音声モデルに対して多項分布ビームサーチサンプリングを、順次実行します。 生成戦略の概要とコード例については、[次のガイド](./generation_strategies)を参照してください。 ## SeamlessM4TForTextToText[[transformers.SeamlessM4TForTextToText]] #### transformers.SeamlessM4TForTextToText[[transformers.SeamlessM4TForTextToText]] ```python transformers.SeamlessM4TForTextToText(config: SeamlessM4TConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2276) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 T2TTに使用できるテキストからテキストへの変換を行うSeamlessM4Tモデルのtransformerです。 このモデルは [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.SeamlessM4TForTextToText.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, decoder_input_ids: typing.Optional[torch.LongTensor] = None, decoder_attention_mask: typing.Optional[torch.LongTensor] = None, encoder_outputs: tuple[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: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2312) **パラメータ:** 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) decoder_input_ids (`torch.LongTensor`、shape `(batch_size, target_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#decoder-input-ids) Bart は `decoder_input_ids` の生成の開始トークンとして `eos_token_id` を使用します。`past_key_values` を使用する場合は、オプションとして最後の `decoder_input_ids` だけを入力すれば十分です（`past_key_values` を参照）。翻訳や要約の学習では、`decoder_input_ids` を提供する必要があります。`decoder_input_ids` が提供されない場合、モデルは論文に従い、デノイジング事前学習のために `input_ids` を右にシフトしてこのテンソルを生成します。 decoder_attention_mask (`torch.LongTensor`、形状 `(batch_size, target_sequence_length)`、*任意*) : デフォルトの動作: `decoder_input_ids` 内の pad トークンを無視するテンソルを生成します。デフォルトでは、causal mask も使用されます。パディングの動作を変更する場合は、`modeling_bart._prepare_decoder_attention_mask` を読み、必要に応じて修正してください。デフォルトの戦略に関する詳細は、[論文](https://huggingface.co/papers/1910.13461) の図 1 を参照してください。 encoder_outputs (`tuple[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`、形状`(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids`を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込みルックアップ行列よりも、`input_ids`のインデックスを関連するベクトルに変換する方法をより細かく制御したい場合に便利です。 labels (`torch.LongTensor`、形状 `(batch_size, sequence_length)`、*任意*): マスクド言語モデリング損失を計算するためのラベル。インデックスは`[-100, 0, ..., config.vocab_size]`の範囲である必要があります（`input_ids`のドキュメント文字列を参照）。インデックスが`-100`に設定されたトークンは無視（マスク）され、損失は`[0, ..., config.vocab_size]`の範囲のラベルを持つトークンに対してのみ計算されます。 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)`、*任意*) : マスク言語モデリング損失を計算するためのラベル。インデックスは `[0, ..., config.vocab_size]` の範囲内であるか、-100 である必要があります（`input_ids` のドキュメント文字列を参照）。インデックスが `-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)` 設定（[SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)）や入力に応じて、さまざまな要素で構成される、[Seq2SeqLMOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput)または`torch.Tensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。 [SeamlessM4TForTextToText](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForTextToText) の 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を適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。 #### generate[[transformers.SeamlessM4TForTextToText.generate]] ```python generate(input_ids = None, tgt_lang = None, generation_config = None, logits_processor = None, stopping_criteria = None, prefix_allowed_tokens_fn = None, synced_gpus = False, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2394) **パラメータ:** input_ids (`torch.Tensor`、モダリティによって形状が異なる、*任意*) : 語彙における入力シーケンスのトークンインデックス。インデックスは [SeamlessM4TTokenizer](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTokenizer) または [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) を使用して取得できます。詳細については、[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) tgt_lang (`str`, *任意*) : 翻訳のターゲット言語として使用する言語。 generation_config (`~generation.GenerationConfig`, *任意*) : 生成呼び出しのベースパラメータ化として使用される生成設定です。 `**kwargs` で `generation_config` の属性に一致するものが generate に渡された場合、それらが上書きされます。 `generation_config` が指定されない場合、デフォルトが使用されます。その読み込み優先順位は以下の通りです: 1) `generation_config.json` モデルファイルが存在する場合、そこから読み込む; 2) モデル設定から読み込む。 未指定のパラメータは [GenerationConfig](/docs/transformers/main/ja/main_classes/text_generation#transformers.GenerationConfig) のデフォルト値を継承することに注意してください。生成をパラメータ化するには、そのドキュメントを確認してください。 logits_processor (`LogitsProcessorList`, *任意*) : 引数や生成設定から構築されるデフォルトの logits プロセッサを補完する、カスタムの logits プロセッサです。引数や生成設定で既に作成済みの logits プロセッサが渡された場合、エラーが発生します。この機能は上級ユーザー向けです。 stopping_criteria (`StoppingCriteriaList`, *任意*) : 引数と生成設定から構築されるデフォルトの停止条件を補完する、カスタムの停止条件です。引数や生成設定からすでに作成された停止条件が渡された場合、エラーが発生します。この機能は上級ユーザー向けです。 prefix_allowed_tokens_fn (`Callable[[int, torch.Tensor], list[int]]`、*任意*) : 指定された場合、この関数はビームサーチを各ステップで許可されたトークンのみに制限します。指定されない場合、制約は適用されません。この関数は2つの引数を受け取ります: バッチID `batch_id` と `input_ids`。バッチID `batch_id` と以前に生成されたトークン `inputs_ids` に条件付けられた次の生成ステップの許可トークンのリストを返す必要があります。この引数は、[Autoregressive Entity Retrieval](https://huggingface.co/papers/2010.00904) に記載されているような、プレフィックスに条件付けられた制約付き生成に有用です。 synced_gpus (`bool`、*任意*、デフォルトは`False`) : `FullyShardedDataParallel`およびDeepSpeed ZeRO Stage 3でのデッドロックを回避するために必要です。max_lengthに達するまでwhileループの実行を継続するかどうかを指定します。 kwargs (`dict[str, Any]`、*任意*) : `generate_config` のアドホックなパラメータ化、および/またはモデルの `forward` 関数に転送される追加のモデル固有の kwargs。 **戻り値:** [ModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.utils.ModelOutput) または `torch.LongTensor` `return_dict_in_generate=True` の場合、または `config.return_dict_in_generate=True` の場合は [ModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.utils.ModelOutput)、それ以外は `torch.Tensor` です。考えられる [ModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.utils.ModelOutput) の型は以下の通りです: - [GenerateEncoderDecoderOutput](/docs/transformers/main/ja/internal/generation_utils#transformers.generation.GenerateEncoderDecoderOutput)、 - [GenerateBeamEncoderDecoderOutput](/docs/transformers/main/ja/internal/generation_utils#transformers.generation.GenerateBeamEncoderDecoderOutput) トークンIDのシーケンスを生成します。 生成を制御するほとんどのパラメータは`generation_config`で設定されます。この引数が渡されない場合、モデルのデフォルトの生成設定が使用されます。`generation_config`の任意の値は、generate()に該当するパラメータを渡すことで上書きできます。例: `.generate(inputs, num_beams=4, do_sample=True)`。 生成戦略の概要とコード例については、[次のガイド](./generation_strategies)を参照してください。 ## SeamlessM4TForSpeechToText[[transformers.SeamlessM4TForSpeechToText]] #### transformers.SeamlessM4TForSpeechToText[[transformers.SeamlessM4TForSpeechToText]] ```python transformers.SeamlessM4TForSpeechToText(config: SeamlessM4TConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2511) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 S2TTに使用できる音声認識用のSeamlessM4Tモデルtransformerです。 このモデルは [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.SeamlessM4TForSpeechToText.forward]] ```python forward(input_features: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, decoder_input_ids: typing.Optional[torch.LongTensor] = None, decoder_attention_mask: typing.Optional[torch.LongTensor] = None, encoder_outputs: tuple[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: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2544) **パラメータ:** input_features (`torch.Tensor`、形状 `(batch_size, sequence_length, num_banks)`) : 入力音声特徴量。[SeamlessM4TFeatureExtractor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor) クラスまたは [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) クラスによって返されるべきです。詳細は [SeamlessM4TFeatureExtractor.__call__()](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor.__call__) を参照してください。 attention_mask (`torch.Tensor`、shape `(batch_size, sequence_length)`、*任意*) : padding トークンのインデックスに対する attention を回避するためのマスクです。マスクの値は `[0, 1]` から選択されます: - **マスクされない**トークンは 1、- **マスクされる**トークンは 0。 [attention マスクとは?](../glossary#attention-mask) decoder_input_ids (`torch.LongTensor`、shape `(batch_size, target_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#decoder-input-ids) Bart は `decoder_input_ids` の生成の開始トークンとして `eos_token_id` を使用します。`past_key_values` を使用する場合は、オプションとして最後の `decoder_input_ids` だけを入力すれば十分です（`past_key_values` を参照）。翻訳や要約の学習では、`decoder_input_ids` を提供する必要があります。`decoder_input_ids` が提供されない場合、モデルは論文に従い、デノイジング事前学習のために `input_ids` を右にシフトしてこのテンソルを生成します。 decoder_attention_mask (`torch.LongTensor`、形状 `(batch_size, target_sequence_length)`、*任意*) : デフォルトの動作: `decoder_input_ids` 内の pad トークンを無視するテンソルを生成します。デフォルトでは、causal mask も使用されます。パディングの動作を変更する場合は、`modeling_bart._prepare_decoder_attention_mask` を読み、必要に応じて修正してください。デフォルトの戦略に関する詳細は、[論文](https://huggingface.co/papers/1910.13461) の図 1 を参照してください。 encoder_outputs (`tuple[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`、形状`(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids`を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込みルックアップ行列よりも、`input_ids`のインデックスを関連するベクトルに変換する方法をより細かく制御したい場合に便利です。 labels (`torch.LongTensor`、形状 `(batch_size, sequence_length)`、*任意*): マスクド言語モデリング損失を計算するためのラベル。インデックスは`[-100, 0, ..., config.vocab_size]`の範囲である必要があります（`input_ids`のドキュメント文字列を参照）。インデックスが`-100`に設定されたトークンは無視（マスク）され、損失は`[0, ..., config.vocab_size]`の範囲のラベルを持つトークンに対してのみ計算されます。 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)`、*任意*) : マスク言語モデリング損失を計算するためのラベル。インデックスは `[0, ..., config.vocab_size]` の範囲内であるか、-100 である必要があります（`input_ids` のドキュメント文字列を参照）。インデックスが `-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)` 設定（[SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)）や入力に応じて、さまざまな要素で構成される、[Seq2SeqLMOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput)または`torch.Tensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。 [SeamlessM4TForSpeechToText](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForSpeechToText)の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, SeamlessM4TForSpeechToText >>> from datasets import load_dataset >>> import torch >>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation") >>> dataset = dataset.sort("id") >>> sampling_rate = dataset.features["audio"].sampling_rate >>> processor = AutoProcessor.from_pretrained("facebook/hf-seamless-m4t-medium") >>> model = SeamlessM4TForSpeechToText.from_pretrained("facebook/hf-seamless-m4t-medium") >>> # audio file is decoded on the fly >>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt") >>> with torch.no_grad(): ... logits = model(**inputs).logits >>> predicted_ids = torch.argmax(logits, dim=-1) >>> # transcribe speech >>> transcription = processor.batch_decode(predicted_ids) >>> transcription[0] ... >>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids >>> # compute loss >>> loss = model(**inputs).loss >>> round(loss.item(), 2) ... ``` #### generate[[transformers.SeamlessM4TForSpeechToText.generate]] ```python generate(input_features = None, tgt_lang = None, generation_config = None, logits_processor = None, stopping_criteria = None, prefix_allowed_tokens_fn = None, synced_gpus = False, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2633) **パラメータ:** input_features (`torch.Tensor`、形状 `(batch_size, sequence_length, num_banks)`) : 入力音声特徴量。[SeamlessM4TFeatureExtractor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor) クラスまたは [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) クラスによって返されるべきです。詳細は [SeamlessM4TFeatureExtractor.__call__()](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor.__call__) を参照してください。 tgt_lang (`str`, *任意*) : 翻訳のターゲット言語として使用する言語。 generation_config (`~generation.GenerationConfig`, *任意*) : 生成呼び出しのベースパラメータ化として使用される生成設定です。 `**kwargs` で `generation_config` の属性に一致するものが generate に渡された場合、それらが上書きされます。 `generation_config` が指定されない場合、デフォルトが使用されます。その読み込み優先順位は以下の通りです: 1) `generation_config.json` モデルファイルが存在する場合、そこから読み込む; 2) モデル設定から読み込む。 未指定のパラメータは [GenerationConfig](/docs/transformers/main/ja/main_classes/text_generation#transformers.GenerationConfig) のデフォルト値を継承することに注意してください。生成をパラメータ化するには、そのドキュメントを確認してください。 logits_processor (`LogitsProcessorList`, *任意*) : 引数や生成設定から構築されるデフォルトの logits プロセッサを補完する、カスタムの logits プロセッサです。引数や生成設定で既に作成済みの logits プロセッサが渡された場合、エラーが発生します。この機能は上級ユーザー向けです。 stopping_criteria (`StoppingCriteriaList`, *任意*) : 引数と生成設定から構築されるデフォルトの停止条件を補完する、カスタムの停止条件です。引数や生成設定からすでに作成された停止条件が渡された場合、エラーが発生します。この機能は上級ユーザー向けです。 prefix_allowed_tokens_fn (`Callable[[int, torch.Tensor], list[int]]`、*任意*) : 指定された場合、この関数はビームサーチを各ステップで許可されたトークンのみに制限します。指定されない場合、制約は適用されません。この関数は2つの引数を受け取ります: バッチID `batch_id` と `input_ids`。バッチID `batch_id` と以前に生成されたトークン `inputs_ids` に条件付けられた次の生成ステップの許可トークンのリストを返す必要があります。この引数は、[Autoregressive Entity Retrieval](https://huggingface.co/papers/2010.00904) に記載されているような、プレフィックスに条件付けられた制約付き生成に有用です。 synced_gpus (`bool`、*任意*、デフォルトは`False`) : `FullyShardedDataParallel`およびDeepSpeed ZeRO Stage 3でのデッドロックを回避するために必要です。max_lengthに達するまでwhileループの実行を継続するかどうかを指定します。 kwargs (`dict[str, Any]`、*任意*) : `generate_config` のアドホックなパラメータ化、および/またはモデルの `forward` 関数に転送される追加のモデル固有の kwargs。 **戻り値:** [ModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.utils.ModelOutput) または `torch.LongTensor` `return_dict_in_generate=True` の場合、または `config.return_dict_in_generate=True` の場合は [ModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.utils.ModelOutput)、それ以外は `torch.Tensor` です。考えられる [ModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.utils.ModelOutput) の型は以下の通りです: - [GenerateEncoderDecoderOutput](/docs/transformers/main/ja/internal/generation_utils#transformers.generation.GenerateEncoderDecoderOutput)、 - [GenerateBeamEncoderDecoderOutput](/docs/transformers/main/ja/internal/generation_utils#transformers.generation.GenerateBeamEncoderDecoderOutput) トークンIDのシーケンスを生成します。 生成を制御するほとんどのパラメータは`generation_config`で設定されます。この引数が渡されない場合、モデルのデフォルトの生成設定が使用されます。`generation_config`の任意の値は、generate()に該当するパラメータを渡すことで上書きできます。例: `.generate(inputs, num_beams=4, do_sample=True)`。 生成戦略の概要とコード例については、[次のガイド](./generation_strategies)を参照してください。 ## SeamlessM4TConfig[[transformers.SeamlessM4TConfig]] #### transformers.SeamlessM4TConfig[[transformers.SeamlessM4TConfig]] ```python transformers.SeamlessM4TConfig(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, 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, is_encoder_decoder: bool = True, vocab_size: int = 256102, t2u_vocab_size: int = 10082, hidden_size: int = 1024, initializer_range: float = 0.02, layer_norm_eps: float = 1e-05, use_cache: bool = True, max_position_embeddings: int = 1024, encoder_layerdrop: float | int = 0.05, decoder_layerdrop: float | int = 0.05, activation_function: str = 'relu', dropout: float | int = 0.1, attention_dropout: float | int = 0.1, activation_dropout: float | int = 0.0, scale_embedding: bool = True, encoder_layers: int = 24, encoder_ffn_dim: int = 8192, encoder_attention_heads: int = 16, decoder_layers: int = 24, decoder_ffn_dim: int = 8192, decoder_attention_heads: int = 16, decoder_start_token_id: int = 3, max_new_tokens: int | None = 256, pad_token_id: int | None = 0, bos_token_id: int | None = 2, eos_token_id: int | list[int] | None = 3, speech_encoder_layers: int = 24, speech_encoder_attention_heads: int = 16, speech_encoder_intermediate_size: int = 4096, speech_encoder_hidden_act: str = 'swish', speech_encoder_dropout: float | int = 0.0, add_adapter: bool = True, speech_encoder_layerdrop: float | int = 0.1, feature_projection_input_dim: int = 160, num_conv_pos_embeddings: int = 128, num_conv_pos_embedding_groups: int = 16, adaptor_kernel_size: int = 8, adaptor_stride: int = 8, adaptor_dropout: float | int = 0.1, num_adapter_layers: int = 1, position_embeddings_type: str = 'relative', rotary_embedding_base: int = 10000, max_source_positions: int = 4096, conv_depthwise_kernel_size: int = 31, t2u_bos_token_id: int | None = 0, t2u_pad_token_id: int | None = 1, t2u_eos_token_id: int | list[int] | None = 2, t2u_decoder_start_token_id: int = 2, t2u_max_new_tokens: int = 1024, t2u_encoder_layers: int = 6, t2u_encoder_ffn_dim: int = 8192, t2u_encoder_attention_heads: int = 16, t2u_decoder_layers: int = 6, t2u_decoder_ffn_dim: int = 8192, t2u_decoder_attention_heads: int = 16, t2u_max_position_embeddings: int = 2048, sampling_rate: int = 16000, upsample_initial_channel: int = 512, upsample_rates: list[int] | tuple[int, ...] = (5, 4, 4, 2, 2), upsample_kernel_sizes: list[int] | tuple[int, ...] = (11, 8, 8, 4, 4), resblock_kernel_sizes: list[int] | tuple[int, ...] = (3, 7, 11), resblock_dilation_sizes: list | tuple = ((1, 3, 5), (1, 3, 5), (1, 3, 5)), leaky_relu_slope: float = 0.1, unit_hifi_gan_vocab_size: int = 10000, unit_embed_dim: int = 1280, lang_embed_dim: int = 256, spkr_embed_dim: int = 256, vocoder_num_langs: int = 36, vocoder_num_spkrs: int = 200, variance_predictor_kernel_size: int = 3, var_pred_dropout: float | int = 0.5, vocoder_offset: int = 4, tie_word_embeddings: bool = True) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/configuration_seamless_m4t.py#L24) **パラメータ:** is_encoder_decoder (`bool`、*任意*、デフォルトは`True`) : モデルがエンコーダー/デコーダーとして使用されるかどうかを示します。 vocab_size (`int`、*任意*、デフォルトは`256102`) : モデルの語彙サイズ。`input_ids`で表現できるトークンの種類数を定義します。 t2u_vocab_size (`int`, *optional*, デフォルトは 10082) : SeamlessM4T モデルのユニット語彙サイズ。[~SeamlessM4TModel](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TModel)、[~SeamlessM4TForSpeechToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForSpeechToSpeech)、または [~SeamlessM4TForTextToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForTextToSpeech) の Text-To-Units サブモデルを呼び出す際に渡す `inputs_ids` で表現できる異なるユニットトークンの数を定義します。 hidden_size (`int`、*任意*、デフォルトは`1024`) : 隠れ表現の次元数。 initializer_range (`float`、*任意*、デフォルトは`0.02`) : すべての重み行列を初期化するためのtruncated_normal_initializerの標準偏差です。 layer_norm_eps (`float`、*任意*、デフォルトは`1e-05`) : Layer Normalization 層で使用する epsilon。 use_cache (`bool`、*任意*、デフォルトは `True`) : モデルが最後のキー/バリューアテンションを返すかどうか（すべてのモデルで利用されるわけではありません）。`config.is_decoder=True` の場合、またはモデルがデコーダー専用の生成モデルである場合にのみ関連します。 max_position_embeddings (`int`、*任意*、デフォルトは`1024`) : このモデルが使用される可能性のある最大シーケンス長。 encoder_layerdrop (`Union[float, int]`、*任意*、デフォルトは`0.05`) : エンコーダーの LayerDrop 確率です。詳細については、[LayerDrop の論文](see https://huggingface.co/papers/1909.11556)を参照してください。 decoder_layerdrop (`Union[float, int]`、*任意*、デフォルトは`0.05`) : デコーダーの LayerDrop 確率です。詳細については、[LayerDrop の論文](see https://huggingface.co/papers/1909.11556)を参照してください。 activation_function (`str`、*任意*、デフォルトは `relu`) : デコーダーで使用する非線形活性化関数（関数または文字列）。例えば、`"gelu"`、`"relu"`、`"silu"` など。 dropout (`Union[float, int]`、*任意*、デフォルトは`0.1`) : すべての dropout 層の比率。 attention_dropout (`Union[float, int]`、*任意*、デフォルトは`0.1`) : 注意確率のドロップアウト率。 activation_dropout (`Union[float, int]`、*任意*、デフォルトは`0.0`) : 全結合層内の活性化に対する dropout 率。 scale_embedding (`bool`、*任意*、デフォルトは`True`) : sqrt(d_model) で割って埋め込みをスケーリングするかどうか。 encoder_layers (`int`、*任意*、デフォルトは`24`) : Transformerエンコーダーの隠れ層の数。設定されていない場合は、`num_layers`と同じ値が使用されます。 encoder_ffn_dim (`int`、*任意*、デフォルトは`8192`) : エンコーダー内の「intermediate」（feed-forward とも呼ばれる）層の次元数。 encoder_attention_heads (`int`、*任意*、デフォルトは`16`) : Transformerエンコーダーの各アテンション層におけるアテンションヘッドの数。 decoder_layers (`int`、*任意*、デフォルトは`24`) : Transformer デコーダーの隠れ層の数。設定されていない場合は、`num_layers` と同じ値が使用されます。 decoder_ffn_dim (`int`、*任意*、デフォルトは`8192`) : デコーダー内の「intermediate」（feed-forward とも呼ばれる）層の次元数。 decoder_attention_heads (`int`、*任意*、デフォルトは`16`) : Transformerデコーダーの各アテンション層におけるアテンションヘッドの数。 decoder_start_token_id (`int`、*optional*、デフォルトは`3`) : エンコーダーデコーダーモデルが`bos`以外のトークンでデコーディングを開始する場合、そのトークンのID。 max_new_tokens (`int`、*optional*、デフォルトは 256) : プロンプト内のトークン数を無視して、生成するテキストトークンの最大数。 pad_token_id (`int`, *任意*, デフォルトは `0`) : 語彙内でパディングに使用されるトークン ID。 bos_token_id (`int`、*任意*、デフォルトは`2`) : 語彙内でストリームの開始に使用されるトークン ID。 eos_token_id (`Union[int, list[int]]`、*任意*、デフォルトは`3`) : 語彙内でストリーム終了に使用されるトークン ID。 speech_encoder_layers (`int`, *optional*, デフォルトは 24) : Transformer 音声エンコーダーの隠れ層の数。 speech_encoder_attention_heads (`int`、*optional*、デフォルトは 16) : Transformer 音声エンコーダーの各アテンション層におけるアテンションヘッドの数。 speech_encoder_intermediate_size (`int`、*optional*、デフォルトは 4096) : Transformer 音声エンコーダーにおける「intermediate」（すなわちフィードフォワード）層の次元数。 speech_encoder_hidden_act (`str` または `function`、*任意*、デフォルトは `"swish"`) : 音声エンコーダーで使用される非線形活性化関数（関数または文字列）です。文字列の場合、`"gelu"`、`"relu"`、`"selu"`、`"swish"` および `"gelu_new"` がサポートされています。 speech_encoder_dropout (`float`、*optional*、デフォルト値は 0.0) : 音声エンコーダーのすべての層における dropout 確率。 add_adapter (`bool`, *任意*, デフォルトは `True`) : 音声エンコーダーの上にアダプター層を追加します。 speech_encoder_layerdrop (`float`、*optional*、デフォルトは 0.1) : 音声エンコーダーの LayerDrop 確率です。詳細については、[LayerDrop の論文](see https://huggingface.co/papers/1909.11556)を参照してください。 feature_projection_input_dim (`int`、*optional*、デフォルトは 160) : 音声エンコーダーの入力特徴量射影の入力次元、つまり [SeamlessM4TFeatureExtractor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor) で入力オーディオを処理した後の次元です。 num_conv_pos_embeddings (`int`、*optional*、デフォルトは 128) : 畳み込み位置埋め込みの数。音声エンコーダーの 1 次元畳み込み位置埋め込み層のカーネルサイズを定義します。 num_conv_pos_embedding_groups (`int`、*optional*、デフォルトは 16) : 音声エンコーダーの 1 次元畳み込み位置埋め込み層のグループ数。 adaptor_kernel_size (`int`, *optional*, デフォルトは 8) : アダプターネットワーク内の畳み込み層のカーネルサイズ。`add_adapter is True` の場合のみ関連します。 adaptor_stride (`int`, *任意*, デフォルトは 8) : アダプターネットワークの畳み込み層のストライド。`add_adapter is True` の場合のみ関連します。 adaptor_dropout (`float`、*optional*、デフォルトは 0.1) : 音声アダプター内のすべての層における dropout 確率。 num_adapter_layers (`int`, *optional*, デフォルトは 1) : アダプターネットワークで使用すべき畳み込み層の数。`add_adapter is True` の場合のみ関連します。 position_embeddings_type (`str`、*任意*、デフォルトは`"relative"`) : 相対位置埋め込みまたはロータリー位置埋め込みを指定するために、それぞれ`relative`または`rotary`を指定できます。`None`のままにすると、相対位置埋め込みは適用されません。音声エンコーダーにのみ適用されます。 rotary_embedding_base (`int`、*optional*、デフォルトは 10000) : `"rotary"` の位置埋め込みを使用する場合、埋め込みベースのサイズを定義します。音声エンコーダーにのみ適用されます。 max_source_positions (`int`、*optional*、デフォルトは 4096) : `"relative"` の位置埋め込みを使用する場合、ソース入力位置の最大値を定義します。音声エンコーダーにのみ適用されます。 conv_depthwise_kernel_size (`int`、*optional*、デフォルトは 31) : Conformer ブロック内の畳み込み深度方向 1D レイヤーのカーネルサイズ。音声エンコーダーにのみ適用されます。 t2u_bos_token_id (`int`、*optional*、デフォルトは 0) : _beginning-of-stream_ユニットトークンの ID。テキストからユニットへの seq2seq モデルでのみ適用されます。 t2u_pad_token_id (`int`、*optional*、デフォルトは 1) : _padding_ 用のユニットトークンの ID。テキストからユニットへの seq2seq モデルでのみ適用されます。 t2u_eos_token_id (`int`、*optional*、デフォルトは 2) : _end-of-stream_ユニットトークンの ID。テキストからユニットへの seq2seq モデルでのみ適用されます。 t2u_decoder_start_token_id (`int`、*optional*、デフォルトは 2) : エンコーダーデコーダーモデルが_bos_以外のトークンでデコーディングを開始する場合、そのトークンの id です。テキストからユニットへの seq2seq モデルにのみ適用されます。 t2u_max_new_tokens (`int`、*optional*、デフォルトは 1024) : プロンプト内のトークン数を無視して生成するユニットトークンの最大数。テキストからユニットへの seq2seq モデルでのみ適用されます。 t2u_encoder_layers (`int`, *optional*, デフォルトは 6) : Transformer のテキストからユニットへのエンコーダーにおける隠れ層の数。 t2u_encoder_ffn_dim (`int`、*optional*、デフォルトは 8192) : Transformer のテキストからユニットへのエンコーダーにおける「中間」(すなわちフィードフォワード) レイヤーの次元数。 t2u_encoder_attention_heads (`int`、*optional*、デフォルトは 16) : Transformer のテキストからユニットへのエンコーダーにおける、各アテンション層のアテンションヘッド数。 t2u_decoder_layers (`int`, *optional*, デフォルトは 6) : Transformer のテキストからユニットへのデコーダーにおける隠れ層の数。 t2u_decoder_ffn_dim (`int`、*optional*、デフォルトは 8192) : Transformer のテキストからユニットへのデコーダーにおける「中間」(すなわちフィードフォワード) レイヤーの次元数。 t2u_decoder_attention_heads (`int`、*optional*、デフォルトは 16) : Transformer のテキストからユニットへのデコーダーにおける、各アテンション層のアテンションヘッド数。 t2u_max_position_embeddings (`int`, *optional*, デフォルトは 2048) : このモデルの text-to-unit コンポーネントが使用される可能性のある最大シーケンス長です。念のため、通常は大きめの値（例: 512、1024、2048 など）に設定します。 sampling_rate (`int`、*optional*、デフォルトは`16000`) : 音声ファイルをデジタル化するためのサンプリングレート（ヘルツ (Hz) 単位）。 upsample_initial_channel (`int`、*optional*、デフォルトは 512) : hifi-gan アップサンプリングネットワークへの入力チャネル数です。ボコーダーにのみ適用されます。 upsample_rates (`tuple[int]` または `list[int]`、*任意*、デフォルトは `[5, 4, 4, 2, 2]`) : vocoder のアップサンプリングネットワークにおける各1次元畳み込み層のストライドを定義する整数のタプルです。*upsample_rates* の長さが畳み込み層の数を定義し、*upsample_kernel_sizes* の長さと一致する必要があります。vocoder にのみ適用されます。 upsample_kernel_sizes (`tuple[int]` または `list[int]`、*任意*、デフォルトは `[11, 8, 8, 4, 4]`) : vocoder のアップサンプリングネットワークにおける各1次元畳み込み層のカーネルサイズを定義する整数のタプルです。*upsample_kernel_sizes* の長さが畳み込み層の数を定義し、*upsample_rates* の長さと一致する必要があります。vocoder にのみ適用されます。 resblock_kernel_sizes (`tuple[int]` または `list[int]`、*任意*、デフォルトは `[3, 7, 11]`) : マルチ・レセプティブ・フィールド・フュージョン（MRF）モジュール内のボコーダーの1次元畳み込み層のカーネルサイズを定義する整数のタプルです。ボコーダーにのみ適用されます。 resblock_dilation_sizes (`tuple[tuple[int]]` または `list[list[int]]`、*任意*、デフォルトは `[[1, 3, 5], [1, 3, 5], [1, 3, 5]]`) : マルチ・レセプティブ・フィールド・フュージョン (MRF) モジュール内のボコーダーのディレイテッド1次元畳み込み層のディレイション率を定義する整数のネストされたタプルです。ボコーダーにのみ適用されます。 leaky_relu_slope (`float`、*optional*、デフォルト値は 0.1) : vocoder で使用される leaky ReLU 活性化関数の負の傾きの角度です。vocoder にのみ適用されます。 unit_hifi_gan_vocab_size (`int`、*optional*、デフォルトは 10000) : SeamlessM4T のボコーダーの語彙サイズ。[~SeamlessM4TModel](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TModel)、[~SeamlessM4TForSpeechToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForSpeechToSpeech)、または [~SeamlessM4TForTextToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TForTextToSpeech) のボコーダーを呼び出す際に渡す `inputs_ids` で表現できる異なるユニットトークンの数を定義します。 unit_embed_dim (`int`, *optional*, デフォルトは 1280) : hifi-gan ボコーダーに与えられる入力 ID の射影次元です。ボコーダーにのみ適用されます。 lang_embed_dim (`int`、*optional*、デフォルトは 256) : hifi-gan ボコーダーに渡すターゲット言語の射影次元です。ボコーダーにのみ適用されます。 spkr_embed_dim (`int`、*optional*、デフォルトは 256) : hifi-gan ボコーダーに渡される話者 ID の射影次元です。ボコーダーにのみ適用されます。 vocoder_num_langs (`int`、*optional*、デフォルトは 36) : vocoder がサポートする言語の数。`t2u_num_langs` と異なる場合があります。 vocoder_num_spkrs (`int`、*optional*、デフォルトは 200) : vocoder がサポートする話者数。 variance_predictor_kernel_size (`int`、*optional*、デフォルトは 3) : 期間予測器のカーネルサイズ。ボコーダーにのみ適用されます。 var_pred_dropout (`float`、*optional*、デフォルトは 0.5) : duration predictor の dropout 確率です。vocoder にのみ適用されます。 vocoder_offset (`int`, *optional*, デフォルトは 4) : シンボルトークンを考慮するために、ユニットトークン ID をこの数だけオフセットします。ボーコーダーにのみ適用されます。 tie_word_embeddings (`bool`、*任意*、デフォルトは`True`) : モデルの`tied_weights_keys`マッピングに従って重み埋め込みを共有するかどうか。 これは、SeamlessM4TModel の設定を保存するための設定クラスです。指定された引数に基づいて Seamless M4T モデルをインスタンス化し、モデルのアーキテクチャを定義するために使用されます。デフォルト値で設定をインスタンス化すると、[facebook/hf-seamless-m4t-medium](https://huggingface.co/facebook/hf-seamless-m4t-medium) と同様の設定が得られます。 設定オブジェクトは [PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) を継承し、モデルの出力を制御するために使用できます。詳細については、[PreTrainedConfig](/docs/transformers/main/ja/main_classes/configuration#transformers.PreTrainedConfig) のドキュメントを参照してください。 ```python >>> from transformers import SeamlessM4TModel, SeamlessM4TConfig >>> # Initializing a SeamlessM4T "facebook/hf-seamless-m4t-medium" style configuration >>> configuration = SeamlessM4TConfig() >>> # Initializing a model from the "facebook/hf-seamless-m4t-medium" style configuration >>> model = SeamlessM4TModel(configuration) >>> # Accessing the model configuration >>> configuration = model.config ``` ## SeamlessM4TTokenizer[[transformers.SeamlessM4TTokenizer]] #### transformers.SeamlessM4TTokenizer[[transformers.SeamlessM4TTokenizer]] ```python transformers.SeamlessM4TTokenizer(vocab: str | dict[str, int] | None = None, merges: str | list[str] | None = None, bos_token = '', eos_token = '', sep_token = '', cls_token = '', unk_token = '', pad_token = '', src_lang = 'eng', tgt_lang = 'fra', additional_special_tokens = None, keep_accents = None, vocab_file = None, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/tokenization_seamless_m4t.py#L33) **パラメータ:** vocab (`list`または`dict`、*任意*) : (トークン、スコア)のタプルのリスト、またはトークンをインデックスにマッピングする辞書。指定しない場合、デフォルトのボキャブラリが使用されます。 merges (`str` または `list`、*省略可能*) : BPE モデル用のマージルールのリスト。指定しない場合、空のリストが使用されます。 bos_token (`str`、*任意*、デフォルトは `""`) : 事前学習で使用されたシーケンスの開始トークンです。シーケンス分類器のトークンとして使用できます。 特殊トークンを使用してシーケンスを構築する場合は、シーケンスの開始にこのトークンは使用されません。使用されるのは `cls_token` です。 eos_token (`str`、*任意*、デフォルトは`""`) : シーケンスの終了トークン。特殊トークンを使用してシーケンスを構築する場合は、シーケンスの終了に使用されるトークンではありません。使用されるトークンは`sep_token`です。 sep_token (`str`、*任意*、デフォルトは `""`) : 区切りトークンです。複数のシーケンスからシーケンスを構築する際に使用されます。例えば、シーケンス分類では2つのシーケンス、質問応答ではテキストと質問です。また、特殊トークンを用いて構築されたシーケンスの最後のトークンとしても使用されます。 cls_token (`str`、*任意*、デフォルトは `""`) : シーケンス分類（トークンごとの分類ではなく、シーケンス全体に対する分類）を行う際に使用される分類トークンです。特殊トークンを用いて構築された場合、シーケンスの最初のトークンになります。 unk_token (`str`、*任意*、デフォルトは `""`) : 不明トークン。語彙に存在しないトークンは ID に変換できず、代わりにこのトークンが設定されます。 pad_token (`str`、*任意*、デフォルトは `""`) : パディングに使用されるトークンです。長さの異なるシーケンスをバッチ処理する場合などに使用します。 src_lang (`str`、*任意*、デフォルトは`"eng"`) : 翻訳のソース言語として使用する言語。 tgt_lang (`str`、*任意*、デフォルトは`"fra"`) : 翻訳のターゲット言語として使用する言語。 additional_special_tokens `str` または `tokenizers.AddedToken` のタプルまたはリスト、*optional* : 追加の特殊トークンのタプルまたはリスト。 HuggingFaceの*tokenizers*ライブラリをベースにしたSeamlessM4Tのトークナイザーを構築します。[BPE](https://huggingface.co/docs/tokenizers/python/latest/components.html?highlight=bpe#models)に基づいています。 このトークナイザーは、[TokenizersBackend](/docs/transformers/main/ja/main_classes/tokenizer#transformers.TokenizersBackend) を継承しており、主要なメソッドの大部分がそこに含まれています。これらのメソッドに関する詳細については、このスーパークラスを参照してください。 トークナイゼーション手法は、ソース言語の文書に対して` `、ターゲット言語の文書に対して` `です。 例: ```python >>> from transformers import SeamlessM4TTokenizer >>> tokenizer = SeamlessM4TTokenizer.from_pretrained( ... "facebook/hf-seamless-m4t-medium", src_lang="eng", tgt_lang="fra" ... ) >>> example_english_phrase = " UN Chief Says There Is No Military Solution in Syria" >>> expected_translation_french = "Le chef de l'ONU affirme qu'il n'y a pas de solution militaire en Syrie." >>> inputs = tokenizer(example_english_phrase, text_target=expected_translation_french, return_tensors="pt") ``` #### __call__[[transformers.SeamlessM4TTokenizer.__call__]] ```python __call__(text: str | list[str] | list[list[str]] | None = None, text_pair: str | list[str] | list[list[str]] | None = None, text_target: str | list[str] | list[list[str]] | None = None, text_pair_target: str | list[str] | list[list[str]] | None = None, padding: bool | str | transformers.utils.generic.PaddingStrategy = False, pad_to_multiple_of: int | None = None, src_lang: str | None = None, tgt_lang: str | None = None, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/tokenization_seamless_m4t.py#L355) **パラメータ:** text (`str`、`list[str]`、`list[list[str]]`、*任意*) : エンコード対象のシーケンスまたはシーケンスのバッチです。各シーケンスは文字列、または文字列のリスト（プレトークナイズ済み文字列）であることができます。シーケンスが文字列のリスト（プレトークナイズ済み）として提供される場合、`is_split_into_words=True` を設定する必要があります（シーケンスのバッチとの曖昧さを解消するため）。 text_pair (`str`、`list[str]`、`list[list[str]]`、*任意*) : エンコード対象のシーケンスまたはシーケンスのバッチです。各シーケンスは文字列、または文字列のリスト（プレトークナイズ済み文字列）であることができます。シーケンスが文字列のリスト（プレトークナイズ済み）として提供される場合、`is_split_into_words=True` を設定する必要があります（シーケンスのバッチとの曖昧さを解消するため）。 text_target (`str`、`list[str]`、`list[list[str]]`、*任意*) : ターゲットテキストとしてエンコードするシーケンスまたはシーケンスのバッチです。各シーケンスは文字列または文字列のリスト（プレトークナイズされた文字列）であることができます。シーケンスが文字列のリスト（プレトークナイズ）として提供される場合、`is_split_into_words=True` を設定する必要があります（シーケンスのバッチとの曖昧さを解消するため）。 text_pair_target (`str`、`list[str]`、`list[list[str]]`、*任意*) : ターゲットテキストとしてエンコードするシーケンスまたはシーケンスのバッチです。各シーケンスは文字列または文字列のリスト（プレトークナイズされた文字列）であることができます。シーケンスが文字列のリスト（プレトークナイズ）として提供される場合、`is_split_into_words=True` を設定する必要があります（シーケンスのバッチとの曖昧さを解消するため）。 padding (`bool`、`str`または[PaddingStrategy](/docs/transformers/main/ja/internal/file_utils#transformers.utils.PaddingStrategy)、*省略可能*、デフォルトは`False`) : 返されるシーケンスのパディング戦略を選択します（モデルのパディング側とパディングインデックスに従います）。選択肢は以下の通りです。 - `True`または`'longest'`: バッチ内の最も長いシーケンスまでパディングします（単一のシーケンスのみが提供された場合は、パディングを行いません）。 - `'max_length'`: 引数`max_length`で指定された最大長までパディングします。この引数が提供されていない場合は、モデルが受け入れられる最大入力長までパディングします。 - `False`または`'do_not_pad'`（デフォルト）: パディングを行いません（つまり、長さが異なるシーケンスのバッチを出力できます）。 pad_to_multiple_of (`int`, *optional*, デフォルトは `None`) : 設定すると、シーケンスを指定された値の倍数にパディングします。これは、計算能力が `>= 7.5` (Volta) の NVIDIA ハードウェア上で Tensor Cores を使用可能にするために特に有用です。 src_lang (`str`, *任意*) : ソース言語を表す文字列です。指定しない場合、最後に指定された`src_lang`（初期化時またはこのトークナイザーを呼び出した時）が使用されます。 tgt_lang (`str`, *任意*) : ターゲット言語を表す文字列です。指定しない場合、最後に指定された `tgt_lang`（初期化時またはこのトークナイザーを呼び出した時）が使用されます。 kwargs (*任意*) : [TokenizersBackend.__call__()](/docs/transformers/main/ja/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) に渡される残りのキーワード引数の辞書。 #### get_special_tokens_mask[[transformers.SeamlessM4TTokenizer.get_special_tokens_mask]] ```python get_special_tokens_mask(token_ids_0: list[int], token_ids_1: list[int] | None = None, already_has_special_tokens: bool = False) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/tokenization_utils_base.py#L1338) **パラメータ:** token_ids_0 : (すでにフォーマット済みの可能性がある) シーケンスの ID のリスト。 token_ids_1 `already_has_special_tokens=True` の場合は使用されません。その場合は None でなければなりません。 already_has_special_tokens : シーケンスがすでに特殊トークンでフォーマットされているかどうか。 **戻り値:** 範囲 [0, 1] 内の整数のリスト 特殊トークンには1、シーケンストークンには0を指定します。 特殊トークンが追加されていないトークンリストからシーケンスIDを取得します。 高速なトークナイザーでは、データコラテーターは`already_has_special_tokens=True`を指定してこの関数を呼び出し、すでに整形済みのシーケンスに対してマスクを構築します。その場合、`all_special_ids`への所属を確認することによってマスクを計算します。 #### save_vocabulary[[transformers.SeamlessM4TTokenizer.save_vocabulary]] ```python save_vocabulary(save_directory: str, filename_prefix: str | None = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/tokenization_utils_tokenizers.py#L546) ## SeamlessM4TFeatureExtractor[[transformers.SeamlessM4TFeatureExtractor]] #### transformers.SeamlessM4TFeatureExtractor[[transformers.SeamlessM4TFeatureExtractor]] ```python transformers.SeamlessM4TFeatureExtractor(feature_size = 80, sampling_rate = 16000, num_mel_bins = 80, padding_value = 0.0, stride = 2, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/feature_extraction_seamless_m4t.py#L35) **パラメータ:** feature_size (`int`、*任意*、デフォルトは 80) : 抽出された特徴量の次元数。 sampling_rate (`int`、*optional*、デフォルトは 16000) : 音声ファイルをデジタル化するためのサンプリングレート（ヘルツ (Hz) 単位）。 num_mel_bins (`int`、*optional*、デフォルトは 80) : Mel 周波数ビンの数。 padding_value (`float`、*任意*、デフォルトは 0.0) : パディングベクトルを埋めるために使用される値。 stride (`int`、*optional*、デフォルトは 2) : (batch_size,num_frames,num_mel_bins) の形状のオーディオを (batch_size,num_frames//stride,num_mel_bins*stride) にリシェイプするために使用されるストライド。 SeamlessM4T の特徴抽出器を構築します。 このフィーチャーエクストラクターは、主要なメソッドの大部分を含む [SequenceFeatureExtractor](/docs/transformers/main/ja/main_classes/feature_extractor#transformers.SequenceFeatureExtractor) を継承しています。これらのメソッドに関する詳細については、このスーパークラスを参照してください。 このクラスは、生の音声からメルフィルタバンク特徴量を抽出します。 #### __call__[[transformers.SeamlessM4TFeatureExtractor.__call__]] ```python __call__(raw_speech: numpy.ndarray | list[float] | list[numpy.ndarray] | list[list[float]], padding: bool | str | transformers.utils.generic.PaddingStrategy = True, pad_to_multiple_of: int | None = 2, max_length: int | None = None, truncation: bool = False, return_tensors: str | transformers.utils.generic.TensorType | None = None, sampling_rate: int | None = None, return_attention_mask: bool | None = None, do_normalize_per_mel_bins: bool | None = True, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/feature_extraction_seamless_m4t.py#L140) **パラメータ:** raw_speech (`np.ndarray`, `torch.Tensor`, `list[float]`, `list[np.ndarray]`, `list[torch.Tensor]`, -- `list[list[float]]`、`list[list[list[float]]]`) : パディング対象のシーケンスまたはシーケンスのバッチです。各シーケンスは、numpy 配列、torch テンソル、float 値のリスト、numpy 配列のリスト、torch テンソルのリスト、float 値のリストのリスト、または float 値のリストのリストのリストであることができます。`raw_speech` が 1 次元の `np.ndarray`、`torch.Tensor`、または `list[float]` の場合、`raw_speech` は単一チャネルの単一サンプルの音として扱われます。それ以外のすべての場合、`raw_speech` の最初の次元は、`np.ndarray`、`torch.Tensor`、または `list[...]` のいずれから由来しても、バッチ内のサンプル数に対応し、チャネル数（つまりモノラルまたはステレオの特性）は他の次元から導出されます（1 次元 -> 単一チャネルの波形バッチ、2 次元 -> ステレオチャネルの波形バッチ）。 padding (`bool`、`str`または[PaddingStrategy](/docs/transformers/main/ja/internal/file_utils#transformers.utils.PaddingStrategy)、*省略可能*、デフォルトは`True`) : 返されるシーケンスのパディング戦略を選択します（モデルのパディング側とパディングインデックスに従います）。選択肢は以下の通りです。 - `True`または`'longest'`: バッチ内の最も長いシーケンスまでパディングします（単一のシーケンスのみが提供された場合は、パディングを行いません）。 - `'max_length'`: 引数`max_length`で指定された最大長までパディングします。この引数が指定されていない場合は、モデルが受け入れ可能な最大入力長までパディングします。 - `False`または`'do_not_pad'`（デフォルト）: パディングを行いません（つまり、長さが異なるシーケンスのバッチを出力できます）。 pad_to_multiple_of (`int`, *optional*, デフォルト値は 2) : 設定されている場合、シーケンスを指定された値の倍数にパディングします。これは、計算能力が `>= 7.5` (Volta) の NVIDIA ハードウェアで Tensor Cores を使用可能にするため、またはシーケンス長が 128 の倍数であることで性能が向上する TPU で、特に有用です。 max_length (`int`, *optional*) : 返されるリストの最大長、および必要に応じてパディング長（上記を参照）。 truncation (`bool`) : *max_length* を超える入力シーケンスを *max_length* に切り詰めるための切り詰め処理を有効にします。 return_attention_mask (`bool`, *任意*) : アテンションマスクを返すかどうか。デフォルトのままにすると、特定の feature_extractor のデフォルトに従ってアテンションマスクを返します。 [アテンションマスクとは?](../glossary#attention-mask) SeamlessM4T モデルでは、微妙なバグを避けるために、バッチ推論では常に `attention_mask` を渡す必要があります。 return_tensors (`str` または [TensorType](/docs/transformers/main/ja/internal/file_utils#transformers.TensorType)、*optional*) : 設定されている場合、Python の整数のリストではなくテンソルを返します。指定可能な値は以下の通りです。 - `'pt'`: PyTorch の `torch.Tensor` オブジェクトを返します。 - `'np'`: Numpy の `np.ndarray` オブジェクトを返します。 sampling_rate (`int`, *任意*) : `raw_speech` 入力がサンプリングされたレートです。サイレントエラーを防ぐため、forward 呼び出し時に `sampling_rate` を渡すことを強く推奨します。 do_normalize_per_mel_bins (`bool`, *任意*, デフォルトは `True`) : 入力データをメルチャネルごとに平均0・分散1に正規化するか否か。 kwargs (*任意*) : トークナイザーまたは特徴抽出器に渡される残りのキーワード引数の辞書。 1つ以上のシーケンスを特徴量化し、モデル用に準備するための主要なメソッド。 ## SeamlessM4TProcessor[[transformers.SeamlessM4TProcessor]] #### transformers.SeamlessM4TProcessor[[transformers.SeamlessM4TProcessor]] ```python transformers.SeamlessM4TProcessor(feature_extractor, tokenizer) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/processing_seamless_m4t.py#L48) **パラメータ:** feature_extractor (`SeamlessM4TFeatureExtractor`) : 特徴抽出器は必須の入力です。 tokenizer (`SeamlessM4TTokenizer`) : トークナイザーは必須の入力です。 SeamlessM4TProcessor を構築します。このクラスは、フィーチャーエクストラクターとトークナイザーを単一のプロセッサーにラップします。 [SeamlessM4TProcessor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TProcessor) は、[SeamlessM4TFeatureExtractor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor) と [SeamlessM4TTokenizer](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTokenizer) のすべての機能を提供します。詳細については、[~SeamlessM4TFeatureExtractor](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TFeatureExtractor) および [~SeamlessM4TTokenizer](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTokenizer) を参照してください。 #### __call__[[transformers.SeamlessM4TProcessor.__call__]] ```python __call__(text: str | list[str] | list[list[str]] | None = None, audio: typing.Union[numpy.ndarray, ForwardRef('torch.Tensor'), collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence['torch.Tensor'], NoneType] = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/processing_seamless_m4t.py#L54) **パラメータ:** text (`Union[str, list[str], list[list[str]]]`、*任意*) : エンコード対象のシーケンスまたはシーケンスのバッチです。各シーケンスは文字列、または文字列のリスト（プレトークナイズ済み文字列）であることができます。プレトークナイズ済み入力を渡す場合は、バッチ入力との曖昧さを避けるために `is_split_into_words=True` を設定してください。 audio (`Union[numpy.ndarray, torch.Tensor, collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence[torch.Tensor]]`, *任意*) : 準備対象のオーディオまたはオーディオのバッチです。各オーディオは NumPy 配列または PyTorch テンソルであることができます。NumPy 配列/PyTorch テンソルの場合、各オーディオの形状は (C, T) である必要があります。ここで C はチャネル数、T はオーディオのサンプル長を表します。 return_tensors (`str` または [TensorType](/docs/transformers/main/ja/internal/file_utils#transformers.TensorType)、*optional*) : 設定されている場合、特定のフレームワークのテンソルを返します。受け入れ可能な値は以下の通りです: - `'pt'`: PyTorch の `torch.Tensor` オブジェクトを返します。 - `'np'`: NumPy の `np.ndarray` オブジェクトを返します。 - ****kwargs** ([ProcessingKwargs](/docs/transformers/main/ja/main_classes/processors#transformers.ProcessingKwargs), *optional*) : 各モダリティ（テキスト、画像、動画、音声）の追加処理オプション。モデル固有のパラメータは上記にリストされています。サポートされている引数の完全なリストについては、TypedDict クラスを参照してください。 **戻り値:** [BatchEncoding](/docs/transformers/main/ja/main_classes/tokenizer#transformers.BatchEncoding) 以下のフィールドを持つ[BatchEncoding](/docs/transformers/main/ja/main_classes/tokenizer#transformers.BatchEncoding): - **input_ids** -- モデルに与えるトークンIDのリスト。`text`が`None`でない場合に返されます。 - **attention_mask** -- モデルが注意すべきトークンを指定するインデックスのリスト（`return_attention_mask=True`の場合、または`self.model_input_names`に*"attention_mask"*が含まれており`text`が`None`でない場合）。 - **input_features** -- モデルに与える音声入力特徴量。`audios` が `None` でない場合に返されます。 ## SeamlessM4TCodeHifiGan[[transformers.SeamlessM4TCodeHifiGan]] #### transformers.SeamlessM4TCodeHifiGan[[transformers.SeamlessM4TCodeHifiGan]] ```python transformers.SeamlessM4TCodeHifiGan(config: SeamlessM4TConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2122) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 この[リポジトリ](https://github.com/facebookresearch/speech-resynthesis)に記載されている HiFi-GAN ボコーダーのコード。 このモデルは [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.SeamlessM4TCodeHifiGan.forward]] ```python forward(input_ids: LongTensor, spkr_id: Tensor, lang_id: Tensor, **kwargs) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2198) **パラメータ:** input_ids (`torch.LongTensor`、形状 `(batch_size, sequence_length)`) : 語彙における入力シーケンスのトークンインデックス。[SeamlessM4TTextToUnitForConditionalGeneration](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTextToUnitForConditionalGeneration) を使用してインデックスを取得できます。[入力IDとは何ですか？](../glossary#input-ids) spkr_id (`int`, *optional*) : 音声合成に使用される話者のID。`config.vocoder_num_spkrs`より小さい値である必要があります。 tgt_lang (`str`, *任意*) : 翻訳のターゲット言語として使用する言語 ID。 ## SeamlessM4THifiGan[[transformers.SeamlessM4THifiGan]] #### transformers.SeamlessM4THifiGan[[transformers.SeamlessM4THifiGan]] ```python transformers.SeamlessM4THifiGan(config: SeamlessM4TConfig) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2045) #### forward[[transformers.SeamlessM4THifiGan.forward]] ```python forward(inputs_embeds: Tensor) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L2080) **パラメータ:** spectrogram (`torch.Tensor`) : log-melスペクトログラムを含むテンソル。バッチ化された形状`(batch_size, sequence_length, model_in_dim)`、またはバッチ化されていない形状`(sequence_length, model_in_dim)`のいずれかです。なお、`model_in_dim`は`config.unit_embed_dim`、`config.lang_embed_dim`、`config.spkr_embed_dim`の合計です。 **戻り値:** `torch.Tensor` 音声波形を含むテンソル。入力スペクトログラムがバッチ化されている場合、形状は`(batch_size, num_frames,)`になります。バッチ化されていない場合、形状は`(num_frames,)`になります。 log-melスペクトログラムを音声波形に変換します。log-melスペクトログラムのバッチを渡すと、音声波形のバッチが返されます。単一のバッチ化されていないlog-melスペクトログラムを渡すと、単一のバッチ化されていない音声波形が返されます。 ## SeamlessM4TTextToUnitModel[[transformers.SeamlessM4TTextToUnitModel]] #### transformers.SeamlessM4TTextToUnitModel[[transformers.SeamlessM4TTextToUnitModel]] ```python transformers.SeamlessM4TTextToUnitModel(config: SeamlessM4TConfig, embed_tokens_decoder: typing.Optional[torch.nn.Embedding] = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L1752) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 embed_tokens_decoder (`nn.Embedding`、*任意*) : デコーダーの入力埋め込み。 Transformerの素のテキストからユニットへのエンコーダー・デコーダーです。エンコーダーは埋め込みを持たない`SeamlessM4TEncoder`であり、デコーダーは`SeamlessM4TDecoder`です。 このモデルは [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.SeamlessM4TTextToUnitModel.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, decoder_input_ids: typing.Optional[torch.LongTensor] = None, decoder_attention_mask: typing.Optional[torch.LongTensor] = None, encoder_outputs: tuple[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, use_cache: bool | None = None, **kwargs: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L1770) **パラメータ:** 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) decoder_input_ids (`torch.LongTensor`、shape `(batch_size, target_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#decoder-input-ids) decoder_attention_mask (`torch.LongTensor`、shape `(batch_size, target_sequence_length)`、*optional*) : 特定のトークンインデックスに対するアテンションの実行を回避するためのマスク。デフォルトでは、モデルが未来を予測する際に過去の入力のみを参照できるようにするため、causal mask が使用されます。 encoder_outputs (`tuple[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` の値を採ります。 use_cache (`bool`, *任意*) : `True`に設定すると、`past_key_values`のキーバリュー状態が返され、デコーディングの高速化に利用できます（`past_key_values`を参照）。 **戻り値:** [Seq2SeqModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqModelOutput) または `tuple(torch.Tensor)` 設定（[SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)）や入力に応じて、さまざまな要素で構成される [Seq2SeqModelOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqModelOutput) または `torch.Tensor` のタプル（`return_dict=False` が渡された場合、または `config.return_dict=False` の場合）。 [SeamlessM4TTextToUnitModel](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTextToUnitModel)の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** (`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)` です。 各層の出力におけるデコーダーのHidden-states、および任意の初期埋め込み出力。 - **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)` です。 各層の出力におけるエンコーダーのHidden-states、および任意の初期埋め込み出力。 - **encoder_attentions** (`tuple(torch.Tensor)`、*任意*、`output_attentions=True` が渡された場合または `config.output_attentions=True` の場合に返されます) -- 各レイヤーごとに 1 つの `torch.Tensor` からなるタプルで、形状は `(batch_size, num_heads, sequence_length, sequence_length)` です。 アテンションのsoftmaxを適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。 ## SeamlessM4TTextToUnitForConditionalGeneration[[transformers.SeamlessM4TTextToUnitForConditionalGeneration]] #### transformers.SeamlessM4TTextToUnitForConditionalGeneration[[transformers.SeamlessM4TTextToUnitForConditionalGeneration]] ```python transformers.SeamlessM4TTextToUnitForConditionalGeneration(config: SeamlessM4TConfig, embed_tokens_decoder: typing.Optional[torch.nn.Embedding] = None) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L1831) **パラメータ:** config ([SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)) : モデルのすべてのパラメータを含むモデル設定クラスです。設定ファイルで初期化しても、モデルに関連する重みは読み込まれず、設定のみが読み込まれます。モデルの重みをロードするには、[from_pretrained()](/docs/transformers/main/ja/main_classes/model#transformers.PreTrainedModel.from_pretrained) メソッドを参照してください。 embed_tokens_decoder (`nn.Embedding`、*任意*) : デコーダーの入力埋め込み。 言語モデルヘッドを備えたTransformerのテキストからユニットへのエンコーダー・デコーダーです。ベースとなるエンコーダー・デコーダーモデルは`SeamlessM4TTextToUnit`です。 このモデルは [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.SeamlessM4TTextToUnitForConditionalGeneration.forward]] ```python forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, decoder_input_ids: typing.Optional[torch.LongTensor] = None, decoder_attention_mask: typing.Optional[torch.LongTensor] = None, encoder_outputs: tuple[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: *) ``` [ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t/modeling_seamless_m4t.py#L1875) **パラメータ:** 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) decoder_input_ids (`torch.LongTensor`、shape `(batch_size, target_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#decoder-input-ids) Bart は `decoder_input_ids` の生成の開始トークンとして `eos_token_id` を使用します。`past_key_values` を使用する場合は、オプションとして最後の `decoder_input_ids` だけを入力すれば十分です（`past_key_values` を参照）。翻訳や要約の学習では、`decoder_input_ids` を提供する必要があります。`decoder_input_ids` が提供されない場合、モデルは論文に従い、デノイジング事前学習のために `input_ids` を右にシフトしてこのテンソルを生成します。 decoder_attention_mask (`torch.LongTensor`、形状 `(batch_size, target_sequence_length)`、*任意*) : デフォルトの動作: `decoder_input_ids` 内の pad トークンを無視するテンソルを生成します。デフォルトでは、causal mask も使用されます。パディングの動作を変更する場合は、`modeling_bart._prepare_decoder_attention_mask` を読み、必要に応じて修正してください。デフォルトの戦略に関する詳細は、[論文](https://huggingface.co/papers/1910.13461) の図 1 を参照してください。 encoder_outputs (`tuple[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`、形状`(batch_size, sequence_length, hidden_size)`、*任意*) : `input_ids`を渡す代わりに、埋め込み表現を直接渡すこともできます。これは、モデル内部の埋め込みルックアップ行列よりも、`input_ids`のインデックスを関連するベクトルに変換する方法をより細かく制御したい場合に便利です。 labels (`torch.LongTensor`、形状 `(batch_size, sequence_length)`、*任意*): マスクド言語モデリング損失を計算するためのラベル。インデックスは`[-100, 0, ..., config.vocab_size]`の範囲である必要があります（`input_ids`のドキュメント文字列を参照）。インデックスが`-100`に設定されたトークンは無視（マスク）され、損失は`[0, ..., config.vocab_size]`の範囲のラベルを持つトークンに対してのみ計算されます。 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)`、*任意*) : マスク言語モデリング損失を計算するためのラベル。インデックスは `[0, ..., config.vocab_size]` の範囲内であるか、-100 である必要があります（`input_ids` のドキュメント文字列を参照）。インデックスが `-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)` 設定（[SeamlessM4TConfig](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TConfig)）や入力に応じて、さまざまな要素で構成される、[Seq2SeqLMOutput](/docs/transformers/main/ja/main_classes/output#transformers.modeling_outputs.Seq2SeqLMOutput)または`torch.Tensor`のタプル（`return_dict=False`が渡された場合、または`config.return_dict=False`の場合）。 [SeamlessM4TTextToUnitForConditionalGeneration](/docs/transformers/main/ja/model_doc/seamless_m4t#transformers.SeamlessM4TTextToUnitForConditionalGeneration) の 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を適用した後のエンコーダーのアテンション重み。自己アテンションヘッドにおける加重平均の計算に使用されます。