Diffusers 文件
配置
並獲得增強的文件體驗
開始使用
配置
來自 SchedulerMixin 的排程器和來自 ModelMixin 的模型都繼承自 ConfigMixin，它將所有傳遞給其各自 __init__ 方法的引數儲存在一個 JSON 配置檔案中。
要使用私有或封閉模型，請使用 huggingface-cli login 登入。
ConfigMixin
所有配置類的基類。所有配置引數都儲存在 self.config 下。還提供 from_config() 和 save_config() 方法，用於載入、下載和儲存繼承自 ConfigMixin 的類。
類屬性
- config_name (
str) — 呼叫 save_config() 時應儲存配置的檔名（應由父類覆蓋）。 - ignore_for_config (
List[str]) — 不應儲存在配置中的屬性列表（應由子類覆蓋）。 - has_compatibles (
bool) — 類是否具有相容類（應由子類覆蓋）。 - _deprecated_kwargs (
List[str]) — 已棄用的關鍵字引數。請注意，只有在至少一個引數被棄用時，init函式才應具有kwargs引數（應由子類覆蓋）。
load_config
< 源 >( pretrained_model_name_or_path: typing.Union[str, os.PathLike] return_unused_kwargs = False return_commit_hash = False **kwargs ) → dict
引數
- pretrained_model_name_or_path (
str或os.PathLike, 可選) — 可以是：- Hub 上託管的預訓練模型的模型ID字串（例如
google/ddpm-celebahq-256）。 - 包含使用 save_config() 儲存的模型權重的目錄路徑（例如
./my_model_directory）。
- Hub 上託管的預訓練模型的模型ID字串（例如
- cache_dir (
Union[str, os.PathLike], 可選) — 預訓練模型配置下載後快取的目錄路徑，如果未使用標準快取。 - force_download (
bool, 可選, 預設為False) — 是否強制（重新）下載模型權重和配置檔案，如果存在快取版本則覆蓋。 - proxies (
Dict[str, str], 可選) — 要按協議或端點使用的代理伺服器字典，例如{'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") — 要使用的特定模型版本。它可以是分支名稱、標籤名稱、提交ID或Git允許的任何識別符號。 - subfolder (
str, 可選, 預設為"") — 模型檔案在 Hub 或本地較大模型倉庫中的子資料夾位置。 - return_unused_kwargs (
bool, 可選, 預設為False) — 是否返回配置中未使用的關鍵字引數。 - return_commit_hash (
bool, 可選, 預設為False) — 是否返回載入配置的commit_hash。
返回
字典
儲存在 JSON 配置檔案中的所有引數的字典。
載入模型或排程器配置。
from_config
< 源 >( config: typing.Union[diffusers.configuration_utils.FrozenDict, typing.Dict[str, typing.Any]] = None return_unused_kwargs = False **kwargs ) → ModelMixin 或 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
< 源 >( save_directory: typing.Union[str, os.PathLike] push_to_hub: bool = False **kwargs )
引數
- 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() 方法的附加關鍵字引數。
將配置物件儲存到 save_directory 中指定的目錄，以便可以使用 from_config() 類方法重新載入它。
to_json_file
< 源 >( json_file_path: typing.Union[str, os.PathLike] )
將配置例項的引數儲存到 JSON 檔案。
將配置例項序列化為 JSON 字串。