# HiDreamImageTransformer2DModel

[HiDream-I1](https://huggingface.co/HiDream-ai)の画像類似データ向けのTransformerモデル。

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

```python
from diffusers import HiDreamImageTransformer2DModel

transformer = HiDreamImageTransformer2DModel.from_pretrained("HiDream-ai/HiDream-I1-Full", subfolder="transformer", dtype=torch.bfloat16)
```

## HiDream-I1用のGGUF量子化チェックポイントの読み込み

`HiDreamImageTransformer2DModel` の GGUF チェックポイントは、`~FromOriginalModelMixin.from_single_file` を使用して読み込むことができます。

```python
import torch
from diffusers import GGUFQuantizationConfig, HiDreamImageTransformer2DModel

ckpt_path = "https://huggingface.co/city96/HiDream-I1-Dev-gguf/blob/main/hidream-i1-dev-Q2_K.gguf"
transformer = HiDreamImageTransformer2DModel.from_single_file(
    ckpt_path,
    quantization_config=GGUFQuantizationConfig(compute_dtype=torch.bfloat16),
    dtype=torch.bfloat16
)
```

## HiDreamImageTransformer2DModel[[diffusers.HiDreamImageTransformer2DModel]]

#### diffusers.HiDreamImageTransformer2DModel[[diffusers.HiDreamImageTransformer2DModel]]

```python
diffusers.HiDreamImageTransformer2DModel(patch_size: int | None = None, in_channels: int = 64, out_channels: int | None = None, num_layers: int = 16, num_single_layers: int = 32, attention_head_dim: int = 128, num_attention_heads: int = 20, caption_channels: list[int] = None, text_emb_dim: int = 2048, num_routed_experts: int = 4, num_activated_experts: int = 2, axes_dims_rope: tuple[int, int] = (32, 32), max_resolution: tuple[int, int] = (128, 128), llama_layers: list[int] = None, force_inference_output: bool = False)
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_hidream_image.py#L602)

#### forward[[diffusers.HiDreamImageTransformer2DModel.forward]]

```python
forward(hidden_states: Tensor, timesteps: LongTensor = None, encoder_hidden_states_t5: Tensor = None, encoder_hidden_states_llama3: Tensor = None, pooled_embeds: Tensor = None, img_ids: typing.Optional[torch.Tensor] = None, img_sizes: list[tuple[int, int]] | None = None, hidden_states_masks: typing.Optional[torch.Tensor] = None, attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True)
```

[ソース](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_hidream_image.py#L773)

**パラメータ:**

hidden_states (`torch.Tensor`、shape `(batch_size, in_channels, height, width)` または `(batch_size, patch_height * patch_width, patch_size * patch_size * channels)`) : 入力 `hidden_states`。

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

encoder_hidden_states_t5 (`torch.Tensor`) : T5テキストエンコーダーから計算された条件埋め込み。

encoder_hidden_states_llama3 (`torch.Tensor`) : Llama3 テキストエンコーダーから計算された条件埋め込み。

pooled_embeds (`torch.Tensor`) : 追加の条件付けに使用されるプーリング済みテキスト埋め込み。

img_ids (`torch.Tensor`, *任意*) : パッチ化された隠れ状態の画像位置 ID。

img_sizes (`list` of `tuple` of `int`, *optional*) : 出力をアンパッチファイする際に使用する、サンプルごとのパッチグリッドサイズ。

hidden_states_masks (`torch.Tensor`, *任意*) : パッチ適用済みの`hidden_states`に対するマスク。

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

**戻り値:**

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

[HiDreamImageTransformer2DModel](/docs/diffusers/v0.43.0/ja/api/models/hidream_image_transformer#diffusers.HiDreamImageTransformer2DModel)の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/v0.43.0/src/diffusers/models/modeling_outputs.py#L21)

**パラメータ:**

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

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