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.43.0).
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. Также предоставляет методы 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: str | os.PathLikereturn_unused_kwargs = Falsereturn_commit_hash = False**kwargs ) → dict

Параметры

  • pretrained_model_name_or_path (str или os.PathLike, необязательный) — Может быть:
    • Строка, идентификатор модели (например, google/ddpm-celebahq-256) предобученной модели, размещенной на Hub.
    • Путь к каталогу (например, ./my_model_directory), содержащему веса модели, сохранённые с помощью save_config().
  • 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 bearer-авторизации для удалённых файлов. Если True, используется токен, сгенерированный командой diffusers-cli login (сохранённый в ~/.huggingface).
  • revision (str, необязательный, по умолчанию "main") — Конкретная версия модели, которую следует использовать. Может быть именем ветки, именем тега, идентификатором коммита или любым другим идентификатором, поддерживаемым 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) — Определяет, следует ли возвращать аргументы kwargs, которые не используются классом Python.
  • 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 Логирование→