Diffusers documentation

CogVideoXDPMScheduler

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

CogVideoXDPMScheduler

CogVideoXDPMScheduler은 DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps와 DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models를 기반으로 하며, 특히 CogVideoX 모델에 사용됩니다.

CogVideoXDPMScheduler

클래스 diffusers.CogVideoXDPMScheduler

< >

( num_train_timesteps: int = 1000beta_start: float = 0.00085beta_end: float = 0.012beta_schedule: typing.Literal['linear', 'scaled_linear', 'squaredcos_cap_v2'] = 'scaled_linear'trained_betas: numpy.ndarray | list[float] | None = Noneclip_sample: bool = Trueset_alpha_to_one: bool = Truesteps_offset: int = 0prediction_type: typing.Literal['epsilon', 'sample', 'v_prediction'] = 'epsilon'clip_sample_range: float = 1.0sample_max_value: float = 1.0timestep_spacing: typing.Literal['leading', 'linspace', 'trailing'] = 'leading'rescale_betas_zero_snr: bool = Falsesnr_shift_scale: float = 3.0 )

매개변수

  • num_train_timesteps (int, 기본값 1000) — 모델을 학습할 때 사용할 diffusion 단계 수입니다.
  • beta_start (float, 기본값 0.0001) — 추론의 시작 beta 값입니다.
  • beta_end (float, 기본값 0.02) — 최종 beta 값입니다.
  • beta_schedule (str, 기본값 "linear") — 모델의 스테핑을 위한 베타 범위에서 베타 시퀀스로의 매핑인 베타 스케줄입니다. linear, scaled_linear, 또는 squaredcos_cap_v2 중 하나를 선택합니다.
  • trained_betas (np.ndarray, 선택 사항) — beta_start와 beta_end를 우회하여 베타 배열을 생성자에 직접 전달합니다.
  • clip_sample (bool, 기본값 True) — 수치적 안정성을 위해 예측된 샘플을 클리핑합니다.
  • clip_sample_range (float, 기본값 1.0) — 샘플 클리핑의 최대 크기입니다. clip_sample=True일 때만 유효합니다.
  • set_alpha_to_one (bool, 기본값 True) — 각 diffusion 단계는 해당 단계와 이전 단계의 alphas 곱 값을 사용합니다. 마지막 단계에는 이전 alpha가 없습니다. 이 옵션이 True이면 이전 alpha 곱 값은 1로 고정되고, 그렇지 않으면 0단계의 alpha 값을 사용합니다.
  • steps_offset (int, 기본값 0) — 일부 모델 계열에서 요구하는 추론 단계에 추가되는 오프셋입니다.
  • 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 paper).
  • thresholding (bool, 기본값 False) — “동적 임계값 설정” 방법을 사용할지 여부입니다. Stable Diffusion과 같은 잠재 공간 확산 모델에는 적합하지 않습니다.
  • dynamic_thresholding_ratio (float, 기본값 0.995) — 동적 임계값 설정 방법의 비율입니다. thresholding=True일 때만 유효합니다.
  • sample_max_value (float, 기본값 1.0) — 동적 임계값 설정을 위한 임계값입니다. thresholding=True일 때만 유효합니다.
  • timestep_spacing (str, defaults to "leading") — The way the timesteps should be scaled. Refer to Table 2 of the Common Diffusion Noise Schedules and Sample Steps are Flawed for more information. Choose from leading, linspace or trailing.
  • rescale_betas_zero_snr (bool, 기본값 False) — 베타를 재조정하여 최종 SNR을 0으로 만들지 여부를 지정합니다. 이를 통해 중간 밝기의 샘플로 제한되는 대신 매우 밝고 어두운 샘플을 생성할 수 있습니다. --offset_noise와 느슨하게 관련이 있습니다.
  • snr_shift_scale (float, 기본값 3.0) — SNR의 시프트 스케일입니다.

DDIMScheduler는 DDPM(denoising diffusion probabilistic models)에서 도입된 디노이징(denoising) 절차를 비마르코프(non-Markovian) 가이던스로 확장합니다.

이 모델은 SchedulerMixin과 ConfigMixin을 상속합니다. 로딩 및 저장과 같은 모든 스케줄러에 대해 라이브러리가 구현하는 일반적 메서드에 대해서는 상위 클래스 문서를 확인하세요.

add_noise

< >

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

매개변수

  • original_samples (torch.Tensor) — 노이즈가 추가될 원래 샘플입니다.
  • noise (torch.Tensor) — 샘플에 추가할 노이즈입니다.
  • timesteps (torch.IntTensor) — 각 샘플의 노이즈 수준을 나타내는 timesteps.

반환값

torch.Tensor

노이즈가 포함된 샘플.

각 timestep의 노이즈 크기에 따라 원래 샘플에 노이즈를 추가합니다(이것은 forward diffusion process입니다).

get_mult

< >

( h: Tensorr: Tensoralpha_prod_t: Tensoralpha_prod_t_prev: Tensoralpha_prod_t_back: typing.Optional[torch.Tensor] = None ) → tuple

