# SeamlessM4T-v2

## 概要

SeamlessM4T-v2モデルは、Meta AIのSeamless Communicationチームによって、[Seamless: Multilingual Expressive and Streaming Speech Translation](https://huggingface.co/papers/2312.05187)で提案されました。

SeamlessM4T-v2は、高品質な翻訳を提供するために設計されたモデルのコレクションです。これにより、異なる言語コミュニティの人々が音声やテキストを通じて、簡単にコミュニケーションを取ることができます。[以前のバージョン](./seamless_m4t)からの改善版です。v1とv2の違いの詳細については、[Difference with SeamlessM4T-v1](#difference-with-seamlessm4t-v1)セクションを参照してください。

SeamlessM4T-v2は、個別のモデルに依存せずに複数のタスクを可能にします:

- 音声対音声翻訳 (S2ST)
- 音声からテキストへの翻訳（S2TT）
- テキストから音声への翻訳（T2ST）
- テキストからテキストへの翻訳 (T2TT)
- 自動音声認識 (ASR)

[SeamlessM4Tv2Model](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model) は上記のすべてのタスクを実行できますが、各タスクにはそれぞれ専用のサブモデルが用意されています。

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

*自動音声翻訳の最近の進歩により、対応言語が大幅に拡大し、マルチモーダル機能が向上し、幅広いタスクや機能が実現可能になりました。とはいえ、現在の大規模な自動音声翻訳システムは、人間同士の対話と比較した際に、機械を介したコミュニケーションをシームレスに感じさせるための重要な機能を欠いています。本稿では、ストリーミング形式でエンドツーエンドの表現力豊かで多言語の翻訳を可能にするモデルファミリーを紹介します。まず、大規模な多言語・マルチモーダルモデルであるSeamlessM4Tの改良版であるSeamlessM4T v2を提供します。この新しいモデルは、更新されたUnitY2フレームワークを組み込み、より多くの低リソース言語データで学習されています。拡張されたSeamlessAlignは、合計76言語に対応する114,800時間の自動アラインメントデータを追加しています。SeamlessM4T v2は、我々の2つの最新モデルであるSeamlessExpressiveとSeamlessStreamingの基盤となります。SeamlessExpressiveは、声のスタイルやプロソディを保持した翻訳を可能にします。従来の表現力のある音声研究と比較して、我々の研究は、話速やポーズといったプロソディの未十分に探索された側面に対処すると同時に、声のスタイルも保持します。SeamlessStreamingについては、我々のモデルはEfficient Monotonic Multihead Attention (EMMA)メカニズムを活用し、完全なソース発話を待たずに低レイテンシのターゲット翻訳を生成します。初の試みとして、SeamlessStreamingは、複数のソース言語とターゲット言語における同時音声対音声/テキスト翻訳を可能にします。これらのモデルの性能を理解するために、既存の自動評価指標の新規および修正版を組み合わせ、プロソディ、レイテンシ、頑健性を評価しました。人間による評価では、意味の保持、自然さ、表現力において最も関連性の高い属性を測定するために調整された既存のプロトコルを適用しました。モデルが安全かつ責任を持って使用されることを保証するために、マルチモーダル機械翻訳における既知の最初のレッドチーミング活動、追加された毒性の検出と軽減のためのシステム、ジェンダーバイアスの体系的評価、そしてディープフェイクの影響を軽減するために設計された聴覚的に検出できないローカライズドウォーターマーク機構を実装しました。その結果、SeamlessExpressiveとSeamlessStreamingの主要なコンポーネントを統合し、リアルタイムで表現力豊かな言語間コミュニケーションを可能にする、最初の公開システムであるSeamlessを構築しました。要するに、Seamlessは、ユニバーサル・スピーチ・トランスレーターをSFの概念から現実の技術へと変えるために必要な技術的基盤を垣間見ることができます。最後に、本稿の貢献——モデル、コード、ウォーターマーク検出器を含む——は、以下のリンクから公開され、アクセス可能です。*

## 使用方法

次の例では、アラビア語の音声サンプルと英語のテキストサンプルを読み込み、それぞれをロシア語の音声とフランス語のテキストに変換します。

まず、プロセッサーとモデルのチェックポイントを読み込みます:

```python
from transformers import AutoProcessor, SeamlessM4Tv2Model

processor = AutoProcessor.from_pretrained("facebook/seamless-m4t-v2-large")
model = SeamlessM4Tv2Model.from_pretrained("facebook/seamless-m4t-v2-large", 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 text as well
text_inputs = processor(text = "Hello, my dog is cute", src_lang="eng", return_tensors="pt").to(model.device)
```

### 音声

[SeamlessM4Tv2Model](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model) は、ほとんど変更を加えずに、*シームレスに*テキストや音声の生成を行うことができます。ここでは、ロシア語の音声翻訳をターゲットとします。

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

ほぼ同じコードで、英語のテキストとアラビア語の音声からロシア語の音声サンプルを生成しました。

### テキスト

同様に、同じモデルで音声ファイルやテキストから翻訳テキストを生成できます。[SeamlessM4Tv2Model.generate()](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model.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. 専用モデルを使用する

[SeamlessM4Tv2Model](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model) は、音声とテキストを生成するための transformers のトップレベルモデルです。ただし、追加のコンポーネントなしでタスクを実行できる専用モデルを使用することもでき、これによりメモリフットプリントを削減できます。例えば、音声から音声への生成のスニペットを、S2ST タスクに特化したモデルに置き換えることができます。残りのコードは完全に同じです。

```python
from transformers import SeamlessM4Tv2ForSpeechToSpeech

model = SeamlessM4Tv2ForSpeechToSpeech.from_pretrained("facebook/seamless-m4t-v2-large", device_map="auto")
```

または、テキストからテキストへの生成スニペットを、T2TTタスクに特化したモデルに置き換えることもできます。その場合、`generate_speech=False`を削除するだけです。

```python
from transformers import SeamlessM4Tv2ForTextToText

model = SeamlessM4Tv2ForTextToText.from_pretrained("facebook/seamless-m4t-v2-large", device_map="auto")
```

[SeamlessM4Tv2ForSpeechToText](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForSpeechToText)や[SeamlessM4Tv2ForTextToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForTextToSpeech)もぜひ試してみてください。

#### 2. 話者IDを変更する

`speaker_id` 引数を変更することで、音声合成に使用するスピーカーを変更できます。一部の `speaker_id` は、特定の言語に対してより良い結果をもたらします。

#### 3. 生成戦略を変更する

テキスト生成には、[生成戦略](../generation_strategies)を複数選択できます。例えば、`.generate(input_ids=input_ids, text_num_beams=4, text_do_sample=True)` は、テキストモデルに対して多項分布ビームサーチデコーディングを実行します。なお、音声生成はデフォルトでグリーディ法のみをサポートし、多項分布サンプリングは例えば `.generate(..., speech_do_sample=True, speech_temperature=0.6)` のように使用できます。

#### 4. 音声とテキストを同時に生成する

`return_intermediate_token_ids=True` を [SeamlessM4Tv2Model](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model) と併用すると、音声とテキストの両方を返すことができます!

## モデルアーキテクチャ

SeamlessM4T-v2は、テキストと音声の逐次的な生成を滑らかに処理する多用途なアーキテクチャを備えています。この構成は、2つのシーケンスツーシーケンス（seq2seq）モデルで構成されています。最初のモデルは入力モダリティを翻訳テキストに変換し、2番目のモデルは翻訳テキストから「ユニットトークン」と呼ばれる音声トークンを生成します。

各モダリティには、独自のアーキテクチャを持つ専用のエンコーダーが用意されています。また、音声出力については、[HiFi-GAN](https://huggingface.co/papers/2010.05646)アーキテクチャに着想を得たボコーダーが、2番目のseq2seqモデルの上に配置されています。

### SeamlessM4T-v1との違い

この新バージョンのアーキテクチャは、最初のバージョンと以下の点で異なります。

#### 2パスモデルの改善

2番目のseq2seqモデルであるtext-to-unitモデルは、現在は非自己回帰型となり、**単一のフォワードパス**でユニットを計算します。この実現には、以下の要素が貢献しています。

- **文字レベルの埋め込み**を使用し、予測された翻訳テキストの各文字に独自の埋め込みが割り当てられ、それらがユニットトークンの予測に用いられます。
- 予測された翻訳テキストに対して、**文字レベル**で音声の長さを予測する中間的な長さ予測器の使用。
- より長いコンテキストを処理するために、畳み込みと自己注意を組み合わせる新しいテキストからユニットへのデコーダーを使用すること。

#### 音声エンコーダーの違い

1パス目の生成プロセスにおいて翻訳テキストを予測するために使用される音声エンコーダーは、主に以下のメカニズムによって、従来の音声エンコーダーと異なります。

- チャンク化されたアテンションマスクを使用してチャンク間のアテンションを防止し、各ポジションが自身のチャンク内および固定数の直前のチャンク内のポジションにのみアテンションを行うことを保証します。
- シーケンス要素間の絶対位置ではなく距離のみを考慮する相対位置埋め込みの使用です。詳細については、[Self-Attention with Relative Position Representations (Shaw et al.)](https://huggingface.co/papers/1803.02155)を参照してください。
- 非因果的なものではなく、因果的な深度方向畳み込みを使用すること。

### 生成プロセス

生成プロセスの仕組みは以下の通りです：

- 入力されたテキストまたは音声は、それぞれに対応するエンコーダーによって処理されます。
- デコーダーは、希望する言語のテキストトークンを生成します。
- 音声生成が必要な場合、2番目のseq2seqモデルが、非自己回帰的な方法でユニットトークンを生成します。
- これらのユニットトークンは、最終的なボコーダーを通過して、実際の音声として生成されます。

このモデルは[ylacombe](https://huggingface.co/ylacombe)によって提供されました。元のコードは[こちら](https://github.com/facebookresearch/seamless_communication)で確認できます。

## SeamlessM4Tv2Model[[transformers.SeamlessM4Tv2Model]]

#### transformers.SeamlessM4Tv2Model[[transformers.SeamlessM4Tv2Model]]

```python
transformers.SeamlessM4Tv2Model(config: SeamlessM4Tv2Config, current_modality = 'text')
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L3664)

**パラメータ:**

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

current_modality (`str`、*任意*、デフォルトは`"text"`) : デフォルトのモダリティ。モデルの初期化に使用されます。

利用可能なすべてのタスク（S2ST、S2TT、T2TT、T2ST）に使用できる、元のSeamlessM4Tv2モデルの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.SeamlessM4Tv2Model.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, speaker_id: int | None = 0, generate_speech: bool | None = True, **kwargs)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L3858)

**パラメータ:**

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`, *任意*) : 翻訳のターゲット言語として使用する言語。

speaker_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[SeamlessM4Tv2GenerationOutput, tuple[Tensor], ModelOutput]`

- `generate_speech`と`return_intermediate_token_ids`が指定されている場合、`SeamlessM4Tv2GenerationOutput`を返します。
- `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)を参照してください。

## SeamlessM4Tv2ForTextToSpeech[[transformers.SeamlessM4Tv2ForTextToSpeech]]

#### transformers.SeamlessM4Tv2ForTextToSpeech[[transformers.SeamlessM4Tv2ForTextToSpeech]]

```python
transformers.SeamlessM4Tv2ForTextToSpeech(config: SeamlessM4Tv2Config)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L2983)

**パラメータ:**

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

T2STに使用できるテキストから音声への変換用のSeamlessM4Tv2モデル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.SeamlessM4Tv2ForTextToSpeech.generate]]

```python
generate(input_ids: typing.Optional[torch.Tensor] = None, return_intermediate_token_ids: bool | None = None, tgt_lang: str | None = None, speaker_id: int | None = 0, **kwargs)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L3117)

**パラメータ:**

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`, *任意*) : 翻訳のターゲット言語として使用する言語。

speaker_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[SeamlessM4Tv2GenerationOutput, tuple[Tensor]]`

- `return_intermediate_token_ids`が設定されている場合、`SeamlessM4Tv2GenerationOutput`を返します。
- `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)を参照してください。

## SeamlessM4Tv2ForSpeechToSpeech[[transformers.SeamlessM4Tv2ForSpeechToSpeech]]

#### transformers.SeamlessM4Tv2ForSpeechToSpeech[[transformers.SeamlessM4Tv2ForSpeechToSpeech]]

```python
transformers.SeamlessM4Tv2ForSpeechToSpeech(config: SeamlessM4Tv2Config)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L3321)

**パラメータ:**

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

S2STに使用できる音声対話用のSeamlessM4Tv2モデルの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.SeamlessM4Tv2ForSpeechToSpeech.generate]]

