Hugging Face's logo

Diffusers documentation

TCDScheduler

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

TCDScheduler

Trajectory Consistency Distillation oleh Jianbin Zheng, Minghui Hu, Zhongyi Fan, Chaoyue Wang, Changxing Ding, Dacheng Tao, dan Tat-Jen Cham memperkenalkan Strategic Stochastic Sampling (Algorithm 4) yang mampu menghasilkan sampel yang baik dalam jumlah langkah yang sedikit. Sebagai iterasi lanjutan dari penjadwal multistep (Algorithm 1) dalam Consistency Models, Strategic Stochastic Sampling secara khusus disesuaikan untuk fungsi konsistensi trajektori.

Abstrak dari makalah tersebut adalah:

Latent Consistency Model (LCM) memperluas Consistency Model ke ruang laten dan memanfaatkan teknik guided consistency distillation untuk mencapai kinerja yang mengesankan dalam mempercepat sintesis teks-ke-gambar. Namun, kami mengamati bahwa LCM kesulitan menghasilkan gambar yang memiliki kejelasan sekaligus kerincian detail. Untuk mengatasi keterbatasan ini, kami pertama kali menyelidiki dan menguraikan penyebab dasarnya. Investigasi kami mengidentifikasi bahwa masalah utama berasal dari kesalahan di tiga area yang berbeda. Oleh karena itu, kami memperkenalkan Trajectory Consistency Distillation (TCD), yang mencakup fungsi konsistensi lintasan dan pengambilan sampel stokastik strategis. Fungsi konsistensi lintasan mengurangi kesalahan distilasi dengan memperluas cakupan kondisi batas self-consistency dan memberikan TCD kemampuan untuk menelusuri seluruh lintasan Probability Flow ODE secara akurat. Selain itu, pengambilan sampel stokastik strategis dirancang khusus untuk menghindari kesalahan kumulatif yang melekat pada pengambilan sampel konsistensi multi-langkah, yang disesuaikan dengan cermat untuk melengkapi model TCD. Eksperimen menunjukkan bahwa TCD tidak hanya secara signifikan meningkatkan kualitas gambar pada NFE rendah, tetapi juga menghasilkan hasil yang lebih detail dibandingkan model guru pada NFE tinggi.

Kodebase asli dapat ditemukan di jabir-zheng/TCD.

TCDScheduler

kelas diffusers.TCDScheduler

< >

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

Parameter

  • num_train_timesteps (int, defaultnya 1000) — Jumlah langkah difusi untuk melatih model.
  • beta_start (float, defaultnya 0.00085) — Nilai beta awal untuk inferensi.
  • beta_end (float, defaultnya 0.012) — Nilai beta akhir.
  • beta_schedule (str, defaultnya "scaled_linear") — Jadwal beta, pemetaan dari rentang beta ke urutan beta untuk melangkahkan model. Pilih dari linear, scaled_linear, atau squaredcos_cap_v2.
  • trained_betas (np.ndarray atau list[float], opsional) — Lewati beta_start dan beta_end dengan meneruskan array betas langsung ke konstruktor.
  • original_inference_steps (int, defaultnya 50) — Jumlah langkah inferensi default yang digunakan untuk menghasilkan jadwal timestep yang tersebar secara linear, yang kemudian akan diambil num_inference_steps timestep yang tersebar merata untuk membentuk jadwal timestep akhir.
  • clip_sample (bool, defaultnya False) — Memotong sampel yang diprediksi untuk stabilitas numerik.
  • clip_sample_range (float, defaultnya 1.0) — Magnitudo maksimum untuk pemotongan sampel. Hanya valid ketika clip_sample=True.
  • set_alpha_to_one (bool, defaultnya True) — Setiap langkah difusi menggunakan nilai produk alfa pada langkah tersebut dan pada langkah sebelumnya. Untuk langkah terakhir, tidak ada alfa sebelumnya. Ketika opsi ini True, produk alfa sebelumnya ditetapkan ke 1, selain itu menggunakan nilai alfa pada langkah 0.
  • steps_offset (int, defaultnya 0) — Offset yang ditambahkan ke langkah inferensi, sesuai kebutuhan beberapa keluarga model.
  • 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, defaultnya False) — Apakah akan menggunakan metode “dynamic thresholding”. Metode ini tidak cocok untuk model difusi ruang laten seperti Stable Diffusion.
  • dynamic_thresholding_ratio (float, defaultnya 0.995) — Rasio untuk metode thresholding dinamis. Hanya valid ketika thresholding=True.
  • sample_max_value (float, defaultnya 1.0) — Nilai ambang untuk thresholding dinamis. Hanya valid ketika thresholding=True.
  • timestep_spacing (str, defaultnya "leading") — Cara timestep harus diskalakan. Lihat Tabel 2 dari Common Diffusion Noise Schedules and Sample Steps are Flawed untuk informasi lebih lanjut.
  • timestep_scaling (float, defaultnya 10.0) — Faktor yang akan dikalikan dengan timestep saat menghitung kondisi batas model konsistensi c_skip dan c_out. Meningkatkan nilai ini akan mengurangi error aproksimasi (meskipun error aproksimasi pada nilai default 10.0 sudah cukup kecil).
  • rescale_betas_zero_snr (bool, defaultnya False) — Apakah akan menskalakan ulang betas agar memiliki SNR terminal nol. Hal ini memungkinkan model untuk menghasilkan sampel yang sangat terang dan gelap, alih-alih membatasi pada sampel dengan kecerahan sedang. Terkait secara longgar dengan --offset_noise.

