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 هو مجدول خطوة واحدة من 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 من تأليف تشينغ لو، ويهاو تشو، فان باو، جيانفي تشن، تشونغشوان لي، وجون تشو.

DPMSolver (والنسخة المحسّنة DPMSolver++) هو محلل سريع مخصص من الرتبة العالية لمعادلات التفاضلية العادية للانتشار، مع ضمان لرتبة التقارب. عملياً، يمكن لعينة DPMSolver باستخدام 20 خطوة فقط أن تولّد عينات عالية الجودة، كما يمكنها توليد عينات جيدة جداً حتى في 10 خطوات.

يمكن العثور على التنفيذ الأصلي في LuChengTHU/dpm-solver.

نصائح

يُوصى بإعداد solver_order إلى 2 لعينة الدليل، وsolver_order=3 للعينة غير الشرطية.

يُؤيَّد العتبة الديناميكية من Imagen، ولنماذج الانتشار في فضاء البكسلات، يمكنك ضبط كل من algorithm_type="dpmsolver++" وthresholding=True لاستخدام العتبة الديناميكية. ومن غير المناسب استخدام طريقة العتبات هذه لنماذج الانتشار في فضاء الكمون مثل Stable Diffusion.

DPMSolverSinglestepScheduler

فئة 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' )

المعاملات

  • num_train_timesteps (int، القيمة الافتراضية 1000) — عدد خطوات الانتشار لتدريب النموذج.
  • beta_start (float، القيمة الافتراضية 0.0001) — قيمة beta الابتدائية للاستدلال.
  • beta_end (float، القيمة الافتراضية 0.02) — القيمة النهائية لـbeta.
  • beta_schedule ("linear"، "scaled_linear"، أو "squaredcos_cap_v2"، الافتراضي هو "linear") — جدول بيتا، وهو إسقاط من نطاق بيتا إلى تسلسل من قيم بيتا لخطوات النموذج. اختر من بين linear، scaled_linear، أو squaredcos_cap_v2.
  • trained_betas (np.ndarray أو list[float]، اختياري) — مرر مصفوفة من قيم بيتا مباشرةً إلى منشئ الكائن لتجاوز beta_start وbeta_end.
  • solver_order (int، القيمة الافتراضية 2) — ترتيب DPMSolver الذي يمكن أن يكون 1 أو 2 أو 3. يُوصى باستخدام solver_order=2 للعينة الموجَّهة، وsolver_order=3 للعينة غير المشروطة.
  • 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، الافتراضي False) — ما إذا كان سيتم استخدام طريقة “العتبة الديناميكية”. هذه الطريقة غير مناسبة لنماذج الانتشار في الفضاء الكامن مثل Stable Diffusion.
  • dynamic_thresholding_ratio (float، القيمة الافتراضية 0.995) — النسبة المستخدمة في طريقة العتبة الديناميكية. تكون صالحة فقط عندما يكون thresholding=True.
  • sample_max_value (float، القيمة الافتراضية 1.0) — قيمة العتبة الخاصة بالتعتيم الديناميكي. صالحة فقط عندما يكون thresholding=True و algorithm_type="dpmsolver++".
  • algorithm_type ("dpmsolver"، أو "dpmsolver++"، أو "sde-dpmsolver++"، القيمة الافتراضية هي "dpmsolver++") — نوع الخوارزمية للمُحلِّل؛ يمكن أن يكون dpmsolver أو dpmsolver++ أو sde-dpmsolver++. يُطبِّق النوع dpmsolver الخوارزميات الواردة في ورقة DPMSolver، بينما يُطبِّق النوع dpmsolver++ الخوارزميات الواردة في ورقة DPMSolver++. يُوصى باستخدام dpmsolver++ أو sde-dpmsolver++ مع solver_order=2 لأخذ العينات الموجَّهة كما في Stable Diffusion.
  • solver_type ("midpoint" أو "heun"، الافتراضي هو "midpoint") — نوع المُحلِّل للمُحلِّل من الرتبة الثانية؛ يمكن أن يكون midpoint أو heun. يؤثر نوع المُحلِّل بشكل طفيف على جودة العينة، خاصةً عند استخدام عدد صغير من الخطوات. يُوصى باستخدام مُحلِّلات midpoint.
  • lower_order_final (bool، القيمة الافتراضية False) — ما إذا كان سيتم استخدام محللات من رتبة أدنى في الخطوات النهائية. صالح فقط لعدد خطوات الاستدلال < 15. يمكن أن يثبّت أخذ العينات في DPMSolver للخطوات < 15، خاصةً للخطوات <= 10.
  • use_karras_sigmas (bool، اختياري، القيمة الافتراضية False) — ما إذا كان سيتم استخدام Karras sigmas لحجم الخطوات في جدول الضوضاء أثناء عملية أخذ العينات. إذا كانت True، فإن قيم sigmas تُحدَّد وفقاً لسلسلة من مستويات الضوضاء {σi}.
  • use_exponential_sigmas (bool، اختياري، القيمة الافتراضية False) — ما إذا كان سيتم استخدام قيم sigmas أسّية لحجم الخطوات في جدول الضوضاء أثناء عملية أخذ العينات.
  • use_beta_sigmas (bool, optional, defaults to False) — Whether to use beta sigmas for step sizes in the noise schedule during the sampling process. Refer to Beta Sampling is All You Need for more information.
  • use_flow_sigmas (bool، اختياري، القيمة الافتراضية False) — ما إذا كان سيتم استخدام قيم flow sigmas لحساب أحجام الخطوات في جدول الضوضاء أثناء عملية أخذ العينات.
  • flow_shift (float، اختياري، القيمة الافتراضية 1.0) — معامل الإزاحة التدفقي (flow shift) للنماذج القائمة على التدفق.
  • final_sigmas_type ("zero" أو "sigma_min"، اختياري، القيمة الافتراضية "zero") — قيمة sigma النهائية لجدول الضوضاء أثناء عملية أخذ العينات. إذا كانت "sigma_min"، فإن قيمة sigma النهائية هي نفسها آخر قيمة sigma في جدول التدريب. أما إذا كانت "zero"، فتُضبط قيمة sigma النهائية على 0.
  • lambda_min_clipped (float، القيمة الافتراضية -inf) — حدّ القصّ للقيمة الدنيا لـlambda(t) من أجل الاستقرار العددي. وهذا أمر بالغ الأهمية لجدول الضوضاء الجيبية (squaredcos_cap_v2).
  • variance_type ("learned" أو "learned_range"، اختياري) — يُضبط على "learned" أو "learned_range" لنماذج الانتشار التي تتنبأ بالتباين. إذا تم ضبطه، فإن مخرجات النموذج تتضمن التباين الغاوسي المتوقع.
  • use_dynamic_shifting (bool، القيمة الافتراضية False) — ما إذا كان سيتم استخدام الإزاحة الديناميكية لجدول الضوضاء.
  • time_shift_type ("exponential"، الافتراضي "exponential") — نوع إزاحة الوقت المراد تطبيقه.