매개변수

  • h (torch.Tensor) — 로그-SNR 차이.
  • r (torch.Tensor) — 로그-SNR 차이의 비율입니다.
  • alpha_prod_t (torch.Tensor) — 현재 timestep에서의 알파의 누적 곱입니다.
  • alpha_prod_t_prev (torch.Tensor) — 이전 타임스텝에서의 알파 누적 곱입니다.
  • alpha_prod_t_back (torch.Tensor, 선택 사항) — 이전 타임스텝의 바로 이전 타임스텝까지의 알파 누적 곱입니다.

반환값

tuple

곱셈 인수를 포함하는 튜플.

이전 샘플과 예측된 원래 샘플에 대한 배수를 계산합니다.

get_variables

< >

( alpha_prod_t: Tensoralpha_prod_t_prev: Tensoralpha_prod_t_back: typing.Optional[torch.Tensor] = None ) → tuple

매개변수

  • alpha_prod_t (torch.Tensor) — 현재 timestep에서의 알파의 누적 곱입니다.
  • alpha_prod_t_prev (torch.Tensor) — 이전 타임스텝에서의 알파 누적 곱입니다.
  • alpha_prod_t_back (torch.Tensor, 선택 사항) — 이전 타임스텝의 바로 이전 타임스텝까지의 알파 누적 곱입니다.

반환값

tuple

h, r, lamb, lamb_next 변수를 포함하는 튜플입니다.

원래 구현을 참조하여 DPM-Solver++ (2M)에 사용되는 변수를 계산합니다.

get_velocity

< >

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

매개변수

  • sample (torch.Tensor) — 입력 샘플입니다.
  • noise (torch.Tensor) — 노이즈 텐서입니다.
  • timesteps (torch.IntTensor) — 속도 계산에 사용되는 timesteps입니다.

반환값

torch.Tensor

계산된 속도.

속도 공식에 따라 샘플과 노이즈로부터 속도 예측을 계산합니다.

scale_model_input

< >

( sample: Tensortimestep: int | None = None ) → torch.Tensor

매개변수

  • sample (torch.Tensor) — 입력 샘플입니다.
  • timestep (int, 선택 사항) — 확산 체인에서의 현재 timestep입니다.

반환값

torch.Tensor

스케일된 입력 샘플.

현재 timestep에 따라 denoising 모델 입력을 scale해야 하는 scheduler와의 호환성을 보장합니다.

set_timesteps

< >

( num_inference_steps: intdevice: typing.Union[str, torch.device, NoneType] = None )

매개변수

  • num_inference_steps (int) — 학습된 모델로 샘플을 생성할 때 사용되는 diffusion 단계 수입니다.
  • device (str 또는 torch.device, 선택 사항) — timesteps를 이동할 대상 device입니다. None(기본값)인 경우 timesteps는 이동되지 않습니다.

추론 실행 전에 실행할 diffusion chain에 사용할 이산 timesteps를 설정합니다.

단계

< >

( model_output: Tensorold_pred_original_sample: Tensortimestep: inttimestep_back: intsample: Tensoreta: float = 0.0use_clipped_model_output: bool = Falsegenerator: typing.Optional[torch.Generator] = Nonevariance_noise: typing.Optional[torch.Tensor] = Nonereturn_dict: bool = False ) → DDIMSchedulerOutput or tuple

매개변수

  • model_output (torch.Tensor) — 학습된 diffusion 모델의 직접적인 출력입니다.
  • old_pred_original_sample (torch.Tensor) — 이전 타임스텝에서 예측된 원래 샘플입니다.
  • timestep (int) — 확산 체인(diffusion chain)의 현재 이산 시간 단계(discrete timestep)입니다.
  • timestep_back (int) — 되돌아볼 timestep입니다.
  • sample (torch.Tensor) — 확산 과정에 의해 생성된 샘플의 현재 인스턴스입니다.
  • eta (float) — 확산 단계에서 추가되는 노이즈의 가중치입니다.
  • use_clipped_model_output (bool, 기본값 False) — True인 경우, 클리핑된 예측 원본 샘플로부터 “보정된” model_output를 계산합니다. self.config.clip_sample가 True일 때 예측 원본 샘플이 [-1, 1]로 클리핑되므로 필요합니다. 클리핑이 발생하지 않았다면 “보정된” model_output은 입력으로 제공된 것과 동일해지며 use_clipped_model_output는 효과가 없습니다.
  • generator (torch.Generator, 선택 사항) — 난수 생성기입니다.
  • variance_noise (torch.Tensor) — generator를 사용하여 노이즈를 생성하는 대신, variance 자체에 대한 노이즈를 직접 제공하는 대안입니다. CycleDiffusion과 같은 방법에 유용합니다.
  • return_dict (bool, 선택 사항, 기본값 True) — DDIMSchedulerOutput 또는 tuple을 반환할지 여부.

반환값

DDIMSchedulerOutput 또는 tuple

return_dict가 True인 경우 DDIMSchedulerOutput이 반환되고, 그렇지 않으면 첫 번째 요소가 샘플 텐서인 튜플이 반환됩니다.

이전 시간 단계의 샘플을 SDE를 역방향으로 적용하여 예측합니다. 이 함수는 학습된 모델의 출력(대부분 예측된 노이즈)으로부터 확산 과정을 전파합니다.

Update on GitHub