Hugging Face's logo

Diffusers documentation

الإعداد

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

الإعداد

تورث المجدولات من SchedulerMixin والنماذج من ModelMixin من ConfigMixin الذي يخزّن جميع المعاملات المُمرّرة إلى طرق __init__ الخاصة بها في ملف تكوين بصيغة JSON.

لاستخدام النماذج الخاصة أو المقيّدة، سجّل الدخول باستخدام hf auth login.

ConfigMixin

فئة diffusers.ConfigMixin

< >

( )

الفئة الأساسية لجميع فئات الإعداد. تُخزَّن جميع معاملات الإعداد تحت self.config. كما توفر طريقتي from_config() وsave_config() لتحميل وتنزيل وحفظ الفئات التي ترث من ConfigMixin.

خصائص الفئة:

  • config_name (str) — اسم الملف الذي يجب حفظ الإعدادات تحته عند استدعاء save_config() (يجب أن يتم تجاوز هذا من قبل الفئة الأم).
  • ignore_for_config (list[str]) — قائمة بالخصائص التي يجب عدم حفظها في الإعدادات (يجب أن يتم تجاوزها بواسطة الفئة الفرعية).
  • has_compatibles (bool) — ما إذا كانت الفئة تحتوي على فئات متوافقة (يجب أن يتم تجاوزها بواسطة الفئة الفرعية).
  • _deprecated_kwargs (list[str]) — حُجج الكلمات المفتاحية التي تم إيقاف استخدامها. لاحظ أن دالة init يجب أن تحتوي على حجة kwargs فقط إذا كانت هناك حجة واحدة على الأقل تم إيقاف استخدامها (يجب أن يتم تجاوزها بواسطة الفئة الفرعية).

load_config

< >

( pretrained_model_name_or_path: str | os.PathLikereturn_unused_kwargs = Falsereturn_commit_hash = False**kwargs ) → dict

