Hugging Face's logo

Diffusers documentation

Yapılandırma

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

Yapılandırma

SchedulerMixin içindeki zamanlayıcılar ve ModelMixin içindeki modeller, __init__ yöntemlerine aktarılan tüm parametreleri bir JSON yapılandırma dosyasında saklayan ConfigMixin sınıfından devralır.

Özel veya korumalı modelleri kullanmak için hf auth login ile oturum açın.

ConfigMixin

sınıf diffusers.ConfigMixin

< >

( )

Tüm yapılandırma sınıfları için temel sınıf. Tüm yapılandırma parametreleri self.config altında saklanır. Ayrıca ConfigMixin'den türeyen sınıfları yükleme, indirme ve kaydetme için from_config() ve save_config() yöntemlerini sağlar.

Sınıf özellikleri:

  • config_name (str) — save_config() çağrıldığında yapılandırmanın kaydedileceği dosya adı (üst sınıf tarafından geçersiz kılınmalıdır).
  • ignore_for_config (list[str]) — Yapılandırmada kaydedilmemesi gereken özniteliklerin listesi (alt sınıf tarafından geçersiz kılınmalıdır).
  • has_compatibles (bool) — Sınıfın uyumlu sınıflarının olup olmadığı (alt sınıf tarafından geçersiz kılınmalıdır).
  • _deprecated_kwargs (list[str]) — Eski kullanımdan kaldırılmış anahtar kelime argümanları. Not: En az bir argüman eski kullanımdan kaldırılmışsa, init fonksiyonunun yalnızca bir kwargs argümanı olmalıdır (alt sınıf tarafından geçersiz kılınmalıdır).

load_config

< >

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

Parametreler

  • pretrained_model_name_or_path (str veya os.PathLike, isteğe bağlı) — Şu seçeneklerden biri olabilir:
    • Bir dize, Hub üzerinde barındırılan önceden eğitilmiş bir modelin model kimliği (örneğin google/ddpm-celebahq-256).
    • Model ağırlıklarını save_config() ile kaydetmiş bir dizin (örneğin ./my_model_directory) için bir yol.
  • cache_dir (str | os.PathLike, isteğe bağlı) — Standart önbellek kullanılmıyorsa, indirilen önceden eğitilmiş model yapılandırmasının önbelleğe alındığı dizinin yolu.
  • force_download (bool, isteğe bağlı, varsayılan False) — Model ağırlıklarının ve yapılandırma dosyalarının (yeniden) indirilmesinin zorlanıp zorlanmayacağını belirler; önbellekteki sürümler varsa bunların üzerine yazar.
  • proxies (dict[str, str], isteğe bağlı) — Protokole veya uç noktaya göre kullanılacak vekil sunucuların sözlüğü, örneğin {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Vekiller her istekte kullanılır.
  • output_loading_info(bool, opsiyonel, varsayılan olarak False) — Eksik anahtarlar, beklenmeyen anahtarlar ve hata mesajlarını içeren bir sözlüğü de döndürülüp döndürülmeyeceğini belirtir.
  • local_files_only (bool, isteğe bağlı, varsayılan False) — Yalnızca yerel model ağırlıkları ve yapılandırma dosyalarının yüklenip yüklenmeyeceğini belirtir. True olarak ayarlanırsa, model Hub'dan indirilmez.
  • token (str veya bool, isteğe bağlı) — Uzak dosyalar için HTTP bearer yetkilendirmesi olarak kullanılacak jeton. True ise, diffusers-cli login ile oluşturulan jeton ( ~/.huggingface içinde saklanır) kullanılır.
  • revision (str, isteğe bağlı, varsayılan "main") — Kullanılacak belirli model sürümü. Bir dal adı, etiket adı, commit kimliği veya Git tarafından izin verilen herhangi bir tanımlayıcı olabilir.
  • subfolder (str, isteğe bağlı, varsayılan "") — Hub'da veya yerel olarak daha büyük bir model deposu içindeki bir model dosyasının alt klasör konumu.
  • return_unused_kwargs (bool, isteğe bağlı, varsayılan `False) — Yapılandırmanın kullanılmayan anahtar kelime argümanlarının döndürülüp döndürülmediğini belirtir.
  • return_commit_hash (bool, optional, defaults to False) -- Whether the commit_hash` of the loaded configuration are returned.

Dönüş değeri

dict

Bir JSON yapılandırma dosyasında saklanan tüm parametrelerin sözlüğü.

Bir model veya zamanlayıcı yapılandırması yükleyin.

from_config

< >

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

Parametreler

  • config (dict[str, Any]) — Python sınıfının örneklenmesi için kullanılan yapılandırma sözlüğü. Yalnızca uyumlu sınıflara ait yapılandırma dosyalarını yüklediğinizden emin olun.
  • return_unused_kwargs (bool, isteğe bağlı, varsayılan False) — Python sınıfı tarafından tüketilmeyen kwargs'nın geri döndürülüp döndürülmeyeceği.
  • kwargs (geriye kalan anahtar-argüman sözlüğü, isteğe bağlı) — Yükleme işleminden sonra yapılandırma nesnesini güncellemek ve Python sınıfını başlatmak için kullanılabilir. **kwargs, alttaki zamanlayıcı/modelin __init__ yöntemine doğrudan iletilir ve nihayetinde config içindeki aynı adlı argümanların üzerine yazar.

Dönüş değeri

ModelMixin veya SchedulerMixin

Bir yapılandırma sözlüğünden örneklenen bir model veya zamanlayıcı nesnesi.

Bir yapılandırma sözlüğünden Python sınıfı örneği oluşturun.

Örnekler:

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

Parametreler

  • save_directory (str veya os.PathLike) — Yapılandırma JSON dosyasının kaydedildiği dizin (varsa oluşturulur).
  • push_to_hub (bool, isteğe bağlı, varsayılan False) — Modelinizi kaydettikten sonra Hugging Face Hub'a gönderip göndermeyeceğinizi belirtir. Göndermek istediğiniz depoyu repo_id ile belirtebilirsiniz (varsayılan olarak ad alanınızdaki save_directory adını kullanır).
  • kwargs (dict[str, Any], isteğe bağlı) — push_to_hub() yöntemine iletilen ek anahtar kelime argümanları.

Bir yapılandırma nesnesini, from_config() sınıf yöntemiyle yeniden yüklenebilmesi için save_directory'de belirtilen dizine kaydedin.

to_json_file

< >

( json_file_path: str | os.PathLike )

Parametreler

  • json_file_path (str veya os.PathLike) — Bir yapılandırma örneğinin parametrelerini kaydetmek için JSON dosyasının yolu.

Yapılandırma örneğinin parametrelerini bir JSON dosyasına kaydedin.

to_json_string

< >

( ) → str

Dönüş değeri

str

JSON biçiminde, yapılandırma örneğini oluşturan tüm öznitelikleri içeren dize.

Yapılandırma örneğini bir JSON dizgesine serileştirir.

Update on GitHub

←Diffusers Etik İlkeleri Kayıt Tutma→