Diffusers documentation

Tek dosyalar

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

Tek dosyalar

from_single_file() yöntemi, aşağıdakileri yüklemenizi sağlar:

  • Tek bir dosyada saklanan bir model; bu, Automatic1111 gibi difüzyon ekosistemindeki modellerle çalışırken ve modelleri saklamak ve paylaşmak için yaygın olarak tek dosyalı bir düzeni kullandığınızda faydalıdır
  • orijinal dağıtım düzeninde saklanan bir model, bu özellikle başka servislerle ince ayarlanmış modellerle çalışırken ve modeli doğrudan Diffusers model nesnelerine ve boru hatlarına yüklemek istediğinizde faydalıdır

Diffusers-multifolder yerleşimi ile tek dosya yerleşimi arasındaki farkı ve bu farklı yerleşimlerde saklanan modellerin nasıl yükleneceğini öğrenmek için Model dosyaları ve yerleşimleri kılavuzunu okuyun.

Desteklenen boru hatları

Desteklenen modeller

FromSingleFileMixin

sınıf diffusers.loaders.FromSingleFileMixin

< >

( )

.ckpt biçiminde kaydedilen model ağırlıklarını bir DiffusionPipeline içine yükleyin.

from_single_file

< >

( pretrained_model_link_or_path**kwargs )

Parametreler

  • pretrained_model_link_or_path (str veya os.PathLike, isteğe bağlı) — Şu olabilir:
    • Hub'daki .ckpt dosyasına bir bağlantı (örneğin "https://huggingface.co/<repo_id>/blob/main/<path_to_file>.ckpt").
    • Tüm pipeline ağırlıklarını içeren bir dosya için yol.
  • dtype (str veya torch.dtype, isteğe bağlı) — Varsayılan torch.dtype değerini geçersiz kılın ve modeli başka bir dtype ile yükleyin.
  • 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.
  • 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.
  • 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.
  • 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.
  • original_config_file (str, isteğe bağlı) — Modelin eğitilmesinde kullanılan orijinal yapılandırma dosyasının yolu. Sağlanmazsa, yapılandırma dosyası kontrol noktası dosyasından çıkarılır.
  • config (str, isteğe bağlı) — Şunlardan biri olabilir:
    • Hub'da barındırılan önceden eğitilmiş bir pipeline'ın repo id'si (örneğin CompVis/ldm-text2im-large-256) olan bir dize.
    • Diffusers biçiminde pipeline bileşen yapılandırmalarını içeren bir dizin (örneğin ./my_pipeline_directory/) yoluna.
  • disable_mmap (‘bool’, isteğe bağlı, varsayılan ‘False’) — Bir Safetensors modeli yüklenirken mmap'in devre dışı bırakılıp bırakılmayacağı. Model bir ağ biriminde veya sabit diskte olduğunda bu seçenek daha iyi performans gösterebilir.
  • kwargs (geri kalan anahtar kelime argümanları sözlüğü, isteğe bağlı) — Yükleme ve kaydedilebilir değişkenleri (belirli pipeline sınıfının pipeline bileşenlerini) geçersiz kılmak için kullanılabilir. Geçersiz kılınan bileşenler doğrudan pipeline'ın __init__ yöntemine iletilir. Daha fazla bilgi için aşağıdaki örneğe bakın.

.ckpt veya .safetensors biçiminde kaydedilmiş önceden eğitilmiş pipeline ağırlıklarından bir DiffusionPipeline örneği oluşturun. Pipeline varsayılan olarak değerlendirme moduna ayarlanır (model.eval()).

Örnekler:

>>> from diffusers import StableDiffusionPipeline

>>> # Download pipeline from huggingface.co and cache.
>>> pipeline = StableDiffusionPipeline.from_single_file(
...     "https://huggingface.co/WarriorMama777/OrangeMixs/blob/main/Models/AbyssOrangeMix/AbyssOrangeMix.safetensors"
... )

>>> # Download pipeline from local file
>>> # file is downloaded under ./v1-5-pruned-emaonly.ckpt
>>> pipeline = StableDiffusionPipeline.from_single_file("./v1-5-pruned-emaonly.ckpt")