TCDScheduler mengintegrasikan Strategic Stochastic Sampling yang diperkenalkan oleh makalah Trajectory Consistency Distillation, memperluas Multistep Consistency Sampling asli untuk memungkinkan penelusuran lintasan tanpa batasan.

Kode ini didasarkan pada repositori resmi TCD(https://github.com/jabir-zheng/TCD).

Model ini mewarisi dari SchedulerMixin dan ConfigMixin. ~ConfigMixin menangani penyimpanan semua atribut konfigurasi yang diteruskan ke fungsi __init__ scheduler, seperti num_train_timesteps. Atribut tersebut dapat diakses melalui scheduler.config.num_train_timesteps. SchedulerMixin menyediakan fungsionalitas pemuatan dan penyimpanan umum melalui fungsi SchedulerMixin.save_pretrained() dan from_pretrained().

add_noise

< >

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

Parameter

  • original_samples (torch.Tensor) — Sampel asli yang akan ditambahkan dengan noise.
  • noise (torch.Tensor) — Noise yang akan ditambahkan ke sampel.
  • timesteps (torch.IntTensor) — Timesteps yang menunjukkan tingkat noise untuk setiap sampel.

Mengembalikan

torch.Tensor

Sampel yang bising.

Tambahkan noise ke sampel asli sesuai dengan magnitudo noise pada setiap timestep (ini adalah proses difusi maju).

get_velocity

< >

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

Parameter

  • sample (torch.Tensor) — Contoh input.
  • noise (torch.Tensor) — Tensor noise.
  • timesteps (torch.IntTensor) — Timesteps untuk komputasi kecepatan.

Mengembalikan

torch.Tensor

Kecepatan yang dihitung.

Hitung prediksi kecepatan dari sampel dan noise sesuai dengan rumus kecepatan.

index_for_timestep

< >

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

Parameter

  • timestep (float atau torch.Tensor) — Nilai timestep yang akan dicari dalam jadwal.
  • schedule_timesteps (torch.Tensor, opsional) — Jadwal timestep yang akan dicari. Jika None, gunakan self.timesteps.

Mengembalikan

int

Indeks timestep dalam jadwal. Untuk langkah pertama, mengembalikan indeks kedua jika ada beberapa kecocokan untuk menghindari pengabaian sigma saat memulai di tengah jadwal (misalnya, untuk image-to-image).

Cari indeks dari timestep tertentu dalam jadwal timestep.

previous_timestep

< >

( timestep: int ) → int or torch.Tensor

Parameter

  • timestep (int) — Timestep saat ini.

Mengembalikan

int atau torch.Tensor

Langkah waktu sebelumnya.

Hitung langkah waktu sebelumnya dalam rantai difusi.

scale_model_input

< >

( sample: Tensortimestep: typing.Union[int, torch.Tensor, NoneType] = None ) → torch.Tensor

Parameter

  • sample (torch.Tensor) — Contoh input.
  • timestep (int atau torch.Tensor, opsional) — Langkah waktu saat ini dalam rantai difusi.

Mengembalikan

torch.Tensor

Contoh input yang diskalakan.

Memastikan interoperabilitas dengan scheduler yang perlu menskalakan input model denoising berdasarkan timestep saat ini.

set_begin_index

< >

( begin_index: int = 0 )

Parameter

  • begin_index (int, defaultnya 0) — Indeks awal untuk scheduler.

Menetapkan indeks awal untuk penjadwal. Fungsi ini harus dijalankan dari pipeline sebelum inferensi.

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 )

