# CosmosTransformer3DModel

Модель Diffusion Transformer для 3D-видеоподобных данных была представлена в [Cosmos World Foundation Model Platform for Physical AI](https://huggingface.co/papers/2501.03575) от NVIDIA.

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

```python
from diffusers import CosmosTransformer3DModel

transformer = CosmosTransformer3DModel.from_pretrained("nvidia/Cosmos-1.0-Diffusion-7B-Text2World", subfolder="transformer", dtype=torch.bfloat16)
```

## CosmosTransformer3DModel[[diffusers.CosmosTransformer3DModel]]

#### diffusers.CosmosTransformer3DModel[[diffusers.CosmosTransformer3DModel]]

```python
diffusers.CosmosTransformer3DModel(in_channels: int = 16, out_channels: int = 16, num_attention_heads: int = 32, attention_head_dim: int = 128, num_layers: int = 28, mlp_ratio: float = 4.0, text_embed_dim: int = 1024, adaln_lora_dim: int = 256, max_size: tuple[int, int, int] = (128, 240, 240), patch_size: tuple[int, int, int] = (1, 2, 2), rope_scale: tuple[float, float, float] = (2.0, 1.0, 1.0), concat_padding_mask: bool = True, extra_pos_embed_type: str | None = 'learnable', use_crossattn_projection: bool = False, crossattn_proj_in_channels: int = 1024, encoder_hidden_states_channels: int = 1024, controlnet_block_every_n: int | None = None, img_context_dim_in: int | None = None, img_context_num_tokens: int = 256, img_context_dim_out: int = 2048)
```

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

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

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

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

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

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

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

mlp_ratio (`float`, по умолчанию `4.0`) : Соотношение размера скрытого слоя к размеру входа в полносвязной сети.

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

adaln_lora_dim (`int`, по умолчанию `256`) : Скрытое измерение слоя Adaptive LayerNorm LoRA.

max_size (`tuple[int, int, int]`, по умолчанию `(128, 240, 240)`) : Максимальный размер входных тензоров латентов по временному, вертикальному и горизонтальному измерениям.

patch_size (`tuple[int, int, int]`, по умолчанию `(1, 2, 2)`) : Размер патча, используемый для разбиения входных тензоров латентов на патчи по временному, вертикальному и горизонтальному измерениям.

rope_scale (`tuple[float, float, float]`, по умолчанию `(2.0, 1.0, 1.0)`) : Коэффициент масштабирования для RoPE в временном, вертикальном и горизонтальном измерениях.

concat_padding_mask (`bool`, по умолчанию `True`) : Нужно ли конкатенировать маску отступов с входными тензорами латентов.

extra_pos_embed_type (`str`, *необязательный*, по умолчанию `learnable`) : Тип дополнительных позиционных эмбеддингов для использования. Может быть `None` или `learnable`.

controlnet_block_every_n (`int`, *optional*) : Интервал между блоками трансформера, которые должны получать управляющие остаточные связи (например, `7` для инъекции после каждого седьмого блока). Обязательно для Cosmos Transfer2.5.

img_context_dim_in (`int`, *optional*) : Размерность вектора контекстных признаков входного изображения, то есть это D в [B, N, D].

img_context_num_tokens (`int`) : Количество токенов в векторе признаков контекста изображения, то есть это N в [B, N, D]. Если `img_context_dim_in` не задано, этот параметр игнорируется.

img_context_dim_out (`int`) : Размер выходного измерения слоя проекции контекста изображения. Если `img_context_dim_in` не задан, этот параметр игнорируется.

Модель Transformer для видеоподобных данных, используемая в [Cosmos](https://github.com/NVIDIA/Cosmos).

#### forward[[diffusers.CosmosTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, timestep: Tensor, encoder_hidden_states: Tensor, block_controlnet_hidden_states: list[torch.Tensor] | None = None, attention_mask: typing.Optional[torch.Tensor] = None, fps: int | None = None, condition_mask: typing.Optional[torch.Tensor] = None, padding_mask: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```

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

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

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

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

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

block_controlnet_hidden_states (`list` из `torch.Tensor`, *необязательный*) : Список тензоров, которые при указании добавляются к остаточным связям блоков трансформера.

attention_mask (`torch.Tensor`, *необязательный*) : Маска, применяемая к `encoder_hidden_states` во время внимания.

fps (`int`, *optional*) : Количество кадров в секунде входного видео, используемое для вычисления вращательных позиционных эмбеддингов.

condition_mask (`torch.Tensor`, *необязательный*) : Канал маски, конкатенированный с `hidden_states` для указания области условного контекста.

padding_mask (`torch.Tensor`, *необязательный*) : Маска отступов, конкатенированная с `hidden_states`, когда включён `concat_padding_mask`.

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

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

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

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

## 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).