Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /es /api /models /cogvideox_transformer3d.md

mishig

8 days ago

preview code

download

raw

9.23 kB

# CogVideoXTransformer3DModel

Un modelo Diffusion Transformer para datos 3D de [CogVideoX](https://github.com/THUDM/CogVideo) fue introducido en [CogVideoX: Text-to-Video Diffusion Models with An Expert Transformer](https://huggingface.co/papers/2408.06072) por Tsinghua University & ZhipuAI.

El modelo se puede cargar con el siguiente fragmento de código.

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

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L160)

**Parámetros:**

num_attention_heads (`int`, por defecto `30`) : El número de cabezas a utilizar para la atención multi-cabeza.

attention_head_dim (`int`, por defecto `64`) : El número de canales en cada cabeza.

in_channels (`int`, por defecto `16`) : El número de canales en la entrada.
out_channels (`int`, *opcional*, valor predeterminado `16`) : El número de canales en la salida.

flip_sin_to_cos (`bool`, por defecto `True`) : Si se debe cambiar el sin por el cos en la incrustación temporal.
time_embed_dim (`int`, por defecto `512`) : Dimensión de salida de las incrustaciones de paso de tiempo.
ofs_embed_dim (`int`, por defecto `512`) : Dimensión de salida de los embeddings "ofs" utilizados en CogVideoX-5b-I2B en la versión 1.5
text_embed_dim (`int`, por defecto `4096`) : Dimensión de entrada de las incrustaciones de texto del codificador de texto.
num_layers (`int`, por defecto `30`) : El número de bloques de Transformer a utilizar.

dropout (`float`, por defecto `0.0`) : La probabilidad de dropout a utilizar.

attention_bias (`bool`, por defecto `True`) : Si se debe usar sesgo en las capas de proyección de atención.
sample_width (`int`, por defecto `90`) : El ancho de los latentes de entrada.

sample_height (`int`, por defecto `60`) : La altura de los latentes de entrada.
sample_frames (`int`, por defecto `49`) : El número de fotogramas en los latentes de entrada. Tenga en cuenta que este parámetro se inicializó incorrectamente en 49 en lugar de 13, ya que CogVideoX procesaba 13 fotogramas latentes a la vez en su configuración predeterminada y recomendada, pero no puede cambiarse al valor correcto para garantizar la compatibilidad hacia atrás. Para crear un transformador con K fotogramas latentes, el valor correcto que debe pasarse aquí sería: ((K - 1) * temporal_compression_ratio + 1).

patch_size (`int`, por defecto `2`) : El tamaño de los parches a utilizar en la capa de incrustación de parches.
temporal_compression_ratio (`int`, por defecto `4`) : La relación de compresión a lo largo de la dimensión temporal. Consulte la documentación de `sample_frames`.

max_text_seq_length (`int`, por defecto `226`) : La longitud máxima de la secuencia de las incrustaciones de texto de entrada.
activation_fn (`str`, por defecto `"gelu-approximate"`) : Función de activación a utilizar en la red feed-forward.

timestep_activation_fn (`str`, por defecto `"silu"`) : Función de activación a utilizar al generar las incrustaciones de paso temporal.

norm_elementwise_affine (`bool`, por defecto `True`) : Si se debe usar afinidad elementwise en las capas de normalización.

norm_eps (`float`, por defecto `1e-5`) : El valor de epsilon a utilizar en las capas de normalización.
spatial_interpolation_scale (`float`, por defecto `1.875`) : Factor de escala a aplicar en los embeddings posicionales 3D a lo largo de las dimensiones espaciales.
temporal_interpolation_scale (`float`, por defecto `1.0`) : Factor de escala a aplicar en las incrustaciones posicionales 3D a lo largo de las dimensiones temporales.
Un modelo Transformer para datos tipo video en [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)
```
[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L366)
**Parámetros:**
hidden_states (`torch.Tensor` de forma `(batch_size, num_frames, channels, height, width)`) : `hidden_states` de entrada.

encoder_hidden_states (`torch.Tensor` de forma `(batch_size, sequence_len, embed_dims)`) : Embeddings condicionales (embeddings calculados a partir de las condiciones de entrada, como los prompts) a utilizar.

timestep (`torch.LongTensor`) : Se utiliza para indicar el paso de desruido.

timestep_cond (`torch.Tensor`, *opcional*) : Incrustaciones condicionales para el paso de tiempo. Si se proporcionan, las incrustaciones se sumarán con las muestras que pasan por la capa `self.time_embedding` para obtener las incrustaciones finales del paso de tiempo.

ofs (`torch.Tensor`, *opcional*) : Embeddings de desplazamiento utilizados en CogVideoX-5b-I2V.

image_rotary_emb (`tuple` de `torch.Tensor`, *opcional*) : Incrustaciones posicionales rotatorias precalculadas.

attention_kwargs (`dict`, *opcional*) : Un diccionario de kwargs que, si se especifica, se pasa al `AttentionProcessor` tal como se define bajo `self.processor` en [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).
return_dict (`bool`, *opcional*, valor predeterminado `True`) : Indica si se debe devolver un `~models.transformer_2d.Transformer2DModelOutput` en lugar de una tupla simple.

**Devuelve:**

Si `return_dict` es True, se devuelve un `~models.transformer_2d.Transformer2DModelOutput`; en caso contrario, se devuelve una `tuple` cuyo primer elemento es el tensor de la muestra.

El método forward de [CogVideoXTransformer3DModel](/docs/diffusers/main/es/api/models/cogvideox_transformer3d#diffusers.CogVideoXTransformer3DModel).

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

```python
fuse_qkv_projections()
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L335)

