Diffusers documentation

Latent Consistency Model Multistep Scheduler

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

Latent Consistency Model Multistep Scheduler

개요

Simian Luo, Yiqin Tan, Longbo Huang, Jian Li, Hang Zhao의 논문 Latent Consistency Models: Synthesizing High-Resolution Images with Few-Step Inference에서 latent consistency models와 함께 소개된 Multistep and onestep scheduler(Algorithm 3)입니다. 이 scheduler는 LatentConsistencyModelPipeline에서 1~8단계로 좋은 샘플을 생성할 수 있어야 합니다.

LCMScheduler

클래스 diffusers.LCMScheduler

< >

( num_train_timesteps: int = 1000beta_start: float = 0.00085beta_end: float = 0.012beta_schedule: str = 'scaled_linear'trained_betas: numpy.ndarray | list[float] | None = Noneoriginal_inference_steps: int = 50clip_sample: bool = Falseclip_sample_range: float = 1.0set_alpha_to_one: bool = Truesteps_offset: int = 0prediction_type: str = 'epsilon'thresholding: bool = Falsedynamic_thresholding_ratio: float = 0.995sample_max_value: float = 1.0timestep_spacing: str = 'leading'timestep_scaling: float = 10.0rescale_betas_zero_snr: bool = False )

매개변수

  • num_train_timesteps (int, 기본값 1000) — 모델을 학습할 때 사용할 diffusion 단계 수입니다.
  • beta_start (float, 기본값 0.00085) — 추론의 시작 beta 값입니다.
  • beta_end (float, 기본값 0.012) — 최종 beta 값입니다.
  • beta_schedule (str, 기본값 "scaled_linear") — 모델의 스테핑을 위한 베타 범위에서 베타 시퀀스로의 매핑인 베타 스케줄입니다. linear, scaled_linear, squaredcos_cap_v2 중 하나를 선택합니다.
  • trained_betas (np.ndarray 또는 list[float], 선택 사항) — beta_start와 beta_end를 우회하여 베타 배열을 생성자에 직접 전달합니다.
  • original_inference_steps (int, 기본값 50) — 선형 간격의 timestep 스케줄을 생성하는 데 사용되는 기본 추론 단계 수입니다. 이 스케줄에서 최종적으로 num_inference_steps개의 균등 간격 timestep을 추출하여 최종 timestep 스케줄을 구성합니다.
  • clip_sample (bool, 기본값 False) — 수치적 안정성을 위해 예측된 샘플을 클리핑합니다.
  • 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") — 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, 기본값 "leading") — timestep을 스케일링하는 방법입니다. 자세한 내용은 공통 확산 노이즈 스케줄 및 샘플 단계는 결함이 있다의 표 2를 참조하세요.
  • timestep_scaling (float, 기본값 10.0) — consistency model의 경계 조건인 c_skip과 c_out을 계산할 때 timestep에 곱해지는 계수입니다. 이 값을 증가시키면 근사 오차가 감소합니다(기본값 10.0에서의 근사 오차는 이미 매우 작습니다).
  • rescale_betas_zero_snr (bool, 기본값 False) — 베타를 재조정하여 최종 SNR을 0으로 만들지 여부를 지정합니다. 이를 통해 중간 밝기의 샘플로 제한되는 대신 매우 밝고 어두운 샘플을 생성할 수 있습니다. --offset_noise와 느슨하게 관련이 있습니다.

LCMScheduler는 비 마코프안(guidance)을 사용하여 DDPM(denoising diffusion probabilistic models)에서 도입된 디노이징(denoising) 절차를 확장합니다.

이 모델은 SchedulerMixin과 ConfigMixin을 상속합니다. ~ConfigMixin는 num_train_timesteps와 같은 스케줄러의 __init__ 함수에 전달되는 모든 config 속성을 저장하는 역할을 합니다. 이러한 속성은 scheduler.config.num_train_timesteps을 통해 접근할 수 있습니다. SchedulerMixin은 SchedulerMixin.save_pretrained() 및 from_pretrained() 함수를 통해 일반적인 로딩 및 저장 기능을 제공합니다.

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_scalings_for_boundary_condition_discrete

< >

( timestep: int ) → tuple[float, float]

매개변수

  • timestep (int) — 스케일링을 계산할 이산 시간 단계입니다.

반환값

