# CogVideoXDPMScheduler

`CogVideoXDPMScheduler` se basa en [DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps](https://huggingface.co/papers/2206.00927) y [DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models](https://huggingface.co/papers/2211.01095), específicamente para los modelos CogVideoX.

## CogVideoXDPMScheduler[[diffusers.CogVideoXDPMScheduler]]

#### diffusers.CogVideoXDPMScheduler[[diffusers.CogVideoXDPMScheduler]]

```python
diffusers.CogVideoXDPMScheduler(num_train_timesteps: int = 1000, beta_start: float = 0.00085, beta_end: float = 0.012, beta_schedule: typing.Literal['linear', 'scaled_linear', 'squaredcos_cap_v2'] = 'scaled_linear', trained_betas: numpy.ndarray | list[float] | None = None, clip_sample: bool = True, set_alpha_to_one: bool = True, steps_offset: int = 0, prediction_type: typing.Literal['epsilon', 'sample', 'v_prediction'] = 'epsilon', clip_sample_range: float = 1.0, sample_max_value: float = 1.0, timestep_spacing: typing.Literal['leading', 'linspace', 'trailing'] = 'leading', rescale_betas_zero_snr: bool = False, snr_shift_scale: float = 3.0)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L134)

**Parámetros:**

num_train_timesteps (`int`, por defecto 1000) : El número de pasos de difusión para entrenar el modelo.

beta_start (`float`, por defecto 0.0001) : El valor inicial de `beta` para la inferencia.

beta_end (`float`, por defecto 0.02) : El valor final de `beta`.

beta_schedule (`str`, por defecto `"linear"`) : La programación de beta, un mapeo desde un rango de beta hasta una secuencia de betas para dar pasos al modelo. Elija entre `linear`, `scaled_linear` o `squaredcos_cap_v2`.

trained_betas (`np.ndarray`, *opcional*) : Pasa un array de betas directamente al constructor para omitir `beta_start` y `beta_end`.

clip_sample (`bool`, por defecto `True`) : Recorta la muestra predicha para la estabilidad numérica.

clip_sample_range (`float`, por defecto 1.0) : La magnitud máxima para el recorte de muestras. Solo es válido cuando `clip_sample=True`.

set_alpha_to_one (`bool`, por defecto `True`) : Cada paso de difusión utiliza el valor del producto de alfas en ese paso y en el anterior. En el paso final no hay un alfa anterior. Cuando esta opción es `True`, el producto de alfas anterior se fija en `1`; de lo contrario, se utiliza el valor de alfa en el paso 0.

steps_offset (`int`, valor predeterminado 0) : Un desplazamiento que se suma a los pasos de inferencia, tal como lo requieren algunas familias de modelos.

prediction_type (`str`, defaults to `epsilon`, *optional*) : Prediction type of the scheduler function; can be `epsilon` (predicts the noise of the diffusion process), `sample` (directly predicts the noisy sample`) or `v_prediction` (see section 2.4 of [Imagen Video](https://huggingface.co/papers/2210.02303) paper).

thresholding (`bool`, por defecto `False`) : Si se debe utilizar el método de "umbral dinámico". No es adecuado para modelos de difusión en el espacio latente, como Stable Diffusion.

dynamic_thresholding_ratio (`float`, por defecto 0.995) : La proporción para el método de umbral dinámico. Solo es válido cuando `thresholding=True`.

sample_max_value (`float`, por defecto 1.0) : El valor de umbral para el umbral dinámico. Solo es válido cuando `thresholding=True`.

timestep_spacing (`str`, por defecto `"leading"`) : La forma en que se deben escalar los timesteps. Consulte la Tabla 2 de [Common Diffusion Noise Schedules and Sample Steps are Flawed](https://huggingface.co/papers/2305.08891) para obtener más información. Elija entre `leading`, `linspace` o `trailing`.

rescale_betas_zero_snr (`bool`, por defecto `False`) : Si se deben reescalar los betas para tener un SNR terminal cero. Esto permite al modelo generar muestras muy brillantes y oscuras en lugar de limitarlo a muestras con un brillo medio. Relacionado de forma laxa con [`--offset_noise`](https://github.com/huggingface/diffusers/blob/74fd735eb073eb1d774b1ab4154a0876eb82f055/examples/dreambooth/train_dreambooth.py#L506).

snr_shift_scale (`float`, por defecto 3.0) : Escala de desplazamiento para SNR.

`DDIMScheduler` extiende el procedimiento de desruido introducido en los modelos probabilísticos de difusión de desruido (DDPM) con una guía no markoviana.

Este modelo hereda de [SchedulerMixin](/docs/diffusers/main/es/api/schedulers/overview#diffusers.SchedulerMixin) y [ConfigMixin](/docs/diffusers/main/es/api/configuration#diffusers.ConfigMixin). Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos los programadores, como la carga y el guardado.

#### add_noise[[diffusers.CogVideoXDPMScheduler.add_noise]]

```python
add_noise(original_samples: Tensor, noise: Tensor, timesteps: IntTensor)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L522)

**Parámetros:**

original_samples (`torch.Tensor`) : Las muestras originales a las que se les añadirá ruido.

noise (`torch.Tensor`) : El ruido que se añadirá a las muestras.

timesteps (`torch.IntTensor`) : Los pasos de tiempo que indican el nivel de ruido para cada muestra.

**Devuelve:** `torch.Tensor`

Las muestras ruidosas.

Añada ruido a las muestras originales según la magnitud del ruido en cada paso temporal (este es el proceso de difusión hacia adelante).

#### get_mult[[diffusers.CogVideoXDPMScheduler.get_mult]]

```python
get_mult(h: Tensor, r: Tensor, alpha_prod_t: Tensor, alpha_prod_t_prev: Tensor, alpha_prod_t_back: typing.Optional[torch.Tensor] = None)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L364)

**Parámetros:**

h (`torch.Tensor`) : La diferencia de log-SNR.

r (`torch.Tensor`) : La proporción de diferencias de log-SNR.

alpha_prod_t (`torch.Tensor`) : El producto acumulado de los alfas en el paso de tiempo actual.

alpha_prod_t_prev (`torch.Tensor`) : El producto acumulado de alphas en el paso de tiempo anterior.

alpha_prod_t_back (`torch.Tensor`, *opcional*) : El producto acumulado de alphas en el paso de tiempo anterior al paso de tiempo anterior.

**Devuelve:** `tuple`

Una tupla que contiene los multiplicadores.

Calcule los multiplicadores para la muestra anterior y la muestra original predicha.

#### get_variables[[diffusers.CogVideoXDPMScheduler.get_variables]]

```python
get_variables(alpha_prod_t: Tensor, alpha_prod_t_prev: Tensor, alpha_prod_t_back: typing.Optional[torch.Tensor] = None)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L331)

**Parámetros:**

alpha_prod_t (`torch.Tensor`) : El producto acumulado de los alfas en el paso de tiempo actual.

alpha_prod_t_prev (`torch.Tensor`) : El producto acumulado de alphas en el paso de tiempo anterior.

alpha_prod_t_back (`torch.Tensor`, *opcional*) : El producto acumulado de alphas en el paso de tiempo anterior al paso de tiempo anterior.

**Devuelve:** `tuple`

Una tupla que contiene las variables `h`, `r`, `lamb`, `lamb_next`.

Calcule las variables utilizadas para DPM-Solver++ (2M) haciendo referencia a la implementación original.

#### get_velocity[[diffusers.CogVideoXDPMScheduler.get_velocity]]

```python
get_velocity(sample: Tensor, noise: Tensor, timesteps: IntTensor)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L565)

**Parámetros:**

sample (`torch.Tensor`) : La muestra de entrada.

noise (`torch.Tensor`) : El tensor de ruido.

timesteps (`torch.IntTensor`) : Los pasos de tiempo para el cálculo de la velocidad.

**Devuelve:** `torch.Tensor`

La velocidad calculada.

Calcule la predicción de velocidad a partir de la muestra y el ruido según la fórmula de velocidad.

#### scale_model_input[[diffusers.CogVideoXDPMScheduler.scale_model_input]]

```python
scale_model_input(sample: Tensor, timestep: int | None = None)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L262)

**Parámetros:**

sample (`torch.Tensor`) : La muestra de entrada.

timestep (`int`, *opcional*) : El paso temporal actual en la cadena de difusión.

**Devuelve:** `torch.Tensor`

Una muestra de entrada escalada.

Garantiza la interoperabilidad con los programadores que necesitan escalar la entrada del modelo de desruido en función del paso temporal actual.

#### set_timesteps[[diffusers.CogVideoXDPMScheduler.set_timesteps]]

```python
set_timesteps(num_inference_steps: int, device: typing.Union[str, torch.device, NoneType] = None)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L279)

**Parámetros:**

num_inference_steps (`int`) : El número de pasos de difusión utilizados al generar muestras con un modelo preentrenado.

device (`str` o `torch.device`, *opcional*) : El dispositivo al que deben moverse los pasos de tiempo. Si es `None` (el valor predeterminado), los pasos de tiempo no se mueven.

Establece los pasos discretos utilizados para la cadena de difusión (para ejecutarse antes de la inferencia).

#### paso[[diffusers.CogVideoXDPMScheduler.step]]

```python
step(model_output: Tensor, old_pred_original_sample: Tensor, timestep: int, timestep_back: int, sample: Tensor, eta: float = 0.0, use_clipped_model_output: bool = False, generator: typing.Optional[torch.Generator] = None, variance_noise: typing.Optional[torch.Tensor] = None, return_dict: bool = False)
```

[Fuente](https://github.com/huggingface/diffusers/blob/main/src/diffusers/schedulers/scheduling_dpm_cogvideox.py#L401)

**Parámetros:**

model_output (`torch.Tensor`) : La salida directa del modelo de difusión aprendido.

old_pred_original_sample (`torch.Tensor`) : La muestra original predicha del paso de tiempo anterior.

timestep (`int`) : El paso de tiempo discreto actual en la cadena de difusión.

timestep_back (`int`) : El paso de tiempo al que se debe mirar hacia atrás.

sample (`torch.Tensor`) : Una instancia actual de una muestra creada por el proceso de difusión.

eta (`float`) : El peso del ruido para el ruido añadido en el paso de difusión.

use_clipped_model_output (`bool`, por defecto `False`) : Si `True`, calcula el `model_output` "corregido" a partir de la muestra original predicha recortada. Es necesario porque la muestra original predicha se recorta a [-1, 1] cuando `self.config.clip_sample` es `True`. Si no se ha realizado ningún recorte, el `model_output` "corregido" coincidiría con el proporcionado como entrada y `use_clipped_model_output` no tendría efecto.

generator (`torch.Generator`, *opcional*) : Un generador de números aleatorios.

variance_noise (`torch.Tensor`) : Alternativa a generar ruido con `generator` proporcionando directamente el ruido para la varianza. Útil para métodos como `CycleDiffusion`.

return_dict (`bool`, *opcional*, valor predeterminado `True`) : Indica si se debe devolver un [DDIMSchedulerOutput](/docs/diffusers/main/es/api/schedulers/ddim#diffusers.schedulers.scheduling_ddim.DDIMSchedulerOutput) o una `tuple`.

**Devuelve:** [DDIMSchedulerOutput](/docs/diffusers/main/es/api/schedulers/ddim#diffusers.schedulers.scheduling_ddim.DDIMSchedulerOutput) o `tuple`

Si return_dict es `True`, se devuelve [DDIMSchedulerOutput](/docs/diffusers/main/es/api/schedulers/ddim#diffusers.schedulers.scheduling_ddim.DDIMSchedulerOutput); en caso contrario, se devuelve una tupla cuyo primer elemento es el tensor de la muestra.

Predice la muestra del paso de tiempo anterior invirtiendo el SDE. Esta función propaga el proceso de difusión desde las salidas del modelo aprendido (con mayor frecuencia, el ruido predicho).