# HeliosTransformer3DModel

[Helios](https://github.com/PKU-YuanGroup/Helios) によって、[Helios: Real Real-Time Long Video Generation Model](https://huggingface.co/papers/2603.04379) (北京大学 & ByteDance & 他) で紹介された、3D 動画のようなデータ向けの 14B リアルタイム自己回帰型 Diffusion Transformer モデル (T2V、I2V、V2V をサポート)

モデルは、以下のコードスニペットで読み込むことができます。

```python
from diffusers import HeliosTransformer3DModel

# Best Quality
transformer = HeliosTransformer3DModel.from_pretrained("BestWishYsh/Helios-Base", subfolder="transformer", dtype=torch.bfloat16)
# Intermediate Weight
transformer = HeliosTransformer3DModel.from_pretrained("BestWishYsh/Helios-Mid", subfolder="transformer", dtype=torch.bfloat16)
# Best Efficiency
transformer = HeliosTransformer3DModel.from_pretrained("BestWishYsh/Helios-Distilled", subfolder="transformer", dtype=torch.bfloat16)
```

## HeliosTransformer3DModel[[diffusers.HeliosTransformer3DModel]]

#### diffusers.HeliosTransformer3DModel[[diffusers.HeliosTransformer3DModel]]

```python
diffusers.HeliosTransformer3DModel(patch_size: tuple[int, ...] = (1, 2, 2), num_attention_heads: int = 40, attention_head_dim: int = 128, in_channels: int = 16, out_channels: int = 16, text_dim: int = 4096, freq_dim: int = 256, ffn_dim: int = 13824, num_layers: int = 40, cross_attn_norm: bool = True, qk_norm: str | None = 'rms_norm_across_heads', eps: float = 1e-06, added_kv_proj_dim: int | None = None, rope_dim: tuple[int, ...] = (44, 42, 42), rope_theta: float = 10000.0, guidance_cross_attn: bool = True, zero_history_timestep: bool = True, has_multi_term_memory_patch: bool = True, is_amplify_history: bool = False, history_scale_mode: str = 'per_head')
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_helios.py#L501)

**パラメータ:**

patch_size (`tuple[int]`、デフォルトは`(1, 2, 2)`) : 動画埋め込み用の3Dパッチ次元 (t_patch, h_patch, w_patch)。

num_attention_heads (`int`、デフォルトは`40`) : テキスト埋め込みの固定長。

attention_head_dim (`int`、デフォルトは`128`) : 各ヘッドのチャネル数。

in_channels (`int`、デフォルトは`16`) : 入力におけるチャネル数。

out_channels (`int`、デフォルトは`16`) : 出力のチャネル数。

text_dim (`int`、デフォルトは`512`) : テキスト埋め込みの入力次元。

freq_dim (`int`、デフォルトは`256`) : 正弦波時間埋め込みの次元数。

ffn_dim (`int`、デフォルトは`13824`) : フィードフォワードネットワークの中間次元。

num_layers (`int`、デフォルトは`40`) : 使用するtransformerブロックの層数。

window_size (`tuple[int]`、デフォルトは`(-1, -1)`) : ローカルアテンションのウィンドウサイズ（-1 はグローバルアテンションを示します）。

cross_attn_norm (`bool`、デフォルトは`True`) : クロスアテンションの正規化を有効にします。

qk_norm (`bool`、デフォルトは`True`) : クエリ/キーの正規化を有効にします。

eps (`float`、デフォルトは `1e-6`) : 正規化レイヤー用のエプシロン値。

add_img_emb (`bool`、デフォルトは`False`) : img_embを使用するかどうか。

added_kv_proj_dim (`int`、*任意*、デフォルトは`None`) : 追加されるキーおよびバリューの投影に使用するチャネル数。`None`の場合、投影は使用されません。

Heliosモデルで使用される、動画のようなデータ向けのTransformerモデル。

#### forward[[diffusers.HeliosTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, timestep: LongTensor, encoder_hidden_states: Tensor, indices_hidden_states = None, indices_latents_history_short = None, indices_latents_history_mid = None, indices_latents_history_long = None, latents_history_short = None, latents_history_mid = None, latents_history_long = None, return_dict: bool = True, attention_kwargs: dict[str, typing.Any] | None = None)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_helios.py#L661)

**パラメータ:**

hidden_states (`torch.Tensor`、形状 `(batch_size, num_channels, num_frames, height, width)`) : 入力 `hidden_states`。

timestep (`torch.LongTensor`) : デノイジングステップを示すために使用されます。

encoder_hidden_states (`torch.Tensor`、shape `(batch_size, sequence_len, embed_dims)`) : 使用する条件埋め込み（プロンプトなどの入力条件から計算される埋め込み）。

indices_hidden_states (`torch.Tensor`, *任意*) : `hidden_states` を用いて回転位置埋め込みを計算するために使用されるフレームのインデックス。

indices_latents_history_short (`torch.Tensor`、*任意*) : 短期履歴潜在変数のフレームインデックス。

indices_latents_history_mid (`torch.Tensor`, *任意*) : 中間履歴潜在変数のフレームインデックス。

indices_latents_history_long (`torch.Tensor`, *任意*) : 長い履歴の潜在変数に対するフレームのインデックス。

latents_history_short (`torch.Tensor`, *任意*) : 短期履歴の潜在変数による条件付け。

latents_history_mid (`torch.Tensor`、*任意*) : 中間履歴の潜在変数による条件付け。

latents_history_long (`torch.Tensor`、*任意*) : 長い履歴の潜変数による条件付け。

return_dict (`bool`、*任意*、デフォルトは`True`) : プレーンなタプルではなく`~models.transformer_2d.Transformer2DModelOutput`を返すかどうか。

attention_kwargs (`dict`, *任意*) : 指定された場合、[diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py) の `self.processor` で定義されている `AttentionProcessor` に渡される kwargs の辞書です。

**戻り値:**

`return_dict` が True の場合、`~models.transformer_2d.Transformer2DModelOutput` が返され、それ以外の場合は、最初の要素がサンプルテンソルである `tuple` が返されます。

[HeliosTransformer3DModel](/docs/diffusers/main/ja/api/models/helios_transformer3d#diffusers.HeliosTransformer3DModel)のforwardメソッドです。

## Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]

#### diffusers.models.modeling_outputs.Transformer2DModelOutput[[diffusers.models.modeling_outputs.Transformer2DModelOutput]]

```python
diffusers.models.modeling_outputs.Transformer2DModelOutput(sample: torch.Tensor)
```

[ソース](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L21)

**パラメータ:**

sample (`torch.Tensor`、shape は `(batch_size, num_channels, height, width)`、または [Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel) が離散型の場合 `(batch size, num_vector_embeds - 1, num_latent_pixels)`) : `encoder_hidden_states` 入力を条件とする隠れ状態の出力です。離散型の場合、ノイズ除去されていない潜在ピクセルの確率分布を返します。

[Transformer2DModel](/docs/diffusers/main/ja/api/models/transformer2d#diffusers.Transformer2DModel)の出力です。