diffusers/main/id/api/loaders/single_file.md

Berkas tunggal

Metode from_single_file() memungkinkan Anda untuk memuat:

• model yang disimpan dalam satu file, yang berguna jika Anda bekerja dengan model dari ekosistem difusi, seperti Automatic1111, dan umumnya mengandalkan tata letak satu file untuk menyimpan dan membagikan model
• model yang disimpan dalam tata letak distribusi aslinya, yang berguna jika Anda bekerja dengan model yang telah ditala ulang menggunakan layanan lain, dan ingin memuatnya langsung ke dalam objek model dan pipeline Diffusers

Baca panduan Model files and layouts untuk mempelajari lebih lanjut tentang tata letak Diffusers-multifolder versus tata letak single-file, serta cara memuat model yang disimpan dalam tata letak yang berbeda ini.

Pipeline yang didukung

• StableDiffusionPipeline
• StableDiffusionImg2ImgPipeline
• StableDiffusionInpaintPipeline
• StableDiffusionControlNetPipeline
• StableDiffusionControlNetImg2ImgPipeline
• StableDiffusionControlNetInpaintPipeline
• StableDiffusionUpscalePipeline
• StableDiffusionXLPipeline
• StableDiffusionXLImg2ImgPipeline
• StableDiffusionXLInpaintPipeline
• StableDiffusionXLInstructPix2PixPipeline
• StableDiffusionXLControlNetPipeline
• StableDiffusionXLKDiffusionPipeline
• StableDiffusion3Pipeline
• LatentConsistencyModelPipeline
• LatentConsistencyModelImg2ImgPipeline
• StableDiffusionControlNetXSPipeline
• StableDiffusionXLControlNetXSPipeline
• LEditsPPPipelineStableDiffusion
• LEditsPPPipelineStableDiffusionXL
• PIAPipeline

Model yang didukung

• UNet2DConditionModel
• StableCascadeUNet
• AutoencoderKL
• ControlNetModel
• SD3Transformer2DModel
• FluxTransformer2DModel

FromSingleFileMixin[[diffusers.loaders.FromSingleFileMixin]]

diffusers.loaders.FromSingleFileMixin[[diffusers.loaders.FromSingleFileMixin]]

diffusers.loaders.FromSingleFileMixin()

Sumber

Muat bobot model yang disimpan dalam format .ckpt ke dalam DiffusionPipeline.

from_single_file[[diffusers.loaders.FromSingleFileMixin.from_single_file]]

from_single_file(pretrained_model_link_or_path, **kwargs)

Sumber

Parameter:

pretrained_model_link_or_path (str atau os.PathLike, opsional) : Bisa berupa: - Tautan ke file .ckpt (misalnya "https://huggingface.co/<repo_id>/blob/main/<path_to_file>.ckpt") di Hub. - Path ke file yang berisi semua bobot pipeline.

dtype (str atau torch.dtype, opsional) : Menimpa torch.dtype bawaan dan memuat model dengan dtype lain.

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

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

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.

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.

original_config_file (str, opsional) : Path ke file config asli yang digunakan untuk melatih model. Jika tidak disediakan, file config akan disimpulkan dari file checkpoint.

config (str, opsional) : Bisa berupa: - String, repo id (misalnya CompVis/ldm-text2im-large-256) dari pipeline pretrained yang dihosting di Hub. - Path ke direktori (misalnya ./my_pipeline_directory/) yang berisi konfigurasi komponen pipeline dalam format Diffusers.

disable_mmap ('bool', opsional, default 'False') : Apakah akan menonaktifkan mmap saat memuat model Safetensors. Opsi ini dapat memberikan performa yang lebih baik ketika model berada di network mount atau hard drive.

kwargs (sisa kamus argumen kata kunci, opsional) : Dapat digunakan untuk menimpa variabel yang dapat dimuat dan disimpan (komponen pipeline dari kelas pipeline tertentu). Komponen yang ditimpa tersebut diteruskan langsung ke metode __init__ pipeline. Lihat contoh di bawah untuk informasi lebih lanjut.

Instansiasi DiffusionPipeline dari bobot pipeline pretrained yang disimpan dalam format .ckpt atau .safetensors. Pipeline secara default diatur dalam mode evaluasi (model.eval()).

Contoh:

>>> 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[[diffusers.loaders.FromOriginalModelMixin]]

diffusers.loaders.FromOriginalModelMixin[[diffusers.loaders.FromOriginalModelMixin]]

diffusers.loaders.FromOriginalModelMixin()

Sumber

Muat bobot terlatih yang disimpan dalam format .ckpt atau .safetensors ke dalam model.

from_single_file[[diffusers.loaders.FromOriginalModelMixin.from_single_file]]

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

Sumber

Parameter:

pretrained_model_link_or_path_or_dict (str, opsional) : Dapat berupa salah satu dari: - Tautan ke file .safetensors atau .ckpt (misalnya "https://huggingface.co/<repo_id>/blob/main/<path_to_file>.safetensors") di Hub. - Path ke file lokal yang berisi bobot model komponen. - state dict yang berisi bobot model komponen.

config (str, opsional) : - String, repo id (misalnya CompVis/ldm-text2im-large-256) dari pipeline pretrained yang dihosting di Hub. - Path ke direktori (misalnya ./my_pipeline_directory/) yang berisi konfigurasi komponen pipeline dalam format Diffusers.

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

original_config (str, opsional) : Dict atau path ke file yaml yang berisi konfigurasi model dalam format aslinya. Jika dict diberikan, dict tersebut akan digunakan untuk menginisialisasi konfigurasi model.

dtype (torch.dtype, opsional) : Menimpa torch.dtype bawaan dan memuat model dengan dtype lain.

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

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

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.

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.

low_cpu_mem_usage (bool, opsional, defaultnya True jika versi torch >= 1.9.0 dan : is_accelerate_available() selain itu False): Mempercepat pemuatan model dengan hanya memuat bobot pretrained dan tidak menginisialisasi bobot. Ini juga berusaha untuk tidak menggunakan lebih dari 1x ukuran model di memori CPU (termasuk memori puncak) saat memuat model. Hanya didukung untuk PyTorch >= 1.9.0. Jika Anda menggunakan versi PyTorch yang lebih lama, mengatur argumen ini ke True akan memicu error.

disable_mmap ('bool', opsional, default 'False') : Apakah akan menonaktifkan mmap saat memuat model Safetensors. Opsi ini dapat memberikan performa yang lebih baik ketika model berada di network mount atau hard drive, yang mungkin tidak menangani sifat seeky dari mmap dengan baik.

kwargs (sisa kamus argumen kata kunci, opsional) : Dapat digunakan untuk menimpa variabel yang dapat dimuat dan disimpan (misalnya komponen pipeline dari kelas pipeline tertentu). Komponen yang ditimpa langsung diteruskan ke metode __init__ pipeline. Lihat contoh di bawah untuk informasi lebih lanjut.

Instansiasi model dari bobot pretrained yang disimpan dalam format asli .ckpt atau .safetensors. Model secara default diatur dalam mode evaluasi (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)