Hugging Face's logo

Diffusers documentation

DPMSolverSinglestepScheduler

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.42.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

DPMSolverSinglestepScheduler

DPMSolverSinglestepScheduler es un programador de un solo paso de DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps y DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models de Cheng Lu, Yuhao Zhou, Fan Bao, Jianfei Chen, Chongxuan Li y Jun Zhu.

DPMSolver (y la versión mejorada DPMSolver++) es un solver de alto orden dedicado y rápido para ecuaciones diferenciales ordinarias de difusión, con garantía de orden de convergencia. Empíricamente, el muestreo con DPMSolver de solo 20 pasos puede generar muestras de alta calidad, y puede generar muestras bastante buenas incluso en 10 pasos.

La implementación original se puede encontrar en LuChengTHU/dpm-solver.

Consejos

Se recomienda establecer solver_order en 2 para la muestreo con guía, y solver_order=3 para el muestreo incondicional.

El umbral dinámico de Imagen es compatible. En los modelos de difusión en el espacio de píxeles, puede establecer tanto algorithm_type="dpmsolver++" como thresholding=True para utilizar el umbral dinámico. Este método de umbral no es adecuado para los modelos de difusión en el espacio latente, como Stable Diffusion.

DPMSolverSinglestepScheduler

clase diffusers.DPMSolverSinglestepScheduler

< >

