# EasyAnimateTransformer3DModel

Un modèle Diffusion Transformer pour des données 3D issu de [EasyAnimate](https://github.com/aigc-apps/EasyAnimate) a été introduit par Alibaba PAI.

Le modèle peut être chargé à l'aide du fragment de code suivant.

```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)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_easyanimate.py#L316)

**Paramètres :**

num_attention_heads (`int`, par défaut `48`) : Le nombre de têtes à utiliser pour l'attention multi-têtes.

attention_head_dim (`int`, par défaut `64`) : Le nombre de canaux dans chaque tête.

in_channels (`int`, par défaut `16`) : Le nombre de canaux dans l'entrée.

out_channels (`int`, *facultatif*, par défaut `16`) : Le nombre de canaux dans la sortie.

patch_size (`int`, par défaut `2`) : La taille des patches à utiliser dans la couche d'encodage de patches.

sample_width (`int`, par défaut `90`) : La largeur des latents d'entrée.

sample_height (`int`, par défaut `60`) : La hauteur des latents d'entrée.

activation_fn (`str`, par défaut `"gelu-approximate"`) : Fonction d'activation à utiliser dans le réseau de neurones à propagation avant.

timestep_activation_fn (`str`, par défaut `"silu"`) : Fonction d'activation à utiliser lors de la génération des embeddings de pas de temps.

num_layers (`int`, par défaut `30`) : Le nombre de blocs Transformer à utiliser.

mmdit_layers (`int`, par défaut `1000`) : Le nombre de blocs Multi Modal Transformer à utiliser.

dropout (`float`, par défaut `0.0`) : La probabilité de dropout à utiliser.

time_embed_dim (`int`, par défaut `512`) : Dimension de sortie des embeddings de pas de temps.

text_embed_dim (`int`, par défaut `4096`) : Dimension d'entrée des embeddings de texte issus de l'encodeur de texte.

norm_eps (`float`, par défaut `1e-5`) : La valeur epsilon à utiliser dans les couches de normalisation.

norm_elementwise_affine (`bool`, par défaut `True`) : Indique s'il faut utiliser une transformation affine élément par élément dans les couches de normalisation.

flip_sin_to_cos (`bool`, par défaut `True`) : Indique s'il faut inverser le sin en cos dans l'encodage temporel.

time_position_encoding_type (`str`, par défaut `3d_rope`) : Type d'encodage de position temporelle.

after_norm (`bool`, par défaut `False`) : Indique si la normalisation doit être appliquée ensuite.

resize_inpaint_mask_directly (`bool`, par défaut `True`) : Indique s'il faut redimensionner directement le masque d'inpainting.

enable_text_attention_mask (`bool`, par défaut `True`) : Drapeau pour activer le masque d'attention du texte.

add_noise_in_inpaint_model (`bool`, par défaut `False`) : Indicateur pour ajouter du bruit dans le modèle d'inpainting.

Un modèle Transformer pour des données de type vidéo dans [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)
```

[Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/transformer_easyanimate.py#L461)

**Paramètres :**

hidden_states (`torch.Tensor` de forme `(batch_size, channels, num_frames, height, width)`) : `hidden_states` en entrée.

timestep (`torch.LongTensor`) : Utilisé pour indiquer l'étape de débruitage.

timestep_cond (`torch.Tensor`, *facultatif*) : Incrustations conditionnelles pour le pas de temps. Si fournies, les incrustations seront additionnées aux échantillons passés par la couche `self.time_embedding` pour obtenir les incrustations finales du pas de temps.

encoder_hidden_states (`torch.Tensor`, *facultatif*) : Embeddings conditionnels (embeddings calculés à partir des conditions d'entrée telles que les prompts) à utiliser.

encoder_hidden_states_t5 (`torch.Tensor`, *facultatif*) : Incrustations conditionnelles supplémentaires calculées à partir d'un encodeur de texte T5.

inpaint_latents (`torch.Tensor`, *facultatif*) : Latents concaténés à `hidden_states` pour les variantes d'inpainting du modèle.

control_latents (`torch.Tensor`, *facultatif*) : Latents concaténés à `hidden_states` pour les variantes de contrôle du modèle.

return_dict (`bool`, *facultatif*, par défaut `True`) : Indique s'il faut retourner un `~models.transformer_2d.Transformer2DModelOutput` plutôt qu'un simple tuple.

**Retourne :**

Si `return_dict` est True, un `~models.transformer_2d.Transformer2DModelOutput` est renvoyé, sinon un `tuple` dont le premier élément est le tenseur d'échantillon.

La méthode forward du [EasyAnimateTransformer3DModel](/docs/diffusers/main/fr/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)
```

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

**Paramètres :**

sample (`torch.Tensor` de forme `(batch_size, num_channels, height, width)` ou `(batch size, num_vector_embeds - 1, num_latent_pixels)` si [Transformer2DModel](/docs/diffusers/main/fr/api/models/transformer2d#diffusers.Transformer2DModel) est discret) : Les états cachés en sortie, conditionnés par l'entrée `encoder_hidden_states`. Si discret, renvoie les distributions de probabilité pour les pixels latents non bruités.

La sortie de [Transformer2DModel](/docs/diffusers/main/fr/api/models/transformer2d#diffusers.Transformer2DModel).