# CogVideoXTransformer3DModel

A Diffusion Transformer model for 3D data from [CogVideoX](https://github.com/THUDM/CogVideo) was introduced in [CogVideoX: Text-to-Video Diffusion Models with An Expert Transformer](https://huggingface.co/papers/2408.06072) by Tsinghua University & ZhipuAI.

Модель можно загрузить с помощью следующего фрагмента кода.

```python
from diffusers import CogVideoXTransformer3DModel

transformer = CogVideoXTransformer3DModel.from_pretrained("THUDM/CogVideoX-2b", subfolder="transformer", dtype=torch.float16).to("cuda")  # or "mps", "xpu", "cpu"
```

## CogVideoXTransformer3DModel[[diffusers.CogVideoXTransformer3DModel]]

#### diffusers.CogVideoXTransformer3DModel[[diffusers.CogVideoXTransformer3DModel]]

```python
diffusers.CogVideoXTransformer3DModel(num_attention_heads: int = 30, attention_head_dim: int = 64, in_channels: int = 16, out_channels: int | None = 16, flip_sin_to_cos: bool = True, freq_shift: int = 0, time_embed_dim: int = 512, ofs_embed_dim: int | None = None, text_embed_dim: int = 4096, num_layers: int = 30, dropout: float = 0.0, attention_bias: bool = True, sample_width: int = 90, sample_height: int = 60, sample_frames: int = 49, patch_size: int = 2, patch_size_t: int | None = None, temporal_compression_ratio: int = 4, max_text_seq_length: int = 226, activation_fn: str = 'gelu-approximate', timestep_activation_fn: str = 'silu', norm_elementwise_affine: bool = True, norm_eps: float = 1e-05, spatial_interpolation_scale: float = 1.875, temporal_interpolation_scale: float = 1.0, use_rotary_positional_embeddings: bool = False, use_learned_positional_embeddings: bool = False, patch_bias: bool = True)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L160)

**Параметры:**

num_attention_heads (`int`, по умолчанию `30`) : Количество головок для использования в механизме multi-head attention.

attention_head_dim (`int`, по умолчанию `64`) : Количество каналов в каждой голове.

in_channels (`int`, по умолчанию `16`) : количество каналов на входе.

out_channels (`int`, *необязательный*, по умолчанию `16`) : Количество каналов на выходе.

flip_sin_to_cos (`bool`, по умолчанию `True`) : Нужно ли заменить sin на cos во временном эмбеддинге.

time_embed_dim (`int`, по умолчанию `512`) : Размерность выходного вектора эмбеддингов временных шагов.

ofs_embed_dim (`int`, по умолчанию `512`) : Размерность выходного вектора эмбеддингов "ofs", используемых в CogVideoX-5b-I2B версии 1.5

text_embed_dim (`int`, по умолчанию `4096`) : Размерность входных текстовых эмбеддингов, полученных от текстового энкодера.

num_layers (`int`, по умолчанию `30`) : Количество блоков Transformer, которые следует использовать.

dropout (`float`, по умолчанию `0.0`) : Вероятность dropout, которую следует использовать.

attention_bias (`bool`, по умолчанию `True`) : Использовать ли смещение (bias) в слоях проекции внимания.

sample_width (`int`, по умолчанию `90`) : Ширина входных латентов.

sample_height (`int`, по умолчанию `60`) : Высота входных латентов.

sample_frames (`int`, по умолчанию `49`) : Количество кадров во входных латентах. Обратите внимание, что этот параметр был неверно инициализирован значением 49 вместо 13, поскольку CogVideoX обрабатывал 13 латентных кадров за один проход в своих настройках по умолчанию и рекомендуемых настройках, однако его нельзя изменить на правильное значение ради обеспечения обратной совместимости. Чтобы создать трансформер с K латентными кадрами, здесь следует передать следующее значение: ((K - 1) * temporal_compression_ratio + 1).

patch_size (`int`, по умолчанию `2`) : Размер патчей, используемых в слое встраивания патчей.

temporal_compression_ratio (`int`, по умолчанию `4`) : Коэффициент сжатия по временному измерению. См. документацию для `sample_frames`.

max_text_seq_length (`int`, по умолчанию `226`) : Максимальная длина последовательности входных текстовых эмбеддингов.

activation_fn (`str`, по умолчанию `"gelu-approximate"`) : Функция активации, используемая в полносвязном слое.

timestep_activation_fn (`str`, по умолчанию `"silu"`) : Функция активации, используемая при генерации эмбеддингов временных шагов.

norm_elementwise_affine (`bool`, по умолчанию `True`) : Использовать ли поэлементное аффинное преобразование в слоях нормализации.

norm_eps (`float`, по умолчанию `1e-5`) : Значение эпсилона, используемое в слоях нормализации.

spatial_interpolation_scale (`float`, по умолчанию `1.875`) : Коэффициент масштабирования, применяемый к 3D-позиционным эмбеддингам вдоль пространственных измерений.

temporal_interpolation_scale (`float`, по умолчанию `1.0`) : Коэффициент масштабирования, применяемый к 3D-позиционным эмбеддингам вдоль временных измерений.

Модель Transformer для видеоподобных данных в [CogVideoX](https://github.com/THUDM/CogVideo).

#### forward[[diffusers.CogVideoXTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, encoder_hidden_states: Tensor, timestep: typing.Union[int, float, torch.LongTensor], timestep_cond: typing.Optional[torch.Tensor] = None, ofs: typing.Union[int, float, torch.LongTensor, NoneType] = None, image_rotary_emb: tuple[torch.Tensor, torch.Tensor] | None = None, attention_kwargs: dict[str, typing.Any] | None = None, return_dict: bool = True)
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L366)

**Параметры:**

hidden_states (`torch.Tensor` формы `(batch_size, num_frames, channels, height, width)`) : входные `hidden_states`.

encoder_hidden_states (`torch.Tensor` формы `(batch_size, sequence_len, embed_dims)`) : Условные эмбеддинги (эмбеддинги, вычисленные на основе входных условий, таких как промпты), которые следует использовать.

timestep (`torch.LongTensor`) : Используется для указания шага денойзинга.

timestep_cond (`torch.Tensor`, *необязательный*) : Условные эмбеддинги для временного шага. Если предоставлены, эмбеддинги будут сложены с сэмплами, прошедшими через слой `self.time_embedding`, чтобы получить итоговые эмбеддинги временного шага.

ofs (`torch.Tensor`, *необязательный*) : Смещения встраиваний, используемые в CogVideoX-5b-I2V.

image_rotary_emb (`tuple` из `torch.Tensor`, *необязательный*) : Предварительно вычисленные вращательные позиционные эмбеддинги.

attention_kwargs (`dict`, *необязательный*) : Словарь kwargs, который при указании передается в `AttentionProcessor`, определенный в `self.processor` в [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

return_dict (`bool`, *необязательный*, по умолчанию `True`) : Возвращать ли `~models.transformer_2d.Transformer2DModelOutput` вместо обычного кортежа.

**Возвращает:**

Если `return_dict` равно True, возвращается `~models.transformer_2d.Transformer2DModelOutput`, иначе — `tuple`, первым элементом которого является тензор выборки.

Метод forward модели [CogVideoXTransformer3DModel](/docs/diffusers/main/ru/api/models/cogvideox_transformer3d#diffusers.CogVideoXTransformer3DModel).

#### fuse_qkv_projections[[diffusers.CogVideoXTransformer3DModel.fuse_qkv_projections]]

```python
fuse_qkv_projections()
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L335)

Включает объединённые проекции QKV. Для модулей само-внимания все матрицы проекций (т. е. запрос, ключ, значение) объединяются. Для модулей кросс-внимания объединяются матрицы проекций ключа и значения.

> [!WARNING] > Этот API 🧪 экспериментальный.

#### unfuse_qkv_projections[[diffusers.CogVideoXTransformer3DModel.unfuse_qkv_projections]]

```python
unfuse_qkv_projections()
```

[Источник](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L357)

Отключает объединенную проекцию QKV, если она включена.

> [!WARNING] > Этот API 🧪 экспериментальный.

## 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` формы `(batch_size, num_channels, height, width)` или `(batch size, num_vector_embeds - 1, num_latent_pixels)`, если [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel) дискретный): выходные скрытые состояния, обусловленные входом `encoder_hidden_states`. Если модель дискретная, возвращает распределения вероятностей для ненашумленных латентных пикселей.

Вывод [Transformer2DModel](/docs/diffusers/main/ru/api/models/transformer2d#diffusers.Transformer2DModel).