DPMSolverSinglestepScheduler هو محلل سريع مخصص من الرتبة العالية لمعادلات التفاضلية العادية للانتشار.

يرث هذا النموذج من SchedulerMixin و ConfigMixin. راجع توثيق الفئة الأصلية لمعرفة الطرق العامة التي تنفذها المكتبة لجميع مجدوليات الوقت مثل التحميل والحفظ.

add_noise

< >

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

المعاملات

  • original_samples (torch.Tensor) — العينات الأصلية دون ضوضاء.
  • noise (torch.Tensor) — الضوضاء التي يجب إضافتها إلى العينات.
  • timesteps (torch.IntTensor) — خطوات الزمن التي يُضاف عندها الضوضاء إلى العينات.

يعيد

torch.Tensor

العينات الضجيجية.

أضف الضوضاء إلى العينات الأصلية وفقًا لجدول الضوضاء عند خطوات الزمن المحددة.

convert_model_output

< >

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

المعاملات

  • model_output (torch.Tensor) — المخرجات المباشرة من نموذج الانتشار المُتعلَّم.
  • sample (torch.Tensor) — نسخة حالية من العينة التي أنشأها عملية الانتشار.

يعيد

torch.Tensor

مخرجات النموذج المحوّل.

تحويل مخرجات النموذج إلى النوع المقابل الذي يحتاجه خوارزمية DPMSolver/DPMSolver++. صُمِّم DPM-Solver لتقطيع تكامل نموذج التنبؤ بالضوضاء، بينما صُمِّم DPM-Solver++ لتقطيع تكامل نموذج التنبؤ بالبيانات.

> خوارزمية ونوع النموذج منفصلان. يمكنك استخدام DPMSolver أو DPMSolver++ لكلٍّ من نماذج التنبؤ بالضوضاء ونماذج التنبؤ بالبيانات.

