Buckets:

hf-doc-build/doc / diffusers /main /ar /api /configuration.md
mishig's picture
|
download
raw
10.3 kB
# الإعداد
تورث المجدولات من [SchedulerMixin](/docs/diffusers/main/ar/api/schedulers/overview#diffusers.SchedulerMixin) والنماذج من [ModelMixin](/docs/diffusers/main/ar/api/models/overview#diffusers.ModelMixin) من [ConfigMixin](/docs/diffusers/main/ar/api/configuration#diffusers.ConfigMixin) الذي يخزّن جميع المعاملات المُمرّرة إلى طرق `__init__` الخاصة بها في ملف تكوين بصيغة JSON.
> [!TIP]
> لاستخدام النماذج الخاصة أو [المقيّدة](https://huggingface.co/docs/hub/models-gated#gated-models)، سجّل الدخول باستخدام `hf auth login`.
## ConfigMixin[[diffusers.ConfigMixin]]
#### diffusers.ConfigMixin[[diffusers.ConfigMixin]]
```python
diffusers.ConfigMixin()
```
[المصدر](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L87)
الفئة الأساسية لجميع فئات الإعداد. تُخزَّن جميع معاملات الإعداد تحت `self.config`. كما توفر طريقتي [from_config()](/docs/diffusers/main/ar/api/configuration#diffusers.ConfigMixin.from_config) و[save_config()](/docs/diffusers/main/ar/api/configuration#diffusers.ConfigMixin.save_config) لتحميل وتنزيل وحفظ الفئات التي ترث من [ConfigMixin](/docs/diffusers/main/ar/api/configuration#diffusers.ConfigMixin).
خصائص الفئة:
- **config_name** (`str`) -- اسم الملف الذي يجب حفظ الإعدادات تحته عند استدعاء [save_config()](/docs/diffusers/main/ar/api/configuration#diffusers.ConfigMixin.save_config) (يجب أن يتم تجاوز هذا من قبل الفئة الأم).
- **ignore_for_config** (`list[str]`) -- قائمة بالخصائص التي يجب عدم حفظها في الإعدادات (يجب أن يتم تجاوزها بواسطة الفئة الفرعية).
- **has_compatibles** (`bool`) -- ما إذا كانت الفئة تحتوي على فئات متوافقة (يجب أن يتم تجاوزها بواسطة الفئة الفرعية).
- **_deprecated_kwargs** (`list[str]`) -- حُجج الكلمات المفتاحية التي تم إيقاف استخدامها. لاحظ أن دالة `init` يجب أن تحتوي على حجة `kwargs` فقط إذا كانت هناك حجة واحدة على الأقل تم إيقاف استخدامها (يجب أن يتم تجاوزها بواسطة الفئة الفرعية).
#### load_config[[diffusers.ConfigMixin.load_config]]
```python
load_config(pretrained_model_name_or_path: str | os.PathLike, return_unused_kwargs = False, return_commit_hash = False, **kwargs)
```
[المصدر](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L322)
**المعاملات:**
pretrained_model_name_or_path (`str` أو `os.PathLike`، *اختياري*) : يمكن أن يكون أحد ما يلي: - نص، وهو *معرف النموذج* (مثل `google/ddpm-celebahq-256`) لنموذج مُدرَّب مسبقًا مستضاف على Hub. - مسار إلى *مجلد* (مثل `./my_model_directory`) يحتوي على أوزان النموذج المحفوظة باستخدام [save_config()](/docs/diffusers/main/ar/api/configuration#diffusers.ConfigMixin.save_config).
cache_dir (`str | os.PathLike`، *اختياري*) : مسار إلى مجلد حيث تُخزَّن مؤقتًا إعدادات النموذج المُسبق التحميل المُحمَّل إذا لم يُستخدم التخزين المؤقت القياسي.
force_download (`bool`، *اختياري*، القيمة الافتراضية `False`) : ما إذا كان يجب إجبار إعادة تنزيل أوزان النموذج وملفات الإعداد، مع تجاوز النسخ المخزنة مؤقتًا إذا كانت موجودة.
proxies (`dict[str, str]`، *اختياري*) : قاموس لخوادم الوكيل (proxy servers) للاستخدام حسب البروتوكول أو نقطة النهاية، على سبيل المثال، `{'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 bearer للملفات البعيدة. إذا كان `True`، يُستخدم التوكن المولّد من `diffusers-cli login` (المخزَّن في `~/.huggingface`).
revision (`str`، *اختياري*، القيمة الافتراضية `"main"`) : إصدار النموذج المحدد الذي سيتم استخدامه. يمكن أن يكون اسم فرع، أو اسم وسم، أو معرف التزامن، أو أي معرّف مسموح به بواسطة 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[[diffusers.ConfigMixin.from_config]]
```python
from_config(config: diffusers.configuration_utils.FrozenDict | dict[str, typing.Any] = None, return_unused_kwargs = False, **kwargs)
```
[المصدر](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L221)
**المعاملات:**
config (`dict[str, Any]`) : قاموس إعدادات يتم منه إنشاء الفئة بلغة بايثون. تأكد من تحميل ملفات الإعداد الخاصة بالفئات المتوافقة فقط.
return_unused_kwargs (`bool`، *اختياري*، الافتراضي `False`) : ما إذا كان يجب إرجاع معاملات kwargs التي لا تستهلكها فئة Python أم لا.
kwargs (باقي قاموس من معاملات الكلمات المفتاحية، *اختياري*) : يمكن استخدامه لتحديث كائن الإعداد (بعد تحميله) وبدء فئة بايثون. تُمرَّر `**kwargs` مباشرةً إلى طريقة `__init__` الخاصة بمجدول/النموذج الأساسي، وتُغني في النهاية عن معاملات بنفس الاسم في `config`.
**يعيد:** [ModelMixin](/docs/diffusers/main/ar/api/models/overview#diffusers.ModelMixin) أو [SchedulerMixin](/docs/diffusers/main/ar/api/schedulers/overview#diffusers.SchedulerMixin)
كائن نموذج أو مجدول مُنشأ من قاموس إعدادات.
أنشئ كائنًا من فئة بايثون من قاموس الإعدادات.
أمثلة:
```python
>>> 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[[diffusers.ConfigMixin.save_config]]
```python
save_config(save_directory: str | os.PathLike, push_to_hub: bool = False, **kwargs)
```
[المصدر](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L177)
**المعاملات:**
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()](/docs/diffusers/main/ar/api/schedulers/overview#diffusers.utils.PushToHubMixin.push_to_hub).
احفظ كائن الإعدادات في المجلد المحدد في `save_directory` بحيث يمكن إعادة تحميله باستخدام طريقة الفئة [from_config()](/docs/diffusers/main/ar/api/configuration#diffusers.ConfigMixin.from_config).
#### to_json_file[[diffusers.ConfigMixin.to_json_file]]
```python
to_json_file(json_file_path: str | os.PathLike)
```
[المصدر](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L647)
**المعاملات:**
json_file_path (`str` أو `os.PathLike`) : المسار إلى ملف JSON لحفظ معاملات مثيل التهيئة.
احفظ معاملات كائن الإعداد في ملف JSON.
#### to_json_string[[diffusers.ConfigMixin.to_json_string]]
```python
to_json_string()
```
[المصدر](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L602)
**يعيد:** `str`
سلسلة تحتوي على جميع السمات التي تُشكّل مثيل الإعداد بصيغة JSON.
يسلسل كائن الإعداد إلى نص JSON.

Xet Storage Details

Size:
10.3 kB
·
Xet hash:
a5ed95c4edf3a872e74b38c2fd7c863daae9a311ba1728b8d0ee3f16536d140d

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.