المعاملات

  • pretrained_model_name_or_path (str أو os.PathLike, اختياري) — يمكن أن يكون:
    • سلسلة نصية، وهي معرف النموذج (على سبيل المثال google/ddpm-celebahq-256) لنموذج مُدرَّب مسبقًا مستضاف على الـ Hub.
    • مسار إلى مجلد (على سبيل المثال ./my_model_directory) يحتوي على أوزان النموذج المحفوظة باستخدام save_config().
  • cache_dir (str | os.PathLike، اختياري) — المسار إلى مجلد حيث يتم تخزين إعدادات النموذج المُدرَّب مسبقًا المُحمَّل مؤقتًا إذا لم يُستخدم المجلد المؤقت القياسي.
  • force_download (bool، اختياري، القيمة الافتراضية False) — ما إذا كان يجب إجبار إعادة تنزيل أوزان النموذج وملفات الإعداد، مع تجاوز النسخ المخزنة مؤقتًا إذا كانت موجودة.
  • proxies (dict[str, str]، اختياري) — قاموس لخوادم الوكيل (proxy) للاستخدام حسب البروتوكول أو نقطة النهاية، على سبيل المثال {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. تُستخدم هذه الوكلاء في كل طلب.
  • output_loading_info(bool, اختياري، القيمة الافتراضية False) — ما إذا كان يجب إرجاع قاموس يحتوي على المفاتيح الناقصة والمفاتيح غير المتوقعة ورسائل الأخطاء أم لا.
  • local_files_only (bool، اختياري، القيمة الافتراضية False) — ما إذا كان سيتم تحميل أوزان النموذج وملفات الإعداد المحلية فقط أم لا. إذا تم ضبطه على True، فلن يتم تنزيل النموذج من Hub.
  • token (str أو bool، اختياري) — الرمز الذي يُستخدم كتفويض حامل HTTP للملفات البعيدة. إذا كان True، يُستخدم الرمز المولّد من diffusers-cli login (المخزّن في ~/.huggingface).
  • revision (str، اختياري، القيمة الافتراضية "main") — الإصدار المحدد من النموذج الذي سيتم استخدامه. يمكن أن يكون اسم فرع، أو اسم وسم، أو معرف commit، أو أي معرّف مسموح به بواسطة Git.
  • subfolder (str، اختياري، الافتراضي "") — موقع المجلد الفرعي لملف النموذج داخل مستودع نموذج أكبر على Hub أو محليًا.
  • return_unused_kwargs (bool، اختياري، القيمة الافتراضية `False) — ما إذا كانت تُعاد حُجج الكلمات المفتاحية غير المستخدمة في الإعداد.
  • return_commit_hash (bool, optional, defaults to False) -- Whether the commit_hash` of the loaded configuration are returned.

يعيد

dict

قاموس بجميع المعلمات المخزنة في ملف تكوين بصيغة JSON.

تحميل تكوين نموذج أو مجدول.

from_config

< >

( config: diffusers.configuration_utils.FrozenDict | dict[str, typing.Any] = Nonereturn_unused_kwargs = False**kwargs ) → ModelMixin or SchedulerMixin

المعاملات

  • config (dict[str, Any]) — قاموس إعدادات يتم منه إنشاء الفئة بلغة بايثون. تأكد من تحميل ملفات الإعداد الخاصة بالفئات المتوافقة فقط.
  • return_unused_kwargs (bool، اختياري، القيمة الافتراضية False) — ما إذا كان يجب إرجاع معاملات kwargs التي لا تستهلكها فئة Python أم لا.
  • kwargs (قاموس متبقٍ من معاملات الكلمات المفتاحية، اختياري) — يمكن استخدامه لتحديث كائن الإعداد (بعد تحميله) وبدء فئة بايثون. تُمرَّر **kwargs مباشرةً إلى طريقة __init__ الخاصة بالجدول الزمني/النموذج الأساسي، وتُغني في النهاية عن معاملات الأسماء نفسها في config.

يعيد

ModelMixin أو SchedulerMixin

كائن نموذج أو مجدول مُنشأ من قاموس إعدادات.

أنشئ كائنًا من فئة بايثون من قاموس الإعدادات.

أمثلة:

>>> from diffusers import DDPMScheduler, DDIMScheduler, PNDMScheduler

>>> # Download scheduler from huggingface.co and cache.
>>> scheduler = DDPMScheduler.from_pretrained("google/ddpm-cifar10-32")

>>> # Instantiate DDIM scheduler class with same config as DDPM
>>> scheduler = DDIMScheduler.from_config(scheduler.config)

>>> # Instantiate PNDM scheduler class with same config as DDPM
>>> scheduler = PNDMScheduler.from_config(scheduler.config)

save_config

< >

( save_directory: str | os.PathLikepush_to_hub: bool = False**kwargs )

المعاملات

  • save_directory (str أو os.PathLike) — المجلد الذي يُحفظ فيه ملف الإعدادات بصيغة JSON (سيتم إنشاؤه إذا لم يكن موجودًا).
  • push_to_hub (bool، اختياري، الافتراضي False) — ما إذا كان سيتم دفع نموذجك إلى Hugging Face Hub بعد حفظه. يمكنك تحديد المستودع الذي تريد الدفع إليه باستخدام repo_id (سيكون الافتراضي هو اسم save_directory في نطاقك).
  • kwargs (dict[str, Any]، اختياري) — معلمات إضافية تُمرَّر إلى طريقة push_to_hub().

احفظ كائن الإعدادات في المجلد المحدد في save_directory بحيث يمكن إعادة تحميله باستخدام طريقة الفئة from_config().

to_json_file

< >

( json_file_path: str | os.PathLike )

المعاملات

  • json_file_path (str أو os.PathLike) — المسار إلى ملف JSON لحفظ معاملات نسخة الإعداد.

احفظ معاملات كائن الإعداد في ملف JSON.

to_json_string

< >

( ) → str

يعيد

str

سلسلة تحتوي على جميع السمات التي تُشكّل مثيل الإعداد بصيغة JSON.

يسلسل كائن الإعداد إلى نص JSON.

Update on GitHub

←المبادئ التوجيهية الأخلاقية لـ Diffusers التسجيل→