The AutoModel
is designed to make it easy to load a checkpoint without needing to know the specific model class. AutoModel
automatically retrieves the correct model class from the checkpoint config.json
file.
from diffusers import AutoModel, AutoPipelineForText2Image
unet = AutoModel.from_pretrained("stable-diffusion-v1-5/stable-diffusion-v1-5", subfolder="unet")
pipe = AutoPipelineForText2Image.from_pretrained("stable-diffusion-v1-5/stable-diffusion-v1-5", unet=unet)
( pretrained_model_or_path: typing.Union[str, os.PathLike, NoneType] = None **kwargs )
Parameters
str
or os.PathLike
, optional) —
Can be either:
google/ddpm-celebahq-256
) of a pretrained model hosted on
the Hub../my_model_directory
) containing the model weights saved
with save_pretrained().Union[str, os.PathLike]
, optional) —
Path to a directory where a downloaded pretrained model configuration is cached if the standard cache
is not used. str
or torch.dtype
, optional) —
Override the default torch.dtype
and load the model with another dtype. If "auto"
is passed, the
dtype is automatically derived from the model’s weights. bool
, optional, defaults to False
) —
Whether or not to force the (re-)download of the model weights and configuration files, overriding the
cached versions if they exist. Dict[str, str]
, optional) —
A dictionary of proxy servers to use by protocol or endpoint, for example, {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}
. The proxies are used on each request. bool
, optional, defaults to False
) —
Whether or not to also return a dictionary containing missing keys, unexpected keys and error messages. bool
, optional, defaults to False
) —
Whether to only load local model weights and configuration files or not. If set to True
, the model
won’t be downloaded from the Hub. str
or bool, optional) —
The token to use as HTTP bearer authorization for remote files. If True
, the token generated from
diffusers-cli login
(stored in ~/.huggingface
) is used. str
, optional, defaults to "main"
) —
The specific model version to use. It can be a branch name, a tag name, a commit id, or any identifier
allowed by Git. bool
, optional, defaults to False
) —
Load the model weights from a Flax checkpoint save file. str
, optional, defaults to ""
) —
The subfolder location of a model file within a larger model repository on the Hub or locally. str
, optional) —
Mirror source to resolve accessibility issues if you’re downloading a model in China. We do not
guarantee the timeliness or safety of the source, and you should refer to the mirror site for more
information. str
or Dict[str, Union[int, str, torch.device]]
, optional) —
A map that specifies where each submodule should go. It doesn’t need to be defined for each
parameter/buffer name; once a given module name is inside, every submodule of it will be sent to the
same device. Defaults to None
, meaning that the model will be loaded on CPU.
Set device_map="auto"
to have 🤗 Accelerate automatically compute the most optimized device_map
. For
more information about each option see designing a device
map.
Dict
, optional) —
A dictionary device identifier for the maximum memory. Will default to the maximum memory available for
each GPU and the available CPU RAM if unset. str
or os.PathLike
, optional) —
The path to offload weights if device_map
contains the value "disk"
. bool
, optional) —
If True
, temporarily offloads the CPU state dict to the hard drive to avoid running out of CPU RAM if
the weight of the CPU state dict + the biggest shard of the checkpoint does not fit. Defaults to True
when there is some disk offload. bool
, optional, defaults to True
if torch version >= 1.9.0 else False
) —
Speed up model loading only loading the pretrained weights and not initializing the weights. This also
tries to not use more than 1x model size in CPU memory (including peak memory) while loading the model.
Only supported for PyTorch >= 1.9.0. If you are using an older version of PyTorch, setting this
argument to True
will raise an error. str
, optional) —
Load weights from a specified variant
filename such as "fp16"
or "ema"
. This is ignored when
loading from_flax
. bool
, optional, defaults to None
) —
If set to None
, the safetensors
weights are downloaded if they’re available and if the
safetensors
library is installed. If set to True
, the model is forcibly loaded from safetensors
weights. If set to False
, safetensors
weights are not loaded. Instantiate a pretrained PyTorch model from a pretrained model configuration.
The model is set in evaluation mode - model.eval()
- by default, and dropout modules are deactivated. To
train the model, set it back in training mode with model.train()
.
To use private or gated models, log-in with
huggingface-cli login
. You can also activate the special
“offline-mode” to use this method in a
firewalled environment.
Example:
from diffusers import AutoModel
unet = AutoModel.from_pretrained("runwayml/stable-diffusion-v1-5", subfolder="unet")
If you get the error message below, you need to finetune the weights for your downstream task:
Some weights of UNet2DConditionModel were not initialized from the model checkpoint at runwayml/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.