```python
generate(input_features: typing.Optional[torch.Tensor] = None, return_intermediate_token_ids: bool | None = None, tgt_lang: str | None = None, speaker_id: int | None = 0, **kwargs)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L3454)

**パラメータ:**

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`, *任意*) : 翻訳のターゲット言語として使用する言語。

speaker_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[SeamlessM4Tv2GenerationOutput, tuple[Tensor]]`

- `return_intermediate_token_ids`が設定されている場合、`SeamlessM4Tv2GenerationOutput`を返します。
- `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)を参照してください。

## SeamlessM4Tv2ForTextToText[[transformers.SeamlessM4Tv2ForTextToText]]

#### transformers.SeamlessM4Tv2ForTextToText[[transformers.SeamlessM4Tv2ForTextToText]]

```python
transformers.SeamlessM4Tv2ForTextToText(config: SeamlessM4Tv2Config)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L2500)

**パラメータ:**

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

T2TTに使用できるテキストからテキストへの変換を行うSeamlessM4Tv2モデルの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.SeamlessM4Tv2ForTextToText.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: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L2536)

**パラメータ:**

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

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

[SeamlessM4Tv2ForTextToText](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForTextToText)の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.SeamlessM4Tv2ForTextToText.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_v2/modeling_seamless_m4t_v2.py#L2618)

**パラメータ:**

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)を参照してください。

## SeamlessM4Tv2ForSpeechToText[[transformers.SeamlessM4Tv2ForSpeechToText]]

#### transformers.SeamlessM4Tv2ForSpeechToText[[transformers.SeamlessM4Tv2ForSpeechToText]]

```python
transformers.SeamlessM4Tv2ForSpeechToText(config: SeamlessM4Tv2Config)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L2735)

