# EasyAnimateTransformer3DModel

Модель Diffusion Transformer для 3D-данных от [EasyAnimate](https://github.com/aigc-apps/EasyAnimate) была представлена Alibaba PAI.

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

```python
from diffusers import EasyAnimateTransformer3DModel

transformer = EasyAnimateTransformer3DModel.from_pretrained("alibaba-pai/EasyAnimateV5.1-12b-zh", subfolder="transformer", dtype=torch.float16).to("cuda")  # or "mps", "xpu", "cpu"
```

## EasyAnimateTransformer3DModel[[diffusers.EasyAnimateTransformer3DModel]]

#### diffusers.EasyAnimateTransformer3DModel[[diffusers.EasyAnimateTransformer3DModel]]

```python
diffusers.EasyAnimateTransformer3DModel(num_attention_heads: int = 48, attention_head_dim: int = 64, in_channels: int | None = None, out_channels: int | None = None, patch_size: int | None = None, sample_width: int = 90, sample_height: int = 60, activation_fn: str = 'gelu-approximate', timestep_activation_fn: str = 'silu', freq_shift: int = 0, num_layers: int = 48, mmdit_layers: int = 48, dropout: float = 0.0, time_embed_dim: int = 512, add_norm_text_encoder: bool = False, text_embed_dim: int = 3584, text_embed_dim_t5: int = None, norm_eps: float = 1e-05, norm_elementwise_affine: bool = True, flip_sin_to_cos: bool = True, time_position_encoding_type: str = '3d_rope', after_norm = False, resize_inpaint_mask_directly: bool = True, enable_text_attention_mask: bool = True, add_noise_in_inpaint_model: bool = True)
```

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_easyanimate.py#L316)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

time_position_encoding_type (`str`, по умолчанию `3d_rope`) : Тип кодирования временной позиции.

after_norm (`bool`, по умолчанию `False`) : Флаг для применения нормализации после.

resize_inpaint_mask_directly (`bool`, по умолчанию `True`) : Флаг для непосредственного изменения размера маски инпейнта.

enable_text_attention_mask (`bool`, по умолчанию `True`) : Флаг для включения маски внимания для текста.

add_noise_in_inpaint_model (`bool`, по умолчанию `False`) : Флаг для добавления шума в модель inpaint.

Модель Transformer для видеоподобных данных в [EasyAnimate](https://github.com/aigc-apps/EasyAnimate).

#### forward[[diffusers.EasyAnimateTransformer3DModel.forward]]

```python
forward(hidden_states: Tensor, timestep: Tensor, timestep_cond: typing.Optional[torch.Tensor] = None, encoder_hidden_states: typing.Optional[torch.Tensor] = None, encoder_hidden_states_t5: typing.Optional[torch.Tensor] = None, inpaint_latents: typing.Optional[torch.Tensor] = None, control_latents: typing.Optional[torch.Tensor] = None, return_dict: bool = True)
```

[Источник](https://github.com/huggingface/diffusers/blob/v0.43.0/src/diffusers/models/transformers/transformer_easyanimate.py#L461)

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

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

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

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

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

encoder_hidden_states_t5 (`torch.Tensor`, *необязательный*) : Дополнительные условные эмбеддинги, вычисленные текстовым энкодером T5.

inpaint_latents (`torch.Tensor`, *необязательный*) : Латенты, конкатенированные с `hidden_states` для вариантов модели, поддерживающих инпейнтинг.

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

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

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

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

Метод forward модели [EasyAnimateTransformer3DModel](/docs/diffusers/v0.43.0/ru/api/models/easyanimate_transformer3d#diffusers.EasyAnimateTransformer3DModel).

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

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