# EasyAnimateTransformer3DModel

[EasyAnimate](https://github.com/aigc-apps/EasyAnimate)에서 Alibaba PAI가 3D 데이터를 위한 Diffusion Transformer 모델을 소개했습니다.

다음 코드 스니펫으로 모델을 로드할 수 있습니다.

```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/main/src/diffusers/models/transformers/transformer_easyanimate.py#L316)

**매개변수:**

num_attention_heads (`int`, 기본값 `48`) : multi-head attention에 사용할 헤드 수입니다.

attention_head_dim (`int`, 기본값 `64`) : 각 헤드(head)의 채널 수.

in_channels (`int`, 기본값 `16`) : 입력의 채널 수.

out_channels (`int`, *선택 사항*, 기본값 `16`) : 출력의 채널 수입니다.

patch_size (`int`, 기본값 `2`) : 패치 임베딩 레이어에서 사용할 패치의 크기입니다.

sample_width (`int`, 기본값 `90`) : 입력 latents의 너비.

sample_height (`int`, 기본값 `60`) : 입력 latents의 높이입니다.

activation_fn (`str`, 기본값 `"gelu-approximate"`) : feed-forward에서 사용할 활성화 함수입니다.

timestep_activation_fn (`str`, 기본값 `"silu"`) : timestep 임베딩을 생성할 때 사용할 활성화 함수.

num_layers (`int`, 기본값 `30`) : 사용할 Transformer 블록의 레이어 수입니다.

mmdit_layers (`int`, 기본값 `1000`) : 사용할 Multi Modal Transformer 블록의 레이어 수입니다.

dropout (`float`, 기본값 `0.0`) : 사용할 dropout 확률입니다.

time_embed_dim (`int`, 기본값 `512`) : timestep 임베딩의 출력 차원.

text_embed_dim (`int`, 기본값 `4096`) : 텍스트 인코더에서 생성된 텍스트 임베딩의 입력 차원입니다.

norm_eps (`float`, 기본값 `1e-5`) : 정규화 레이어에서 사용할 epsilon 값입니다.

norm_elementwise_affine (`bool`, 기본값 `True`) : 정규화 레이어에서 요소별 affine 변환을 사용할지 여부.

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`) : inpaint mask를 직접 리사이즈할지 여부를 지정하는 플래그입니다.

enable_text_attention_mask (`bool`, 기본값 `True`) : 텍스트 어텐션 마스크를 활성화할 플래그입니다.

add_noise_in_inpaint_model (`bool`, 기본값 `False`) : inpaint 모델에 노이즈를 추가할지 여부를 지정하는 플래그입니다.

[EasyAnimate](https://github.com/aigc-apps/EasyAnimate)의 비디오 유사 데이터용 Transformer 모델입니다.

#### 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/main/src/diffusers/models/transformers/transformer_easyanimate.py#L461)

**매개변수:**

hidden_states (`torch.Tensor`, shape `(batch_size, channels, num_frames, height, width)`) : 입력 `hidden_states`.

timestep (`torch.LongTensor`) : 노이즈 제거 단계를 나타내는 데 사용됩니다.

timestep_cond (`torch.Tensor`, *선택 사항*) : timestep을 위한 조건부 임베딩입니다. 제공된 경우, `self.time_embedding` 레이어를 통해 전달된 샘플과 합산되어 최종 timestep 임베딩을 얻습니다.

encoder_hidden_states (`torch.Tensor`, *선택 사항*) : 사용할 조건 임베딩(프롬프트와 같은 입력 조건에서 계산된 임베딩).

encoder_hidden_states_t5 (`torch.Tensor`, *선택 사항*) : T5 텍스트 인코더에서 계산된 추가 조건 임베딩입니다.

inpaint_latents (`torch.Tensor`, *선택 사항*) : 모델의 inpainting 변형에서 `hidden_states`에 연결되는 Latents입니다.

control_latents (`torch.Tensor`, *선택 사항*) : 모델의 컨트롤 변형에서 `hidden_states`에 연결되는 Latents.

return_dict (`bool`, *선택 사항*, 기본값 `True`) : 일반 튜플 대신 `~models.transformer_2d.Transformer2DModelOutput`을 반환할지 여부.

**반환값:**

`return_dict`가 True이면 `~models.transformer_2d.Transformer2DModelOutput`이 반환되고, 그렇지 않으면 첫 번째 요소가 샘플 텐서인 `tuple`이 반환됩니다.

[EasyAnimateTransformer3DModel](/docs/diffusers/main/ko/api/models/easyanimate_transformer3d#diffusers.EasyAnimateTransformer3DModel)의 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/main/src/diffusers/models/modeling_outputs.py#L21)

**매개변수:**

sample (`torch.Tensor`, shape `(batch_size, num_channels, height, width)` 또는 [Transformer2DModel](/docs/diffusers/main/ko/api/models/transformer2d#diffusers.Transformer2DModel)이 discrete인 경우 `(batch size, num_vector_embeds - 1, num_latent_pixels)`) : `encoder_hidden_states` 입력에 조건부인 hidden states 출력입니다. discrete인 경우, 노이즈가 제거된 latent 픽셀에 대한 확률 분포를 반환합니다.

[Transformer2DModel](/docs/diffusers/main/ko/api/models/transformer2d#diffusers.Transformer2DModel)의 출력입니다.