Habilita las proyecciones QKV fusionadas. Para los módulos de autoatención, todas las matrices de proyección (es decir, consulta, clave y valor) se fusionan. Para los módulos de atención cruzada, las matrices de proyección de clave y valor se fusionan.

> [!WARNING] > Esta API es 🧪 experimental.

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

```python
unfuse_qkv_projections()
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L357)

Desactiva la proyección QKV fusionada si está habilitada.

> [!WARNING] > Esta API es 🧪 experimental.

## 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)
```
[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/modeling_outputs.py#L21)
**Parámetros:**
sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)` o `(batch size, num_vector_embeds - 1, num_latent_pixels)` si [Transformer2DModel](/docs/diffusers/main/es/api/models/transformer2d#diffusers.Transformer2DModel) es discreto): las salidas de estados ocultos condicionadas a la entrada `encoder_hidden_states`. Si es discreto, devuelve distribuciones de probabilidad para los píxeles latentes sin ruido.
La salida de [Transformer2DModel](/docs/diffusers/main/es/api/models/transformer2d#diffusers.Transformer2DModel).

Xet Storage Details

Size:: 9.23 kB
Xet hash:: ca8ad080ae397a61be885946b0ba11d675dda7fa702943de9a482c1bddb03e9b

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# CogVideoXTransformer3DModel

	Un modelo Diffusion Transformer para datos 3D de [CogVideoX](https://github.com/THUDM/CogVideo) fue introducido en [CogVideoX: Text-to-Video Diffusion Models with An Expert Transformer](https://huggingface.co/papers/2408.06072) por Tsinghua University & ZhipuAI.

	El modelo se puede cargar con el siguiente fragmento de código.

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

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L160)

	Parámetros:

	num_attention_heads (`int`, por defecto `30`) : El número de cabezas a utilizar para la atención multi-cabeza.

	attention_head_dim (`int`, por defecto `64`) : El número de canales en cada cabeza.

	in_channels (`int`, por defecto `16`) : El número de canales en la entrada.

	out_channels (`int`, opcional, valor predeterminado `16`) : El número de canales en la salida.

	flip_sin_to_cos (`bool`, por defecto `True`) : Si se debe cambiar el sin por el cos en la incrustación temporal.

	time_embed_dim (`int`, por defecto `512`) : Dimensión de salida de las incrustaciones de paso de tiempo.

	ofs_embed_dim (`int`, por defecto `512`) : Dimensión de salida de los embeddings "ofs" utilizados en CogVideoX-5b-I2B en la versión 1.5

	text_embed_dim (`int`, por defecto `4096`) : Dimensión de entrada de las incrustaciones de texto del codificador de texto.

	num_layers (`int`, por defecto `30`) : El número de bloques de Transformer a utilizar.

	dropout (`float`, por defecto `0.0`) : La probabilidad de dropout a utilizar.

	attention_bias (`bool`, por defecto `True`) : Si se debe usar sesgo en las capas de proyección de atención.

	sample_width (`int`, por defecto `90`) : El ancho de los latentes de entrada.

	sample_height (`int`, por defecto `60`) : La altura de los latentes de entrada.

	sample_frames (`int`, por defecto `49`) : El número de fotogramas en los latentes de entrada. Tenga en cuenta que este parámetro se inicializó incorrectamente en 49 en lugar de 13, ya que CogVideoX procesaba 13 fotogramas latentes a la vez en su configuración predeterminada y recomendada, pero no puede cambiarse al valor correcto para garantizar la compatibilidad hacia atrás. Para crear un transformador con K fotogramas latentes, el valor correcto que debe pasarse aquí sería: ((K - 1) * temporal_compression_ratio + 1).

	patch_size (`int`, por defecto `2`) : El tamaño de los parches a utilizar en la capa de incrustación de parches.

	temporal_compression_ratio (`int`, por defecto `4`) : La relación de compresión a lo largo de la dimensión temporal. Consulte la documentación de `sample_frames`.

	max_text_seq_length (`int`, por defecto `226`) : La longitud máxima de la secuencia de las incrustaciones de texto de entrada.

	activation_fn (`str`, por defecto `"gelu-approximate"`) : Función de activación a utilizar en la red feed-forward.

	timestep_activation_fn (`str`, por defecto `"silu"`) : Función de activación a utilizar al generar las incrustaciones de paso temporal.

	norm_elementwise_affine (`bool`, por defecto `True`) : Si se debe usar afinidad elementwise en las capas de normalización.

	norm_eps (`float`, por defecto `1e-5`) : El valor de epsilon a utilizar en las capas de normalización.

	spatial_interpolation_scale (`float`, por defecto `1.875`) : Factor de escala a aplicar en los embeddings posicionales 3D a lo largo de las dimensiones espaciales.

	temporal_interpolation_scale (`float`, por defecto `1.0`) : Factor de escala a aplicar en las incrustaciones posicionales 3D a lo largo de las dimensiones temporales.

	Un modelo Transformer para datos tipo video en [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)
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L366)

	Parámetros:

	hidden_states (`torch.Tensor` de forma `(batch_size, num_frames, channels, height, width)`) : `hidden_states` de entrada.

	encoder_hidden_states (`torch.Tensor` de forma `(batch_size, sequence_len, embed_dims)`) : Embeddings condicionales (embeddings calculados a partir de las condiciones de entrada, como los prompts) a utilizar.

	timestep (`torch.LongTensor`) : Se utiliza para indicar el paso de desruido.

	timestep_cond (`torch.Tensor`, opcional) : Incrustaciones condicionales para el paso de tiempo. Si se proporcionan, las incrustaciones se sumarán con las muestras que pasan por la capa `self.time_embedding` para obtener las incrustaciones finales del paso de tiempo.

	ofs (`torch.Tensor`, opcional) : Embeddings de desplazamiento utilizados en CogVideoX-5b-I2V.

	image_rotary_emb (`tuple` de `torch.Tensor`, opcional) : Incrustaciones posicionales rotatorias precalculadas.

	attention_kwargs (`dict`, opcional) : Un diccionario de kwargs que, si se especifica, se pasa al `AttentionProcessor` tal como se define bajo `self.processor` en [diffusers.models.attention_processor](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/attention_processor.py).

	return_dict (`bool`, opcional, valor predeterminado `True`) : Indica si se debe devolver un `~models.transformer_2d.Transformer2DModelOutput` en lugar de una tupla simple.

	Devuelve:

	Si `return_dict` es True, se devuelve un `~models.transformer_2d.Transformer2DModelOutput`; en caso contrario, se devuelve una `tuple` cuyo primer elemento es el tensor de la muestra.

	El método forward de [CogVideoXTransformer3DModel](/docs/diffusers/main/es/api/models/cogvideox_transformer3d#diffusers.CogVideoXTransformer3DModel).

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

	```python
	fuse_qkv_projections()
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L335)

	Habilita las proyecciones QKV fusionadas. Para los módulos de autoatención, todas las matrices de proyección (es decir, consulta, clave y valor) se fusionan. Para los módulos de atención cruzada, las matrices de proyección de clave y valor se fusionan.

	> [!WARNING] > Esta API es 🧪 experimental.

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

	```python
	unfuse_qkv_projections()
	```

	[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/models/transformers/cogvideox_transformer_3d.py#L357)

	Desactiva la proyección QKV fusionada si está habilitada.

	> [!WARNING] > Esta API es 🧪 experimental.

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

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

	Parámetros:

	sample (`torch.Tensor` de forma `(batch_size, num_channels, height, width)` o `(batch size, num_vector_embeds - 1, num_latent_pixels)` si [Transformer2DModel](/docs/diffusers/main/es/api/models/transformer2d#diffusers.Transformer2DModel) es discreto): las salidas de estados ocultos condicionadas a la entrada `encoder_hidden_states`. Si es discreto, devuelve distribuciones de probabilidad para los píxeles latentes sin ruido.

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