dpm_solver_first_order_update

< >

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

المعاملات

  • model_output (torch.Tensor) — المخرجات المباشرة من نموذج الانتشار المُتعلَّم.
  • timestep (int) — خطوة الزمن المنفصلة الحالية في سلسلة الانتشار.
  • prev_timestep (int) — خطوة الزمن المنفصلة السابقة في سلسلة الانتشار.
  • sample (torch.Tensor) — نسخة حالية من العينة التي أنشأها عملية الانتشار.
  • noise (torch.Tensor، اختياري) — ضوضاء عشوائية تُستخدم في متغيرات المُحلِّل العشوائي (sde-*). يُشترط توفيره عند ضبط algorithm_type على أحد هذه المتغيرات، ولا يُستخدم في الحالات الأخرى.

يعيد

torch.Tensor

المصفوفة العينة عند خطوة الزمن السابقة.

خطوة واحدة لحلّ DPMSolver من الدرجة الأولى (المكافئ لـ DDIM).

get_order_list

< >

( num_inference_steps: int ) → list[int]

المعاملات

  • num_inference_steps (int) — عدد خطوات الانتشار المستخدمة عند توليد العينات باستخدام نموذج مُدرَّب مسبقًا.

يعيد

list[int]

قائمة رتب الحلّال لكل خطوة زمنية.

يُحسب ترتيب المُحلِّل في كل خطوة زمنية.

index_for_timestep

< >

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

المعاملات

  • timestep (int أو torch.Tensor) — خطوة الزمن التي سيتم إيجاد فهرسها.
  • schedule_timesteps (torch.Tensor، اختياري) — جدول الخطوات الزمنية للبحث فيه. إذا كان None، يتم استخدام self.timesteps.

يعيد

int

مؤشر خطوة الزمن في الجدول الزمني.

حدد فهرس خطوة زمنية معينة في الجدول الزمني.

scale_model_input

< >

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

المعاملات

  • sample (torch.Tensor) — العينة المدخلة.

يعيد

torch.Tensor

عينة إدخال مُقيّمة.

يضمن قابلية الاستبدال مع المجدولات التي تحتاج إلى تحجيم مدخلات نموذج إزالة الضوضاء اعتمادًا على خطوة الزمن الحالية.

set_begin_index

< >

( begin_index: int = 0 )

المعاملات

  • begin_index (int، القيمة الافتراضية 0) — الفهرس الابتدائي للمجدول.

يحدد الفهرس الابتدائي للمجدول. يجب تشغيل هذه الدالة من خط الأنابيب قبل الاستدلال.

set_timesteps

< >

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

المعاملات

  • num_inference_steps (int, اختياري) — عدد خطوات الانتشار المستخدمة عند توليد العينات باستخدام نموذج مُدرَّب مسبقًا.
  • device (str أو torch.device، اختياري) — الجهاز الذي يجب نقل خطوات الزمن (timesteps) إليه. إذا كان None، فلن يتم نقل خطوات الزمن.
  • mu (float، اختياري) — أسّ للإزاحة الديناميكية للزمن. يتطلب use_dynamic_shifting وقيمة time_shift_type تساوي "exponential"؛ عند تمريره، يُضبط flow_shift على exp(mu).
  • timesteps (list[int]، اختياري) — خطوات زمنية مخصصة تُستخدم لدعم تباعد تعسفي بين الخطوات الزمنية. إذا كانت None، فسيتم استخدام استراتيجية التباعد الافتراضية للجدول الزمني للخطوات الزمنية، وهي التباعد المتساوي بين الخطوات الزمنية. إذا تم تمرير timesteps، فيجب أن تكون num_inference_steps هي None.

يحدد الخطوات الزمنية المنفصلة المستخدمة لسلسلة الانتشار (لتُنفَّذ قبل الاستدلال).

singlestep_dpm_solver_second_order_update

< >

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

المعاملات

  • model_output_list (list[torch.Tensor]) — المخرجات المباشرة من نموذج الانتشار المُتعلَّم عند خطوات الزمن الحالية واللاحقة.
  • timestep (int) — خطوة الزمن المنفصلة الحالية والأخيرة في سلسلة الانتشار.
  • prev_timestep (int) — خطوة الزمن المنفصلة السابقة في سلسلة الانتشار.
  • sample (torch.Tensor) — نسخة حالية من العينة التي أنشأها عملية الانتشار.
  • noise (torch.Tensor، اختياري) — ضوضاء عشوائية تُستخدم في متغيرات المُحلِّل العشوائي (sde-*). يُشترط توفيره عند ضبط algorithm_type على أحد هذه المتغيرات، ولا يُستخدم في الحالات الأخرى.

