Buckets:
| # Configuration | |
| Les planificateurs issus de [SchedulerMixin](/docs/diffusers/main/fr/api/schedulers/overview#diffusers.SchedulerMixin) et les modèles issus de [ModelMixin](/docs/diffusers/main/fr/api/models/overview#diffusers.ModelMixin) héritent de [ConfigMixin](/docs/diffusers/main/fr/api/configuration#diffusers.ConfigMixin), qui stocke tous les paramètres transmis à leurs méthodes respectives `__init__` dans un fichier de configuration JSON. | |
| > [!TIP] | |
| > Pour utiliser des modèles privés ou [restreints](https://huggingface.co/docs/hub/models-gated#gated-models), connectez-vous avec `hf auth login`. | |
| ## ConfigMixin[[diffusers.ConfigMixin]] | |
| #### diffusers.ConfigMixin[[diffusers.ConfigMixin]] | |
| ```python | |
| diffusers.ConfigMixin() | |
| ``` | |
| [Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L87) | |
| 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()](/docs/diffusers/main/fr/api/configuration#diffusers.ConfigMixin.from_config) et [save_config()](/docs/diffusers/main/fr/api/configuration#diffusers.ConfigMixin.save_config) pour charger, télécharger et enregistrer les classes qui héritent de [ConfigMixin](/docs/diffusers/main/fr/api/configuration#diffusers.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()](/docs/diffusers/main/fr/api/configuration#diffusers.ConfigMixin.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 (doit être remplacé 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é qui sont 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[[diffusers.ConfigMixin.load_config]] | |
| ```python | |
| load_config(pretrained_model_name_or_path: str | os.PathLike, return_unused_kwargs = False, return_commit_hash = False, **kwargs) | |
| ``` | |
| [Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L322) | |
| **Paramètres :** | |
| pretrained_model_name_or_path (`str` ou `os.PathLike`, *facultatif*) : Peut être : - 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()](/docs/diffusers/main/fr/api/configuration#diffusers.ConfigMixin.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*, valeur 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 locaux. 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*, valeur par défaut `""`) : Emplacement du sous-dossier du 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*, par défaut `False) : Indique si les arguments de 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[[diffusers.ConfigMixin.from_config]] | |
| ```python | |
| from_config(config: diffusers.configuration_utils.FrozenDict | dict[str, typing.Any] = None, return_unused_kwargs = False, **kwargs) | |
| ``` | |
| [Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L221) | |
| **Paramètres :** | |
| config (`dict[str, Any]`) : Un 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 (reste du dictionnaire des 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](/docs/diffusers/main/fr/api/models/overview#diffusers.ModelMixin) ou [SchedulerMixin](/docs/diffusers/main/fr/api/schedulers/overview#diffusers.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 : | |
| ```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[[diffusers.ConfigMixin.save_config]] | |
| ```python | |
| save_config(save_directory: str | os.PathLike, push_to_hub: bool = False, **kwargs) | |
| ``` | |
| [Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L177) | |
| **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()](/docs/diffusers/main/fr/api/schedulers/overview#diffusers.utils.PushToHubMixin.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()](/docs/diffusers/main/fr/api/configuration#diffusers.ConfigMixin.from_config). | |
| #### to_json_file[[diffusers.ConfigMixin.to_json_file]] | |
| ```python | |
| to_json_file(json_file_path: str | os.PathLike) | |
| ``` | |
| [Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L647) | |
| **Paramètres :** | |
| json_file_path (`str` ou `os.PathLike`) : Chemin vers le fichier JSON pour enregistrer les paramètres d'une instance de configuration. | |
| Enregistrer les paramètres de l'instance de configuration dans un fichier JSON. | |
| #### to_json_string[[diffusers.ConfigMixin.to_json_string]] | |
| ```python | |
| to_json_string() | |
| ``` | |
| [Source](https://github.com/huggingface/diffusers/blob/main/src/diffusers/configuration_utils.py#L602) | |
| **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. | |
Xet Storage Details
- Size:
- 9.08 kB
- Xet hash:
- 16c8a93eb43467f5dd03b062b97af04db1193e7f0062f3f16108ccf1b399e2dc
·
Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.