Hugging Face's logo

Diffusers documentation

AutoModel

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

AutoModel

AutoModel recupera automáticamente la clase de modelo correcta del archivo config.json del checkpoint.

AutoModel

clase diffusers.AutoModel

< >

( *args**kwargs )

from_pretrained

< >

( pretrained_model_or_path: str | os.PathLike | None = None**kwargs )

Parámetros

  • pretrained_model_name_or_path (str o os.PathLike, opcional) — Puede ser:
    • Una cadena de texto, el model id (por ejemplo, google/ddpm-celebahq-256) de un modelo preentrenado alojado en el Hub.
    • Una ruta a un directorio (por ejemplo, ./my_model_directory) que contiene los pesos del modelo guardados con save_pretrained().
  • cache_dir (str | os.PathLike, opcional) — Ruta a un directorio donde se almacena en caché la configuración de un modelo preentrenado descargado si no se utiliza la caché estándar.
  • dtype (torch.dtype, opcional) — Sobrescribe el torch.dtype predeterminado y carga el modelo con otro dtype.
  • force_download (bool, opcional, valor predeterminado False) — Indica si se debe forzar la (re)descarga de los pesos del modelo y los archivos de configuración, ignorando las versiones en caché si existen.
  • proxies (dict[str, str], opcional) — Un diccionario de servidores proxy a utilizar por protocolo o punto de acceso, por ejemplo, {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Los proxies se utilizan en cada solicitud.
  • output_loading_info (bool, opcional, valor predeterminado False) — Indica si se debe devolver también un diccionario que contenga las claves faltantes, las claves inesperadas y los mensajes de error.
  • local_files_only(bool, opcional, valor predeterminado False) — Indica si se deben cargar únicamente los pesos y archivos de configuración del modelo locales. Si se establece en True, el modelo no se descargará desde el Hub.
  • token (str o bool, opcional) — El token que se usará como autorización HTTP bearer para los archivos remotos. Si True, se utiliza el token generado desde diffusers-cli login (almacenado en ~/.huggingface).
  • revision (str, opcional, valor predeterminado "main") — La versión específica del modelo que se va a utilizar. Puede ser el nombre de una rama, el nombre de una etiqueta, un id de commit o cualquier identificador permitido por Git.
  • subfolder (str, opcional, por defecto "") — La ubicación de la subcarpeta de un archivo de modelo dentro de un repositorio de modelos más grande en el Hub o localmente.
  • mirror (str, opcional) — Origen de espejo para resolver problemas de accesibilidad si estás descargando un modelo en China. No garantizamos la oportunidad ni la seguridad de la fuente, y debes consultar el sitio del espejo para obtener más información.
  • device_map (str o dict[str, int | str | torch.device], opcional) — Un mapa que especifica dónde debe ir cada submódulo. No es necesario definirlo para cada nombre de parámetro/buffer; una vez que un nombre de módulo dado está incluido, todos sus submódulos se enviarán al mismo dispositivo. El valor predeterminado es None, lo que significa que el modelo se cargará en la CPU.

    Establezca device_map="auto" para que 🤗 Accelerate calcule automáticamente el device_map más optimizado. Para obtener más información sobre cada opción, consulte el diseño de un mapa de dispositivos.

  • max_memory (Dict, opcional) — Un diccionario con el identificador de dispositivo para la memoria máxima. Si no se establece, se usará la memoria máxima disponible para cada GPU y la RAM de CPU disponible.
  • offload_folder (str o os.PathLike, opcional) — La ruta para descargar los pesos si device_map contiene el valor "disk".
  • offload_state_dict (bool, opcional) — Si es True, descarga temporalmente el state dict de CPU al disco duro para evitar quedarse sin RAM de CPU si el peso del state dict de CPU + el shard más grande del checkpoint no cabe. El valor predeterminado es True cuando hay alguna descarga a disco.
  • low_cpu_mem_usage (bool, opcional, por defecto True si la versión de torch >= 1.9.0, en caso contrario False) — Acelera la carga del modelo cargando solo los pesos preentrenados y sin inicializar los pesos. Esto también intenta no usar más de 1x el tamaño del modelo en memoria de CPU (incluida la memoria pico) durante la carga del modelo. Solo compatible con PyTorch >= 1.9.0. Si estás usando una versión anterior de PyTorch, establecer este argumento en True generará un error.
  • variant (str, opcional) — Carga los pesos desde un nombre de archivo variant especificado, como "fp16" o "ema".
  • use_safetensors (bool, opcional, valor predeterminado None) — Si se establece en None, se descargan los pesos de safetensors si están disponibles y si la biblioteca safetensors está instalada. Si se establece en True, el modelo se carga forzosamente desde los pesos de safetensors. Si se establece en False, no se cargan los pesos de safetensors.
  • disable_mmap (‘bool’, opcional, valor predeterminado ‘False’) — Si se deshabilita mmap al cargar un modelo de Safetensors. Esta opción puede ofrecer un mejor rendimiento cuando el modelo está en una unidad de red o en un disco duro, que pueden no manejar bien la naturaleza de búsquedas aleatorias de mmap.
  • trust_remote_cocde (bool, opcional, valor predeterminado False) — Si se debe confiar en el código remoto

Instanciar un modelo de PyTorch preentrenado a partir de una configuración de modelo preentrenado.

El modelo se configura en modo de evaluación - model.eval() - de forma predeterminada, y los módulos de dropout se desactivan. Para entrenar el modelo, devuélvalo al modo de entrenamiento con model.train().

> Para usar modelos privados o con acceso restringido, inicie sesión con hf > auth login. También puede activar el modo especial > “offline-mode” para usar este método en un > entorno con cortafuegos.

Ejemplo:

from diffusers import AutoModel

unet = AutoModel.from_pretrained("stable-diffusion-v1-5/stable-diffusion-v1-5", subfolder="unet")

Si obtienes el siguiente mensaje de error, necesitas ajustar los pesos para tu tarea de destino:

Some weights of UNet2DConditionModel were not initialized from the model checkpoint at stable-diffusion-v1-5/stable-diffusion-v1-5 and are newly initialized because the shapes did not match:
- conv_in.weight: found shape torch.Size([320, 4, 3, 3]) in the checkpoint and torch.Size([320, 9, 3, 3]) in the model instantiated
You should probably TRAIN this model on a down-stream task to be able to use it for predictions and inference.

from_config

< >

( pretrained_model_name_or_path_or_dict: str | os.PathLike | dict | None = None**kwargs )

Parámetros

  • pretrained_model_name_or_path_or_dict (str, os.PathLike, o dict) — Puede ser:
    • Una cadena de texto, el model id (por ejemplo, google/ddpm-celebahq-256) de una configuración de modelo preentrenado alojada en el Hub.
    • Una ruta a un directorio (por ejemplo, ./my_model_directory) que contiene un archivo de configuración del modelo.
    • Un diccionario de configuración.
  • cache_dir (Union[str, os.PathLike], opcional) — Ruta a un directorio donde se almacena en caché la configuración de un modelo preentrenado descargado si no se utiliza la caché estándar.
  • force_download (bool, opcional, valor predeterminado False) — Indica si se debe forzar la (re)descarga de la configuración del modelo, reemplazando la versión en caché si existe.
  • proxies (Dict[str, str], opcional) — Un diccionario de servidores proxy a utilizar por protocolo o punto de conexión.
  • local_files_only(bool, opcional, valor predeterminado False) — Indica si se deben cargar únicamente los archivos de configuración del modelo locales.
  • token (str o bool, opcional) — El token que se usará como autorización HTTP bearer para los archivos remotos.
  • revision (str, opcional, valor predeterminado "main") — La versión específica del modelo que se va a utilizar.
  • trust_remote_code (bool, opcional, valor predeterminado False) — Si se confía en el código remoto.
  • subfolder (str, opcional, por defecto "") — La ubicación de la subcarpeta de un archivo de modelo dentro de un repositorio de modelos más grande en el Hub o localmente.

Instanciar un modelo a partir de un diccionario de configuración o de un archivo de configuración de un modelo preentrenado con pesos aleatorios (no se cargan pesos preentrenados).

Ejemplo:

from diffusers import AutoModel

model = AutoModel.from_config("stable-diffusion-v1-5/stable-diffusion-v1-5", subfolder="unet")
Update on GitHub

←Resumen ControlNetModel→