Hugging Face's logo

Diffusers documentation

Configuration

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

Configuration

Les planificateurs issus de SchedulerMixin et les modèles issus de ModelMixin héritent de ConfigMixin, qui stocke tous les paramètres transmis à leurs méthodes respectives __init__ dans un fichier de configuration JSON.

Pour utiliser des modèles privés ou restreints, connectez-vous avec hf auth login.

ConfigMixin

classe diffusers.ConfigMixin

< >

( )

Classe de base pour toutes les classes de configuration. Tous les paramètres de configuration sont stockés sous self.config. Fournit également les méthodes from_config() et save_config() pour charger, télécharger et enregistrer les classes qui héritent de ConfigMixin.

Attributs de classe :

  • config_name (str) — Un nom de fichier sous lequel la configuration doit être stockée lors de l'appel à save_config() (devrait être remplacé par la classe parente).
  • ignore_for_config (list[str]) — Une liste d'attributs qui ne doivent pas être enregistrés dans la configuration (devrait être réécrit par la sous-classe).
  • has_compatibles (bool) — Indique si la classe possède des classes compatibles (doit être redéfinie par la sous-classe).
  • _deprecated_kwargs (list[str]) — Arguments par mot-clé obsolètes. Notez que la fonction init ne doit avoir un argument kwargs que si au moins un argument est obsolète (devrait être redéfini par la sous-classe).

load_config

< >

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

Paramètres

  • pretrained_model_name_or_path (str ou os.PathLike, facultatif) — Peut être soit :
    • Une chaîne de caractères, l'identifiant du modèle (par exemple google/ddpm-celebahq-256) d'un modèle pré-entraîné hébergé sur le Hub.
    • Un chemin vers un dossier (par exemple ./my_model_directory) contenant les poids du modèle enregistrés avec save_config().
  • cache_dir (str | os.PathLike, facultatif) — Chemin vers un répertoire où la configuration d'un modèle pré-entraîné téléchargé est mise en cache si le cache standard n'est pas utilisé.
  • force_download (bool, facultatif, par défaut False) — Indique s'il faut forcer le (re)téléchargement des poids du modèle et des fichiers de configuration, en ignorant les versions mises en cache si elles existent.
  • proxies (dict[str, str], facultatif) — Un dictionnaire de serveurs proxy à utiliser par protocole ou point de terminaison, par exemple, {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Les proxys sont utilisés pour chaque requête.
  • output_loading_info(bool, facultatif, par défaut False) — Indique s'il faut également retourner un dictionnaire contenant les clés manquantes, les clés inattendues et les messages d'erreur.
  • local_files_only (bool, facultatif, par défaut False) — Indique s'il faut charger uniquement les poids et les fichiers de configuration du modèle en local. Si défini sur True, le modèle ne sera pas téléchargé depuis le Hub.
  • token (str ou bool, facultatif) — Le jeton à utiliser comme autorisation bearer HTTP pour les fichiers distants. Si True, le jeton généré par diffusers-cli login (stocké dans ~/.huggingface) est utilisé.
  • revision (str, facultatif, par défaut "main") — La version spécifique du modèle à utiliser. Il peut s’agir d’un nom de branche, d’un nom de tag, d’un identifiant de commit ou de tout identifiant autorisé par Git.
  • subfolder (str, facultatif, par défaut "") — L’emplacement du sous-dossier d’un fichier de modèle au sein d’un dépôt de modèle plus large sur le Hub ou en local.
  • return_unused_kwargs (bool, facultatif, valeur par défaut `False) — Indique si les arguments par mot-clé non utilisés de la configuration sont retournés.
  • return_commit_hash (bool, optional, defaults to False) -- Whether the commit_hash` of the loaded configuration are returned.

Retourne

dict

Un dictionnaire de tous les paramètres stockés dans un fichier de configuration JSON.

Charger la configuration d’un modèle ou d’un planificateur.

from_config

< >

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

Paramètres

  • config (dict[str, Any]) — Dictionnaire de configuration à partir duquel la classe Python est instanciée. Assurez-vous de ne charger que des fichiers de configuration de classes compatibles.
  • return_unused_kwargs (bool, facultatif, par défaut False) — Indique si les kwargs non consommés par la classe Python doivent être retournés ou non.
  • kwargs (dictionnaire restant d’arguments par mot-clé, facultatif) — Peut être utilisé pour mettre à jour l’objet de configuration (après son chargement) et initialiser la classe Python. **kwargs sont transmis directement à la méthode __init__ du planificateur/modèle sous-jacent et finissent par écraser les arguments de même nom dans config.

Retourne

ModelMixin ou SchedulerMixin

Un objet de modèle ou de planificateur instancié à partir d'un dictionnaire de configuration.

Instanciez une classe Python à partir d'un dictionnaire de configuration.

Exemples :

>>> 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 )

Paramètres

  • save_directory (str ou os.PathLike) — Répertoire où le fichier JSON de configuration est enregistré (sera créé s'il n'existe pas).
  • push_to_hub (bool, facultatif, par défaut False) — Indique s'il faut ou non pousser votre modèle sur le Hugging Face Hub après l'avoir enregistré. Vous pouvez spécifier le dépôt auquel vous souhaitez pousser avec repo_id (par défaut, il s'agit du nom de save_directory dans votre espace de noms).
  • kwargs (dict[str, Any], facultatif) — Arguments supplémentaires passés à la méthode push_to_hub().

Enregistrer un objet de configuration dans le répertoire spécifié dans save_directory afin qu'il puisse être rechargé à l'aide de la méthode de classe from_config().

to_json_file

< >

( json_file_path: str | os.PathLike )

Paramètres

  • json_file_path (str ou os.PathLike) — Chemin vers le fichier JSON pour enregistrer les paramètres d’une instance de configuration.

Enregistrez les paramètres de l’instance de configuration dans un fichier JSON.

to_json_string

< >

( ) → str

Retourne

str

Chaîne de caractères contenant tous les attributs qui composent l'instance de configuration au format JSON.

Sérialise l'instance de configuration en chaîne JSON.

Update on GitHub

←Lignes directrices éthiques de Diffusers Journalisation→