**パラメータ:**

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

S2TTに使用できる音声からテキストへの変換モデルであるSeamlessM4Tv2の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.SeamlessM4Tv2ForSpeechToText.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: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[ソース](https://github.com/huggingface/transformers/blob/main/src/transformers/models/seamless_m4t_v2/modeling_seamless_m4t_v2.py#L2773)

**パラメータ:**

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

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

[SeamlessM4Tv2ForSpeechToText](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForSpeechToText)の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, SeamlessM4Tv2ForSpeechToText
>>> 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 = SeamlessM4Tv2ForSpeechToText.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.SeamlessM4Tv2ForSpeechToText.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_v2/modeling_seamless_m4t_v2.py#L2864)

**パラメータ:**

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)を参照してください。

## SeamlessM4Tv2Config[[transformers.SeamlessM4Tv2Config]]

#### transformers.SeamlessM4Tv2Config[[transformers.SeamlessM4Tv2Config]]

```python
transformers.SeamlessM4Tv2Config(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, char_vocab_size: int = 10943, hidden_size: int = 1024, initializer_range: float = 0.02, layer_norm_eps: float = 1e-05, use_cache: bool = True, max_position_embeddings: int = 4096, 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, 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_key', conv_depthwise_kernel_size: int = 31, left_max_position_embeddings: int = 64, right_max_position_embeddings: int = 8, speech_encoder_chunk_size: int = 20000, speech_encoder_left_chunk_num: int = 128, t2u_bos_token_id: int | None = 0, t2u_pad_token_id: int | None = 1, t2u_eos_token_id: int | list[int] | None = 2, 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 = 4096, t2u_variance_predictor_embed_dim: int = 1024, t2u_variance_predictor_hidden_dim: int = 256, t2u_variance_predictor_kernel_size: int = 3, t2u_variance_pred_dropout: float | int = 0.5, 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_v2/configuration_seamless_m4t_v2.py#L24)

**パラメータ:**

is_encoder_decoder (`bool`、*任意*、デフォルトは`True`) : モデルがエンコーダー/デコーダーとして使用されるかどうかを示します。

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

t2u_vocab_size (`int`、*任意*、デフォルトは 10082) : SeamlessM4Tv2 モデルのユニット語彙サイズ。[~SeamlessM4Tv2Model](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model)、[~SeamlessM4Tv2ForSpeechToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForSpeechToSpeech)、または [~SeamlessM4Tv2ForTextToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForTextToSpeech) の Text-To-Units サブモデルを呼び出す際に渡す `inputs_ids` で表現できる異なる「ユニットトークン」の数を定義します。

char_vocab_size (`int`, *optional*, デフォルトは 10943) : SeamlessM4Tv2 モデルの文字語彙サイズ。[~SeamlessM4Tv2Model](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model)、[~SeamlessM4Tv2ForSpeechToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForSpeechToSpeech) または [~SeamlessM4Tv2ForTextToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForTextToSpeech) の Text-To-Units サブモデルを呼び出す際に渡す `char_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`、*任意*、デフォルトは`4096`) : このモデルが使用される可能性のある最大シーケンス長です。

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) で入力オーディオを処理した後の次元です。

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_key"`) : `relative_key`に指定できます。`None`のままにすると、相対位置埋め込みは適用されません。音声エンコーダーにのみ適用されます。`"relative_key"`の詳細については、[Self-Attention with Relative Position Representations (Shaw et al.)](https://huggingface.co/papers/1803.02155)を参照してください。

conv_depthwise_kernel_size (`int`、*optional*、デフォルトは 31) : Conformer ブロック内の畳み込み深度方向 1D レイヤーのカーネルサイズ。音声エンコーダーにのみ適用されます。

left_max_position_embeddings (`int`、*optional*、デフォルトは 64) : 相対位置の左クリップ値です。

right_max_position_embeddings (`int`、*optional*、デフォルトは 8) : 相対位置の右側のクリッピング値。

speech_encoder_chunk_size (`int`、*optional*、デフォルトは 20000) : 各アテンションチャンクのサイズ。

speech_encoder_left_chunk_num (`int`、*optional*、デフォルトは 128) : 左側で lookahead が許可される最大チャンク数。

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_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*, デフォルトは 4096) : このモデルの text-to-unit コンポーネントが使用される可能性のある最大シーケンス長です。念のため、通常は大きめの値（例: 512、1024、2048 など）に設定します。