يعيد

torch.Tensor

المصفوفة العينة عند خطوة الزمن السابقة.

خطوة واحدة لحلّ DPMSolver أحادي الخطوة من الدرجة الثانية الذي يحسب الحل عند الزمن prev_timestep انطلاقاً من الزمن 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

المعاملات

  • model_output_list (list[torch.Tensor]) — المخرجات المباشرة من نموذج الانتشار المُتعلَّم عند خطوات الزمن الحالية واللاحقة.
  • timestep (int) — خطوة الزمن المنفصلة الحالية والأخيرة في سلسلة الانتشار.
  • prev_timestep (int) — خطوة الزمن المنفصلة السابقة في سلسلة الانتشار.
  • sample (torch.Tensor) — نسخة حالية من عينة تم إنشاؤها بواسطة عملية الانتشار.
  • noise (torch.Tensor، اختياري) — ضوضاء عشوائية تُستخدم في متغيرات المُحلِّل العشوائي (sde-*). يُشترط توفيره عند ضبط algorithm_type على أحد هذه المتغيرات، ولا يُستخدم في الحالات الأخرى.

يعيد

torch.Tensor

المصفوفة العينة عند خطوة الزمن السابقة.

خطوة واحدة لحلّ DPMSolver أحادي الخطوة من الرتبة الثالثة الذي يحسب الحل عند الزمن prev_timestep انطلاقاً من الزمن 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

المعاملات

  • model_output_list (list[torch.Tensor]) — المخرجات المباشرة من نموذج الانتشار المُتعلَّم عند خطوات الزمن الحالية واللاحقة.
  • timestep (int) — خطوة الزمن المنفصلة الحالية والأخيرة في سلسلة الانتشار.
  • prev_timestep (int) — خطوة الزمن المنفصلة السابقة في سلسلة الانتشار.
  • sample (torch.Tensor) — نسخة حالية من عينة تم إنشاؤها بواسطة عملية الانتشار.
  • order (int) — ترتيب المُحلِّل في هذه الخطوة.
  • noise (torch.Tensor، اختياري) — ضوضاء عشوائية تُستخدم في متغيرات المُحلِّل العشوائي (sde-*). يُشترط توفيره عند ضبط algorithm_type على أحد هذه المتغيرات، ولا يُستخدم في الحالات الأخرى.

يعيد

torch.Tensor

المصفوفة العينة عند خطوة الزمن السابقة.

خطوة واحدة لحلّ DPMSolver أحادي الخطوة.

خطوة

< >

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

المعاملات

  • model_output (torch.Tensor) — المخرجات المباشرة من نموذج الانتشار المُتعلَّم.
  • timestep (int أو torch.Tensor) — خطوة الزمن المنفصلة الحالية في سلسلة الانتشار.
  • sample (torch.Tensor) — نسخة حالية من العينة التي أنشأها عملية الانتشار.
  • generator (torch.Generator، اختياري) — مولّد أرقام عشوائية للعينة العشوائية.
  • return_dict (bool، القيمة الافتراضية True) — ما إذا كان يجب إرجاع SchedulerOutput أو tuple.

يعيد

SchedulerOutput أو tuple

إذا كانت True هي قيمة return_dict، يُعاد SchedulerOutput، وإلا يُعاد tuple حيث يكون العنصر الأول هو tensor العينة.

تنبّأ بالعيّنة من خطوة الزمن السابقة عن طريق عكس معادلة ستوكستك التفاضلية (SDE). تنقل هذه الدالة العيّنة باستخدام singlestep DPMSolver.

SchedulerOutput

فئة diffusers.schedulers.scheduling_utils.SchedulerOutput

< >

( prev_sample: Tensor )

المعاملات

  • prev_sample (torch.Tensor من الشكل (batch_size, num_channels, height, width) للصور) — العينة المحسوبة (x_{t-1}) لخطوة الزمن السابقة. يجب استخدام prev_sample كمدخل للنموذج التالي في حلقة إزالة الضوضاء.

الفئة الأساسية لمخرجات دالة step في المجدول.

Update on GitHub