Parameter

  • num_inference_steps (int, opsional) — Jumlah langkah difusi yang digunakan saat menghasilkan sampel dengan model terlatih. Jika digunakan, timesteps harus None.
  • device (str atau torch.device, opsional) — Perangkat tempat timesteps harus dipindahkan. Jika None, timesteps tidak dipindahkan.
  • original_inference_steps (int, opsional) — Jumlah langkah inferensi asli, yang akan digunakan untuk menghasilkan jadwal timestep yang tersebar secara linear (yang berbeda dari implementasi diffusers standar). Kami kemudian akan mengambil num_inference_steps timestep dari jadwal ini, yang tersebar merata dalam hal indeks, dan menggunakannya sebagai jadwal timestep akhir kami. Jika tidak diatur, ini akan secara default menggunakan atribut original_inference_steps.
  • timesteps (list[int], opsional) — Timesteps kustom yang digunakan untuk mendukung spasi arbitrer antar timesteps. Jika None, maka strategi spasi timestep default berupa spasi yang sama antar timesteps pada jadwal timestep pelatihan/distilasi akan digunakan. Jika timesteps diberikan, num_inference_steps harus None.
  • strength (float, defaultnya 1.0) — Digunakan untuk menentukan jumlah timestep yang dipakai untuk inferensi saat menggunakan img2img, inpaint, dan sebagainya.

Menetapkan langkah waktu diskrit yang digunakan untuk rantai difusi (untuk dijalankan sebelum inferensi).

langkah

< >

( model_output: Tensortimestep: typing.Union[int, torch.Tensor]sample: Tensoreta: float = 0.3generator: typing.Optional[torch.Generator] = Nonereturn_dict: bool = True ) → TCDSchedulerOutput or tuple[torch.Tensor, torch.Tensor]

Parameter

  • model_output (torch.Tensor) — Output langsung dari model difusi yang dipelajari.
  • timestep (int atau torch.Tensor) — Langkah waktu diskret saat ini dalam rantai difusi.
  • sample (torch.Tensor) — Instans saat ini dari sampel yang dibuat oleh proses difusi.
  • eta (float, defaultnya 0.3) — Parameter stokastik (disebut gamma dalam makalah) yang digunakan untuk mengendalikan tingkat keacakan pada setiap langkah. Ketika eta = 0, ini mewakili pengambilan sampel deterministik, sedangkan eta = 1 menunjukkan pengambilan sampel sepenuhnya stokastik.
  • generator (torch.Generator, opsional) — Generator angka acak.
  • return_dict (bool, defaultnya True) — Apakah akan mengembalikan TCDSchedulerOutput atau tuple.

Mengembalikan

TCDSchedulerOutput atau tuple[torch.Tensor, torch.Tensor]

If return_dict is True, TCDSchedulerOutput is returned, otherwise a tuple is returned containing the previous sample and the predicted noised sample.

Prediksi sampel dari langkah waktu sebelumnya dengan membalik SDE. Fungsi ini menyebarkan proses difusi dari keluaran model yang dipelajari (paling sering berupa noise yang diprediksi).

TCDSchedulerOutput

kelas diffusers.schedulers.scheduling_tcd.TCDSchedulerOutput

< >

( prev_sample: Tensorpred_noised_sample: typing.Optional[torch.Tensor] = None )

Parameter

  • prev_sample (torch.Tensor dengan bentuk (batch_size, num_channels, height, width) untuk gambar) — Contoh yang dihitung (x_{t-1}) dari langkah waktu sebelumnya. prev_sample harus digunakan sebagai input model berikutnya dalam loop denoising.
  • pred_noised_sample (torch.Tensor dengan bentuk (batch_size, num_channels, height, width) untuk gambar, opsional) — Contoh berisik yang diprediksi (x_{s}) berdasarkan keluaran model dari langkah waktu saat ini.

Kelas output untuk output fungsi step penjadwal.

Update on GitHub

←ScoreSdeVeScheduler UniPCMultistepScheduler→