t2u_variance_predictor_embed_dim (`int`、*任意*、デフォルトは 1024) : text-to-unit の duration predictor の射影次元です。

t2u_variance_predictor_hidden_dim (`int`、*任意*、デフォルトは 256) : text-to-unit の duration predictor の内部次元です。

t2u_variance_predictor_kernel_size (`int`、*オプション*、デフォルトは 3) : text-to-unit の duration predictor の畳み込み層のカーネルサイズ。

t2u_variance_pred_dropout (`float`、*optional*、デフォルトは 0.5) : text-to-unit の duration predictor の dropout 確率です。

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) : SeamlessM4Tv2 ボコーダーの語彙サイズ。[~SeamlessM4Tv2Model](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2Model)、[~SeamlessM4Tv2ForSpeechToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForSpeechToSpeech) または [~SeamlessM4Tv2ForTextToSpeech](/docs/transformers/main/ja/model_doc/seamless_m4t_v2#transformers.SeamlessM4Tv2ForTextToSpeech) のボコーダーを呼び出す際に渡す `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`マッピングに従って重み埋め込みを共有するかどうか。

This is the configuration class to store the configuration of a SeamlessM4Tv2Model. It is used to instantiate a Seamless M4T V2 model according to the specified arguments, defining the model architecture. Instantiating a configuration with the defaults will yield a similar configuration to that of the [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 SeamlessM4Tv2Model, SeamlessM4Tv2Config

>>> # Initializing a SeamlessM4Tv2 "" style configuration
>>> configuration = SeamlessM4Tv2Config()

>>> # Initializing a model from the "" style configuration
>>> model = SeamlessM4Tv2Model(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config
```