Hugging Face's logo

Diffusers documentation

設定

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

設定

SchedulerMixin 由来のスケジューラと ModelMixin 由来のモデルは、ConfigMixin を継承し、それぞれの __init__ メソッドに渡されたすべてのパラメータを JSON 設定ファイルに保存します。

プライベートモデルやゲート付きモデルを使用するには、hf auth loginでログインしてください。

ConfigMixin

クラス diffusers.ConfigMixin

< >

( )

すべての設定クラスの基底クラスです。すべての設定パラメータはself.configの下に保存されます。また、ConfigMixinを継承するクラスの読み込み、ダウンロード、保存を行うためのfrom_config()およびsave_config()メソッドも提供します。

クラス属性:

  • config_name (str) — save_config()を呼び出す際に、設定を保存するためのファイル名（親クラスによって上書きされるべきです）。
  • ignore_for_config (list[str]) — 設定に保存すべきでない属性のリスト（サブクラスで上書きされるべきです）。
  • has_compatibles (bool) — クラスに互換性のあるクラスが存在するかどうか（サブクラスでオーバーライドすべき）。
  • _deprecated_kwargs (list[str]) — 非推奨のキーワード引数です。少なくとも1つの引数が非推奨の場合にのみ、init 関数に kwargs 引数を持つべきです（サブクラスでオーバーライドされるべきです）。

load_config

< >

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

パラメータ

  • pretrained_model_name_or_path (str または os.PathLike, 省略可) — 以下のいずれかです:
    • Hub にホストされている事前学習済みモデルの model id（例: google/ddpm-celebahq-256）を表す文字列。
    • save_config() で保存されたモデルの重みを格納したディレクトリ（例: ./my_model_directory）へのパス。
  • cache_dir (str | os.PathLike, 任意) — 標準のキャッシュを使用しない場合、ダウンロードした事前学習モデルの構成がキャッシュされるディレクトリのパス。
  • force_download (bool、任意、デフォルトは False) — モデルの重みおよび設定ファイルを（再）ダウンロードすることを強制するかどうか。キャッシュされたバージョンが存在する場合でも、それらを無視してダウンロードします。
  • proxies (dict[str, str]、省略可) — プロトコルまたはエンドポイントごとに使用するプロキシサーバーの辞書です。例えば、{'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'} のように指定します。各リクエストでこれらのプロキシが使用されます。
  • output_loading_info(bool, optional, デフォルトは False) — 欠落キー、予期しないキー、エラーメッセージを含む辞書を返すかどうかを指定します。
  • local_files_only (bool、任意、デフォルトは False) — ローカルのモデル重みと設定ファイルのみを読み込むかどうかを指定します。True に設定すると、モデルは Hub からダウンロードされません。
  • token (str または bool、省略可能) — リモートファイルの HTTP ベアラ認証に使用するトークンです。True の場合、diffusers-cli login で生成されたトークン（~/.huggingface に保存されています）が使用されます。
  • revision (str、任意、デフォルトは"main") — 使用する特定のモデルのバージョンです。ブランチ名、タグ名、コミット ID、または Git によって許可される任意の識別子を使用できます。
  • subfolder (str、任意、デフォルトは"") — Hub またはローカル上のより大きなモデルリポジトリ内での、モデルファイルのサブフォルダの場所。
  • return_unused_kwargs (bool、省略可能、デフォルトは `False`) — 設定の未使用のキーワード引数を返すかどうか。
  • return_commit_hash (bool, optional, defaults to False) -- Whether the commit_hash` of the loaded configuration are returned.

戻り値

dict

JSON設定ファイルに保存されているすべてのパラメータの辞書。

モデルまたはスケジューラーの設定を読み込みます。

from_config

< >

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

パラメータ

  • config (dict[str, Any]) — Python クラスをインスタンス化するための設定辞書です。互換性のあるクラスの設定ファイルのみを読み込むようにしてください。
  • return_unused_kwargs (bool、省略可能、デフォルトはFalse) — Python クラスによって消費されない kwargs を返すかどうかを指定します。
  • kwargs (残りのキーワード引数の辞書、任意) — 設定オブジェクト（読み込み後）を更新し、Python クラスを初期化するために使用できます。 **kwargs は、基盤となるスケジューラ/モデルの __init__ メソッドに直接渡され、最終的に config 内の同名の引数を上書きします。

戻り値

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: str | os.PathLikepush_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: str | os.PathLike )

パラメータ

  • json_file_path (str または os.PathLike) — 設定インスタンスのパラメータを保存する JSON ファイルへのパス。

設定インスタンスのパラメータをJSONファイルに保存します。

to_json_string

< >

( ) → str

戻り値

str

JSON形式で、設定インスタンスを構成するすべての属性を含む文字列。

設定インスタンスをJSON文字列にシリアライズします。

Update on GitHub

←Diffusers の倫理ガイドライン ログ出力→