tuple[float, float]

c_skip(입력 샘플의 스케일링)와 c_out(예측된 노이즈 제거 샘플의 스케일링)을 포함하는 튜플.

Latent Consistency Model에서 사용되는 주어진 이산 시간 단계에 대해 경계 조건 스케일링(c_skip 및 c_out)을 계산합니다.

get_velocity

< >

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

매개변수

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

반환값

torch.Tensor

계산된 속도.

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

index_for_timestep

< >

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

매개변수

  • timestep (float 또는 torch.Tensor) — 스케줄에서 찾을 timestep 값입니다.
  • schedule_timesteps (torch.Tensor, 선택 사항) — 검색할 timestep schedule입니다. None인 경우 self.timesteps를 사용합니다.

반환값

int

The index of the timestep in the schedule. For the very first step, returns the second index if multiple matches exist to avoid skipping a sigma when starting mid-schedule (e.g., for image-to-image).

…

이전 시간 단계

< >

( timestep ) → int or torch.Tensor

매개변수

  • timestep (int) — 현재 timestep입니다.

반환값

int 또는 torch.Tensor

이전 시간 단계(timestep).

확산 체인의 이전 시간 단계를 계산합니다.

scale_model_input

< >

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

매개변수

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

반환값

torch.Tensor

스케일된 입력 샘플.

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

set_begin_index

< >

( begin_index: int = 0 )

매개변수

  • begin_index (int, 기본값 0) — 스케줄러의 시작 인덱스입니다.

… 스케줄러의 시작 인덱스를 설정합니다. 이 함수는 추론 전에 파이프라인에서 실행해야 합니다.

set_timesteps

< >

( num_inference_steps: int | None = Nonedevice: typing.Union[str, torch.device, NoneType] = Noneoriginal_inference_steps: int | None = Nonetimesteps: list[int] | None = Nonestrength: float = 1.0 ) → None

매개변수

  • num_inference_steps (int, 선택 사항) — 학습된 모델로 샘플을 생성할 때 사용되는 diffusion 단계 수입니다. 이 값을 사용하는 경우 timesteps은 None이어야 합니다.
  • device (str 또는 torch.device, 선택 사항) — timesteps를 이동할 대상 device입니다. None인 경우 timesteps는 이동되지 않습니다.
  • original_inference_steps (int, 선택 사항) — 선형 간격의 타임스텝 스케줄을 생성하는 데 사용되는 원래 추론 단계 수입니다(표준 diffusers 구현과 다름). 이후 이 스케줄에서 인덱스 기준으로 균등하게 간격을 두고 num_inference_steps개의 타임스텝을 선택하여 최종 타임스텝 스케줄로 사용합니다. 설정되지 않으면 original_inference_steps 속성 값이 기본값으로 사용됩니다.
  • timesteps (list[int], 선택 사항) — timesteps 사이의 임의의 간격을 지원하기 위해 사용되는 사용자 지정 timesteps입니다. None인 경우, 학습/증류 timestep 스케줄에서 timesteps 사이에 동일한 간격을 두는 기본 timestep 간격 전략이 사용됩니다. timesteps가 전달되면 num_inference_steps는 None이어야 합니다.
  • strength (float, 기본값 1.0) — 부분 타임스텝 스케줄(예: 이미지-투-이미지)을 생성하는 데 사용되는 강도 계수입니다. 값이 1.0이면 전체 스케줄을 사용합니다.

반환값

None

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

단계

< >

( model_output: Tensortimestep: intsample: Tensorgenerator: typing.Optional[torch.Generator] = Nonereturn_dict: bool = True ) → LCMSchedulerOutput or tuple

매개변수

  • model_output (torch.Tensor) — 학습된 diffusion 모델의 직접적인 출력입니다.
  • timestep (int) — 확산 체인(diffusion chain)의 현재 이산 시간 단계(discrete timestep)입니다.
  • sample (torch.Tensor) — 확산 과정에 의해 생성된 샘플의 현재 인스턴스입니다.
  • generator (torch.Generator, 선택 사항) — 재현 가능한 샘플링을 위한 난수 생성기.
  • return_dict (bool, 기본값 True) — LCMSchedulerOutput 또는 tuple를 반환할지 여부.

반환값

LCMSchedulerOutput 또는 tuple

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

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

Update on GitHub