( num_train_timesteps: int = 1000beta_start: float = 0.0001beta_end: float = 0.02beta_schedule: typing.Literal['linear', 'scaled_linear', 'squaredcos_cap_v2'] = 'linear'trained_betas: numpy.ndarray | list[float] | None = Nonesolver_order: int = 2prediction_type: typing.Literal['epsilon', 'sample', 'v_prediction', 'flow_prediction'] = 'epsilon'thresholding: bool = Falsedynamic_thresholding_ratio: float = 0.995sample_max_value: float = 1.0algorithm_type: typing.Literal['dpmsolver', 'dpmsolver++', 'sde-dpmsolver++'] = 'dpmsolver++'solver_type: typing.Literal['midpoint', 'heun'] = 'midpoint'lower_order_final: bool = Falseuse_karras_sigmas: bool = Falseuse_exponential_sigmas: bool = Falseuse_beta_sigmas: bool = Falseuse_flow_sigmas: bool = Falseflow_shift: float = 1.0final_sigmas_type: typing.Literal['zero', 'sigma_min'] = 'zero'lambda_min_clipped: float = -infvariance_type: typing.Optional[typing.Literal['learned', 'learned_range']] = Noneuse_dynamic_shifting: bool = Falsetime_shift_type: typing.Literal['exponential'] = 'exponential' )

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 ("linear", "scaled_linear" o "squaredcos_cap_v2", por defecto "linear") — El plan de betas, un mapeo desde un rango de betas a una secuencia de betas para dar pasos al modelo. Elija entre linear, scaled_linear o squaredcos_cap_v2.
  • trained_betas (np.ndarray o list[float], opcional) — Pase un array de betas directamente al constructor para omitir beta_start y beta_end.
  • solver_order (int, por defecto 2) — El orden de DPMSolver, que puede ser 1 o 2 o 3. Se recomienda usar solver_order=2 para muestreo guiado y solver_order=3 para muestreo incondicional.
  • prediction_type ("epsilon", "sample", "v_prediction", or "flow_prediction", defaults to "epsilon") — Prediction type of the scheduler function; can be epsilon (predicts the noise of the diffusion process), sample (directly predicts the noisy sample), v_prediction(see section 2.4 of [Imagen Video](https://huggingface.co/papers/2210.02303) paper), orflow_prediction`.
  • 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 umbral para el umbral dinámico. Solo es válido cuando thresholding=True y algorithm_type="dpmsolver++".
  • algorithm_type ("dpmsolver", "dpmsolver++" o "sde-dpmsolver++", por defecto "dpmsolver++") — Tipo de algoritmo para el solver; puede ser dpmsolver, dpmsolver++ o sde-dpmsolver++. El tipo dpmsolver implementa los algoritmos del artículo DPMSolver, y el tipo dpmsolver++ implementa los algoritmos del artículo DPMSolver++. Se recomienda usar dpmsolver++ o sde-dpmsolver++ con solver_order=2 para muestreo guiado, como en Stable Diffusion.
  • solver_type ("midpoint" o "heun", por defecto "midpoint") — Tipo de solver para el solver de segundo orden; puede ser midpoint o heun. El tipo de solver afecta ligeramente a la calidad de la muestra, especialmente con un número pequeño de pasos. Se recomienda usar solvers midpoint.
  • lower_order_final (bool, por defecto False) — Si se deben usar solutores de orden inferior en los pasos finales. Solo es válido para < 15 pasos de inferencia. Esto puede estabilizar el muestreo de DPMSolver para pasos < 15, especialmente para pasos <= 10.
  • use_karras_sigmas (bool, opcional, valor predeterminado False) — Si se deben usar sigmas de Karras para los tamaños de paso en el plan de ruido durante el proceso de muestreo. Si es True, los sigmas se determinan según una secuencia de niveles de ruido {σi}.
  • use_exponential_sigmas (bool, opcional, valor predeterminado False) — Si se deben usar sigmas exponenciales para los tamaños de paso en el plan de ruido durante el proceso de muestreo.
  • use_beta_sigmas (bool, opcional, valor predeterminado False) — Si se deben usar beta sigmas para los tamaños de paso en el programa de ruido durante el proceso de muestreo. Consulte Beta Sampling is All You Need para obtener más información.
  • use_flow_sigmas (bool, opcional, valor predeterminado False) — Si se deben usar sigmas de flujo para los tamaños de paso en la programación de ruido durante el proceso de muestreo.
  • flow_shift (float, opcional, valor predeterminado 1.0) — El parámetro de desplazamiento de flujo para modelos basados en flujo.
  • final_sigmas_type ("zero" o "sigma_min", opcional, valor predeterminado "zero") — El valor final de sigma para el programa de ruido durante el proceso de muestreo. Si es "sigma_min", el sigma final es el mismo que el último sigma del programa de entrenamiento. Si es "zero", el sigma final se establece en 0.
  • lambda_min_clipped (float, por defecto -inf) — Umbral de recorte para el valor mínimo de lambda(t) para la estabilidad numérica. Esto es crítico para la programación de ruido coseno (squaredcos_cap_v2).
  • variance_type ("learned" o "learned_range", opcional) — Establecer en "learned" o "learned_range" para modelos de difusión que predicen la varianza. Si se establece, la salida del modelo contiene la varianza gaussiana predicha.
  • use_dynamic_shifting (bool, por defecto False) — Si se debe usar un desplazamiento dinámico para el plan de ruido.
  • time_shift_type ("exponential", por defecto "exponential") — El tipo de desplazamiento temporal a aplicar.

DPMSolverSinglestepScheduler es un solver de alto orden dedicado y rápido para ecuaciones diferenciales ordinarias de difusión.

Este modelo hereda de SchedulerMixin y 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

< >

( original_samples: Tensornoise: Tensortimesteps: IntTensor ) → torch.Tensor

Parámetros

  • original_samples (torch.Tensor) — Las muestras originales sin ruido.
  • noise (torch.Tensor) — El ruido que se añadirá a las muestras.
  • timesteps (torch.IntTensor) — Los pasos de tiempo en los que se debe añadir ruido a las muestras.

Devuelve

torch.Tensor

Las muestras ruidosas.

Añade ruido a las muestras originales según el programa de ruido en los pasos de tiempo especificados.

convert_model_output

< >

( model_output: Tensor*argssample: typing.Optional[torch.Tensor] = None**kwargs ) → torch.Tensor

Parámetros

  • model_output (torch.Tensor) — La salida directa del modelo de difusión aprendido.
  • sample (torch.Tensor) — Una instancia actual de una muestra creada por el proceso de difusión.

Devuelve

torch.Tensor

La salida del modelo convertido.

Convierte la salida del modelo al tipo correspondiente que necesita el algoritmo DPMSolver/DPMSolver++. DPM-Solver está diseñado para discretizar una integral del modelo de predicción de ruido, y DPM-Solver++ está diseñado para discretizar una integral del modelo de predicción de datos.

> El algoritmo y el tipo de modelo están desacoplados. Puede usar DPMSolver o DPMSolver++ tanto para modelos de predicción de ruido como para modelos de predicción de datos.

dpm_solver_first_order_update

< >

( model_output: Tensor*argssample: typing.Optional[torch.Tensor] = Nonenoise: typing.Optional[torch.Tensor] = None**kwargs ) → torch.Tensor

Parámetros

  • model_output (torch.Tensor) — La salida directa del modelo de difusión aprendido.
  • timestep (int) — El paso de tiempo discreto actual en la cadena de difusión.
  • prev_timestep (int) — El paso de tiempo discreto anterior en la cadena de difusión.
  • sample (torch.Tensor) — Una instancia actual de una muestra creada por el proceso de difusión.
  • noise (torch.Tensor, opcional) — Ruido aleatorio utilizado por las variantes de solvador estocástico (sde-*). Es obligatorio cuando algorithm_type se establece en una de ellas y no se utiliza en caso contrario.

Devuelve

torch.Tensor

El tensor de muestra en el paso de tiempo anterior.

Un paso para el DPMSolver de primer orden (equivalente a DDIM).

get_order_list

< >

( num_inference_steps: int ) → list[int]

Parámetros

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

Devuelve

list[int]

La lista de órdenes del solver para cada paso de tiempo.

Calcula el orden del solver en cada paso de tiempo.

index_for_timestep

< >

( timestep: typing.Union[int, torch.Tensor]schedule_timesteps: typing.Optional[torch.Tensor] = None ) → int

Parámetros

  • timestep (int o torch.Tensor) — El timestep para el que se debe encontrar el índice.
  • schedule_timesteps (torch.Tensor, opcional) — El calendario de pasos de tiempo en el que buscar. Si es None, usa self.timesteps.

Devuelve

int

El índice del paso de tiempo en la programación.

Encuentra el índice para un paso de tiempo dado en la programación.

scale_model_input

< >

( sample: Tensor*args**kwargs ) → torch.Tensor

Parámetros

  • sample (torch.Tensor) — La muestra de entrada.

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_begin_index

< >

( begin_index: int = 0 )

Parámetros

  • begin_index (int, por defecto 0) — El índice inicial del programador.

Establece el índice inicial para el programador. Esta función debe ejecutarse desde la tubería antes de la inferencia.

set_timesteps

< >

( num_inference_steps: int = Nonedevice: typing.Union[str, torch.device] = Nonemu: float | None = Nonetimesteps: list[int] | None = None )

Parámetros

  • num_inference_steps (int, opcional) — 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 timesteps. Si es None, los timesteps no se mueven.
  • mu (float, opcional) — Exponente para el desplazamiento dinámico en el tiempo. Requiere use_dynamic_shifting y un time_shift_type de "exponential"; si se pasa, flow_shift se establece en exp(mu).
  • timesteps (list[int], opcional) — Pasos de tiempo personalizados para admitir un espaciado arbitrario entre los pasos de tiempo. Si es None, se utiliza la estrategia de espaciado de pasos de tiempo por defecto, que es un espaciado igual entre los pasos de tiempo. Si se pasa timesteps, num_inference_steps debe ser None.

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

singlestep_dpm_solver_second_order_update

< >

( model_output_list: list*argssample: typing.Optional[torch.Tensor] = Nonenoise: typing.Optional[torch.Tensor] = None**kwargs ) → torch.Tensor

Parámetros

  • model_output_list (list[torch.Tensor]) — Las salidas directas del modelo de difusión aprendido en los pasos de tiempo actuales y posteriores.
  • timestep (int) — El paso de tiempo discreto actual y posterior en la cadena de difusión.
  • prev_timestep (int) — El paso de tiempo discreto anterior en la cadena de difusión.
  • sample (torch.Tensor) — Una instancia actual de una muestra creada por el proceso de difusión.
  • noise (torch.Tensor, opcional) — Ruido aleatorio utilizado por las variantes de solvador estocástico (sde-*). Es obligatorio cuando algorithm_type se establece en una de ellas y no se utiliza en caso contrario.

Devuelve

torch.Tensor

El tensor de muestra en el paso de tiempo anterior.

Un paso para el DPMSolver de un solo paso de segundo orden que calcula la solución en el tiempo prev_timestep a partir del tiempo timestep_list[-2].

singlestep_dpm_solver_third_order_update

< >

( model_output_list: list*argssample: typing.Optional[torch.Tensor] = Nonenoise: typing.Optional[torch.Tensor] = None**kwargs ) → torch.Tensor

Parámetros

  • model_output_list (list[torch.Tensor]) — Las salidas directas del modelo de difusión aprendido en los pasos de tiempo actuales y posteriores.
  • timestep (int) — El paso de tiempo discreto actual y posterior en la cadena de difusión.
  • prev_timestep (int) — El paso de tiempo discreto anterior en la cadena de difusión.
  • sample (torch.Tensor) — Una instancia actual de una muestra creada por el proceso de difusión.
  • noise (torch.Tensor, opcional) — Ruido aleatorio utilizado por las variantes de solvador estocástico (sde-*). Es obligatorio cuando algorithm_type se establece en una de ellas y no se utiliza en caso contrario.

Devuelve

torch.Tensor

El tensor de muestra en el paso de tiempo anterior.

Un paso para el DPMSolver de un solo paso de tercer orden que calcula la solución en el tiempo prev_timestep a partir del tiempo timestep_list[-3].

singlestep_dpm_solver_update

< >

( model_output_list: list*argssample: typing.Optional[torch.Tensor] = Noneorder: int = Nonenoise: typing.Optional[torch.Tensor] = None**kwargs ) → torch.Tensor

Parámetros

  • model_output_list (list[torch.Tensor]) — Las salidas directas del modelo de difusión aprendido en los pasos de tiempo actuales y posteriores.
  • timestep (int) — El paso de tiempo discreto actual y posterior en la cadena de difusión.
  • prev_timestep (int) — El paso de tiempo discreto anterior en la cadena de difusión.
  • sample (torch.Tensor) — Una instancia actual de una muestra creada por el proceso de difusión.
  • order (int) — El orden del solver en este paso.
  • noise (torch.Tensor, opcional) — Ruido aleatorio utilizado por las variantes de solvador estocástico (sde-*). Es obligatorio cuando algorithm_type se establece en una de ellas y no se utiliza en caso contrario.

Devuelve

torch.Tensor

El tensor de muestra en el paso de tiempo anterior.

Un paso para el DPMSolver de un solo paso.

paso

< >

( model_output: Tensortimestep: typing.Union[int, torch.Tensor]sample: Tensorgenerator: typing.Optional[torch.Generator] = Nonereturn_dict: bool = True ) → SchedulerOutput or tuple

Parámetros

  • model_output (torch.Tensor) — La salida directa del modelo de difusión aprendido.
  • timestep (int o torch.Tensor) — El paso de tiempo discreto actual en la cadena de difusión.
  • sample (torch.Tensor) — Una instancia actual de una muestra creada por el proceso de difusión.
  • generator (torch.Generator, opcional) — Un generador de números aleatorios para muestreo estocástico.
  • return_dict (bool, por defecto True) — Si se devuelve un SchedulerOutput o una tuple.

Devuelve

SchedulerOutput o tuple

If return_dict is True, SchedulerOutput is returned, otherwise a tuple is returned where the first element is the sample tensor.

Predice la muestra del paso de tiempo anterior invirtiendo el SDE. Esta función propaga la muestra con el DPMSolver de singlestep.

SchedulerOutput

clase diffusers.schedulers.scheduling_utils.SchedulerOutput

< >

( prev_sample: Tensor )

Parámetros

  • prev_sample (torch.Tensor de forma (batch_size, num_channels, height, width) para imágenes) — Muestra calculada (x_{t-1}) del paso de tiempo anterior. prev_sample debe usarse como entrada del modelo en el bucle de desruido.

Clase base para la salida de la función step de un programador.

Update on GitHub

←DPMSolverSDEScheduler EDMDPMSolverMultistepScheduler→