diffusers/main/id/api/configuration.md

Konfigurasi

Schedulers dari SchedulerMixin dan model dari ModelMixin mewarisi dari ConfigMixin yang menyimpan semua parameter yang diteruskan ke metode __init__ mereka masing-masing dalam file konfigurasi JSON.

Untuk menggunakan model privat atau berpagar, masuk dengan hf auth login.

ConfigMixin[[diffusers.ConfigMixin]]

diffusers.ConfigMixin[[diffusers.ConfigMixin]]

diffusers.ConfigMixin()

Sumber

Kelas dasar untuk semua kelas konfigurasi. Semua parameter konfigurasi disimpan di bawah self.config. Juga menyediakan metode from_config() dan save_config() untuk memuat, mengunduh, dan menyimpan kelas yang mewarisi dari ConfigMixin.

Atribut kelas:

• config_name (str) -- Nama file tempat konfigurasi harus disimpan saat memanggil save_config() (seharusnya ditimpa oleh kelas induk).
• ignore_for_config (list[str]) -- Daftar atribut yang tidak boleh disimpan dalam config (seharusnya ditimpa oleh subclass).
• has_compatibles (bool) -- Apakah kelas memiliki kelas yang kompatibel (seharusnya ditimpa oleh subkelas).
• _deprecated_kwargs (list[str]) -- Argumen kata kunci yang sudah tidak digunakan. Perhatikan bahwa fungsi init hanya boleh memiliki argumen kwargs jika setidaknya satu argumen sudah tidak digunakan (seharusnya ditimpa oleh subkelas).

load_config[[diffusers.ConfigMixin.load_config]]

load_config(pretrained_model_name_or_path: str | os.PathLike, return_unused_kwargs = False, return_commit_hash = False, **kwargs)

Sumber

Parameter:

pretrained_model_name_or_path (str atau os.PathLike, opsional) : Bisa berupa: - String, model id (misalnya google/ddpm-celebahq-256) dari model pretrained yang dihosting di Hub. - Path ke direktori (misalnya ./my_model_directory) yang berisi bobot model yang disimpan dengan save_config().

cache_dir (str | os.PathLike, opsional) : Path ke direktori tempat konfigurasi model pretrained yang diunduh di-cache jika cache standar tidak digunakan.

force_download (bool, opsional, defaultnya False) : Apakah akan memaksa (mengunduh ulang) bobot model dan file konfigurasi, menimpa versi yang di-cache jika ada.

proxies (dict[str, str], opsional) : Kamus server proxy yang akan digunakan berdasarkan protokol atau endpoint, misalnya {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Proxy digunakan pada setiap permintaan.

output_loading_info(bool, opsional, default False) : Apakah akan mengembalikan kamus yang berisi kunci yang hilang, kunci yang tidak terduga, dan pesan kesalahan.

local_files_only (bool, opsional, defaultnya False) : Apakah hanya memuat bobot model dan file konfigurasi lokal atau tidak. Jika diatur ke True, model tidak akan diunduh dari Hub.

token (str atau bool, opsional) : Token yang digunakan sebagai otorisasi bearer HTTP untuk file jarak jauh. Jika True, token yang dihasilkan dari diffusers-cli login (disimpan di ~/.huggingface) akan digunakan.

revision (str, opsional, defaultnya "main") : Versi model spesifik yang akan digunakan. Bisa berupa nama branch, nama tag, id commit, atau identifikasi apa pun yang diizinkan oleh Git.

subfolder (str, opsional, defaultnya "") : Lokasi subfolder dari file model di dalam repositori model yang lebih besar di Hub atau secara lokal.

return_unused_kwargs (bool, opsional, defaultnya `False) : Apakah argumen kata kunci yang tidak digunakan dari config dikembalikan.

return_commit_hash (bool, optional, defaults to False) : Whether the commit_hash` of the loaded configuration are returned.

Mengembalikan: dict

Kamus berisi semua parameter yang disimpan dalam file konfigurasi JSON.

Muat konfigurasi model atau scheduler.

from_config[[diffusers.ConfigMixin.from_config]]

from_config(config: diffusers.configuration_utils.FrozenDict | dict[str, typing.Any] = None, return_unused_kwargs = False, **kwargs)

Sumber

Parameter:

config (dict[str, Any]) : Kamus konfigurasi tempat kelas Python diinstansiasi. Pastikan untuk hanya memuat file konfigurasi dari kelas yang kompatibel.

return_unused_kwargs (bool, opsional, defaultnya False) : Apakah kwargs yang tidak dikonsumsi oleh kelas Python harus dikembalikan atau tidak.

kwargs (sisa kamus argumen kata kunci, opsional) : Dapat digunakan untuk memperbarui objek konfigurasi (setelah dimuat) dan menginisiasi kelas Python. **kwargs diteruskan langsung ke metode __init__ scheduler/model yang mendasarinya dan pada akhirnya menimpa argumen dengan nama yang sama di config.

Mengembalikan: ModelMixin atau SchedulerMixin

Objek model atau scheduler yang diinstansiasi dari kamus konfigurasi.

Instansiasi kelas Python dari kamus konfigurasi.

Contoh:

>>> 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]]

save_config(save_directory: str | os.PathLike, push_to_hub: bool = False, **kwargs)

Sumber

Parameter:

save_directory (str atau os.PathLike) : Direktori tempat file konfigurasi JSON disimpan (akan dibuat jika belum ada).

push_to_hub (bool, opsional, defaultnya False) : Apakah model akan didorong ke Hugging Face Hub setelah disimpan. Anda dapat menentukan repositori tujuan dengan repo_id (defaultnya adalah nama save_directory di namespace Anda).

kwargs (dict[str, Any], opsional) : Argumen kata kunci tambahan yang diteruskan ke metode push_to_hub().

Simpan objek konfigurasi ke direktori yang ditentukan dalam save_directory agar dapat dimuat ulang menggunakan metode kelas from_config().

to_json_file[[diffusers.ConfigMixin.to_json_file]]

to_json_file(json_file_path: str | os.PathLike)

Sumber

Parameter:

json_file_path (str atau os.PathLike) : Path ke file JSON untuk menyimpan parameter dari instance konfigurasi.

Simpan parameter instance konfigurasi ke file JSON.

to_json_string[[diffusers.ConfigMixin.to_json_string]]

to_json_string()

Sumber

Mengembalikan: str

String yang berisi semua atribut yang membentuk instance konfigurasi dalam format JSON.

Menserialisasi instance konfigurasi ke string JSON.