>>> # Enable float16 and move to GPU
>>> pipeline = StableDiffusionPipeline.from_single_file(
...     "https://huggingface.co/stable-diffusion-v1-5/stable-diffusion-v1-5/blob/main/v1-5-pruned-emaonly.ckpt",
...     torch_dtype=torch.float16,
... )
>>> pipeline.to("cuda")

FromOriginalModelMixin

sınıf diffusers.loaders.FromOriginalModelMixin

< >

( )

.ckpt veya .safetensors biçiminde kaydedilmiş önceden eğitilmiş ağırlıkları bir modele yükleyin.

from_single_file

< >

( pretrained_model_link_or_path_or_dict: str | None = None**kwargs )

Parametreler

  • pretrained_model_link_or_path_or_dict (str, isteğe bağlı) — Şunlardan biri olabilir:
    • Hub'daki .safetensors veya .ckpt dosyasına (örneğin "https://huggingface.co/<repo_id>/blob/main/<path_to_file>.safetensors") giden bağlantı.
    • Bileşen modelinin ağırlıklarını içeren yerel bir dosya için yol.
    • Bileşen model ağırlıklarını içeren bir durum sözlüğü (state dict).
  • config (str, isteğe bağlı) —
    • Bir dize, Hub üzerinde barındırılan önceden eğitilmiş bir hattın repo kimliği (örneğin CompVis/ldm-text2im-large-256).
    • Diffusers biçiminde pipeline bileşeni yapılandırmalarını içeren bir dizin (örneğin ./my_pipeline_directory/) yoluna.
  • 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.
  • original_config (str, isteğe bağlı) — Modelin orijinal biçimindeki yapılandırmasını içeren bir sözlük veya bir yaml dosyasına yol. Bir sözlük sağlanırsa, model yapılandırmasını başlatmak için kullanılır.
  • dtype (torch.dtype, isteğe bağlı) — Varsayılan torch.dtype değerini geçersiz kılar ve modeli başka bir dtype ile yükler.
  • 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.
  • 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.
  • 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.
  • 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.
  • low_cpu_mem_usage (bool, isteğe bağlı, torch sürümü >= 1.9.0 ve — is_accelerate_available() ise varsayılan olarak True, aksi halde False): Modeli yalnızca ön eğitilmiş ağırlıkları yükleyerek ve ağırlıkları başlatmadan yüklemeyi hızlandırır. Bu, model yüklenirken CPU belleğinde (tepe bellek dahil) model boyutunun 1 katından fazlasını kullanmamaya da çalışır. Yalnızca PyTorch >= 1.9.0 için desteklenir. Daha eski bir PyTorch sürümü kullanıyorsanız, bu argümanı True olarak ayarlamak bir hata oluşturur.
  • disable_mmap (‘bool’, isteğe bağlı, varsayılan ‘False’) — Bir Safetensors modeli yüklenirken mmap'in devre dışı bırakılıp bırakılmayacağı. Model bir ağ biriminde veya sabit diskte olduğunda, bu ortamın mmap'in sıklıkla konum değiştirme (seek) gerektiren doğasını iyi yönetememesi nedeniyle bu seçenek daha iyi performans gösterebilir.
  • kwargs (geriye kalan anahtar-argüman sözlüğü, isteğe bağlı) — Yükleme ve kaydedilebilir değişkenlerin üzerine yazılabilmesi için kullanılabilir (örneğin belirli bir pipeline sınıfının pipeline bileşenleri). Üzerine yazılan bileşenler doğrudan pipeline'ın __init__ metoduna iletilir. Daha fazla bilgi için aşağıdaki örneğe bakın.

Orijinal .ckpt veya .safetensors biçiminde kaydedilmiş önceden eğitilmiş ağırlıklardan bir model örnekleyin. Model varsayılan olarak değerlendirme moduna ayarlanır (model.eval()).

>>> from diffusers import StableCascadeUNet

>>> ckpt_path = "https://huggingface.co/stabilityai/stable-cascade/blob/main/stage_b_lite.safetensors"
>>> model = StableCascadeUNet.from_single_file(ckpt_path)
Update on GitHub