Adapters (textual inversion, LoRA, hypernetworks) allow you to modify a diffusion model to generate images in a specific style without training or finetuning the entire model. The adapter weights are typically only a tiny fraction of the pretrained model’s which making them very portable. 🤗 Diffusers provides an easy-to-use LoaderMixin
API to load adapter weights.
🧪 The LoaderMixins
are highly experimental and prone to future changes. To use private or gated models, log-in with huggingface-cli login
.
Disables the active LoRA layers for the unet.
Enables the active LoRA layers for the unet.
( pretrained_model_name_or_path_or_dict: typing.Union[str, typing.Dict[str, torch.Tensor]] **kwargs )
Parameters
str
or os.PathLike
or dict
) —
Can be either:
google/ddpm-celebahq-256
) of a pretrained model hosted on
the Hub../my_model_directory
) containing the model weights saved
with ModelMixin.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. 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. bool
, optional, defaults to False
) —
Whether or not to resume downloading the model weights and configuration files. If set to False
, any
incompletely downloaded files are deleted. 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 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. 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, 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. 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. Load pretrained attention processor layers into UNet2DConditionModel. Attention processor layers have to be
defined in
attention_processor.py
and be a torch.nn.Module
class.
( save_directory: typing.Union[str, os.PathLike] is_main_process: bool = True weight_name: str = None save_function: typing.Callable = None safe_serialization: bool = True **kwargs )
Parameters
str
or os.PathLike
) —
Directory to save an attention processor to. Will be created if it doesn’t exist. bool
, optional, defaults to True
) —
Whether the process calling this is the main process or not. Useful during distributed training and you
need to call this function on all processes. In this case, set is_main_process=True
only on the main
process to avoid race conditions. Callable
) —
The function to use to save the state dictionary. Useful during distributed training when you need to
replace torch.save
with another method. Can be configured with the environment variable
DIFFUSERS_SAVE_MODE
. bool
, optional, defaults to True
) —
Whether to save the model using safetensors
or the traditional PyTorch way with pickle
. Save an attention processor to a directory so that it can be reloaded using the load_attn_procs() method.
( adapter_names: typing.Union[typing.List[str], str] weights: typing.Union[typing.List[float], float, NoneType] = None )
Sets the adapter layers for the unet.
Load textual inversion tokens and embeddings to the tokenizer and text encoder.
( pretrained_model_name_or_path: typing.Union[str, typing.List[str], typing.Dict[str, torch.Tensor], typing.List[typing.Dict[str, torch.Tensor]]] token: typing.Union[str, typing.List[str], NoneType] = None tokenizer: typing.Optional[ForwardRef('PreTrainedTokenizer')] = None text_encoder: typing.Optional[ForwardRef('PreTrainedModel')] = None **kwargs )
Parameters
str
or os.PathLike
or List[str or os.PathLike]
or Dict
or List[Dict]
) —
Can be either one of the following or a list of them:
sd-concepts-library/low-poly-hd-logos-icons
) of a
pretrained model hosted on the Hub../my_text_inversion_directory/
) containing the textual
inversion weights../my_text_inversions.pt
) containing textual inversion weights.str
or List[str]
, optional) —
Override the token to use for the textual inversion weights. If pretrained_model_name_or_path
is a
list, then token
must also be a list of equal length. CLIPTokenizer
to tokenize text. If not specified, function will take self.tokenizer. str
, optional) —
Name of a custom weight file. This should be used when:
text_inv.bin
.Union[str, os.PathLike]
, optional) —
Path to a directory where a downloaded pretrained model configuration is cached if the standard cache
is not used. 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. bool
, optional, defaults to False
) —
Whether or not to resume downloading the model weights and configuration files. If set to False
, any
incompletely downloaded files are deleted. 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 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. 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. Load textual inversion embeddings into the text encoder of StableDiffusionPipeline (both 🤗 Diffusers and Automatic1111 formats are supported).
Example:
To load a textual inversion embedding vector in 🤗 Diffusers format:
from diffusers import StableDiffusionPipeline
import torch
model_id = "runwayml/stable-diffusion-v1-5"
pipe = StableDiffusionPipeline.from_pretrained(model_id, torch_dtype=torch.float16).to("cuda")
pipe.load_textual_inversion("sd-concepts-library/cat-toy")
prompt = "A <cat-toy> backpack"
image = pipe(prompt, num_inference_steps=50).images[0]
image.save("cat-backpack.png")
To load a textual inversion embedding vector in Automatic1111 format, make sure to download the vector first (for example from civitAI) and then load the vector
locally:
from diffusers import StableDiffusionPipeline
import torch
model_id = "runwayml/stable-diffusion-v1-5"
pipe = StableDiffusionPipeline.from_pretrained(model_id, torch_dtype=torch.float16).to("cuda")
pipe.load_textual_inversion("./charturnerv2.pt", token="charturnerv2")
prompt = "charturnerv2, multiple views of the same character in the same outfit, a character turnaround of a woman wearing a black jacket and red shirt, best quality, intricate details."
image = pipe(prompt, num_inference_steps=50).images[0]
image.save("character.png")
( prompt: typing.Union[str, typing.List[str]] tokenizer: PreTrainedTokenizer ) → str
or list of str
Processes prompts that include a special token corresponding to a multi-vector textual inversion embedding to be replaced with multiple special tokens each corresponding to one of the vectors. If the prompt has no textual inversion token or if the textual inversion token is a single vector, the input prompt is returned.
This class overrides LoraLoaderMixin
with LoRA loading/saving code that’s specific to SDXL
( pretrained_model_name_or_path_or_dict: typing.Union[str, typing.Dict[str, torch.Tensor]] adapter_name: typing.Optional[str] = None **kwargs )
Parameters
str
or os.PathLike
or dict
) —
See lora_state_dict(). str
, optional) —
Adapter name to be used for referencing the loaded adapter model. If not specified, it will use
default_{i}
where i is the total number of adapters being loaded. dict
, optional) —
See lora_state_dict(). Load LoRA weights specified in pretrained_model_name_or_path_or_dict
into self.unet
and
self.text_encoder
.
All kwargs are forwarded to self.lora_state_dict
.
See lora_state_dict() for more details on how the state dict is loaded.
See load_lora_into_unet() for more details on how the state dict is loaded into
self.unet
.
See load_lora_into_text_encoder() for more details on how the state dict is loaded
into self.text_encoder
.
Load LoRA layers into UNet2DConditionModel and
CLIPTextModel
.
( text_encoder: typing.Optional[transformers.modeling_utils.PreTrainedModel] = None )
Disables the LoRA layers for the text encoder.
( text_encoder: typing.Optional[transformers.modeling_utils.PreTrainedModel] = None )
Enables the LoRA layers for the text encoder.
( fuse_unet: bool = True fuse_text_encoder: bool = True lora_scale: float = 1.0 safe_fusing: bool = False )
Parameters
bool
, defaults to True
) — Whether to fuse the UNet LoRA parameters. bool
, defaults to True
) —
Whether to fuse the text encoder LoRA parameters. If the text encoder wasn’t monkey-patched with the
LoRA parameters then it won’t have any effect. float
, defaults to 1.0) —
Controls how much to influence the outputs with the LoRA parameters. bool
, defaults to False
) —
Whether to check fused weights for NaN values before fusing and if values are NaN not fusing them. Fuses the LoRA parameters into the original parameters of the corresponding blocks.
This is an experimental API.
Gets the list of the current active adapters.
Gets the current list of all available adapters in the pipeline.
( state_dict network_alphas text_encoder prefix = None lora_scale = 1.0 low_cpu_mem_usage = None adapter_name = None _pipeline = None )
Parameters
dict
) —
A standard state dict containing the lora layer parameters. The key should be prefixed with an
additional text_encoder
to distinguish between unet lora layers. Dict[str, float]
) —
See LoRALinearLayer
for more details. CLIPTextModel
) —
The text encoder model to load the LoRA layers into. str
) —
Expected prefix of the text_encoder
in the state_dict
. float
) —
How much to scale the output of the lora linear layer before it is added with the output of the regular
lora layer. 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) —
Adapter name to be used for referencing the loaded adapter model. If not specified, it will use
default_{i}
where i is the total number of adapters being loaded. This will load the LoRA layers specified in state_dict
into text_encoder
( state_dict network_alphas unet low_cpu_mem_usage = None adapter_name = None _pipeline = None )
Parameters
dict
) —
A standard state dict containing the lora layer parameters. The keys can either be indexed directly
into the unet or prefixed with an additional unet
which can be used to distinguish between text
encoder lora layers. Dict[str, float]
) —
See LoRALinearLayer
for more details. UNet2DConditionModel
) —
The UNet model to load the LoRA layers into. 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) —
Adapter name to be used for referencing the loaded adapter model. If not specified, it will use
default_{i}
where i is the total number of adapters being loaded. This will load the LoRA layers specified in state_dict
into unet
.
( pretrained_model_name_or_path_or_dict: typing.Union[str, typing.Dict[str, torch.Tensor]] adapter_name = None **kwargs )
Parameters
str
or os.PathLike
or dict
) —
See lora_state_dict(). dict
, optional) —
See lora_state_dict(). str
, optional) —
Adapter name to be used for referencing the loaded adapter model. If not specified, it will use
default_{i}
where i is the total number of adapters being loaded. Load LoRA weights specified in pretrained_model_name_or_path_or_dict
into self.unet
and
self.text_encoder
.
All kwargs are forwarded to self.lora_state_dict
.
See lora_state_dict() for more details on how the state dict is loaded.
See load_lora_into_unet() for more details on how the state dict is loaded into
self.unet
.
See load_lora_into_text_encoder() for more details on how the state dict is loaded
into self.text_encoder
.
( pretrained_model_name_or_path_or_dict: typing.Union[str, typing.Dict[str, torch.Tensor]] **kwargs )
Parameters
str
or os.PathLike
or dict
) —
Can be either:
google/ddpm-celebahq-256
) of a pretrained model hosted on
the Hub../my_model_directory
) containing the model weights saved
with ModelMixin.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. 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. bool
, optional, defaults to False
) —
Whether or not to resume downloading the model weights and configuration files. If set to False
, any
incompletely downloaded files are deleted. 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 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. str
, optional, defaults to ""
) —
The subfolder location of a model file within a larger model repository on the Hub or locally. 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) —
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. Return state dict for lora weights and the network alphas.
We support loading A1111 formatted LoRA checkpoints in a limited capacity.
This function is experimental and might change in the future.
( save_directory: typing.Union[str, os.PathLike] unet_lora_layers: typing.Dict[str, typing.Union[torch.nn.modules.module.Module, torch.Tensor]] = None text_encoder_lora_layers: typing.Dict[str, torch.nn.modules.module.Module] = None is_main_process: bool = True weight_name: str = None save_function: typing.Callable = None safe_serialization: bool = True )
Parameters
str
or os.PathLike
) —
Directory to save LoRA parameters to. Will be created if it doesn’t exist. Dict[str, torch.nn.Module]
or Dict[str, torch.Tensor]
) —
State dict of the LoRA layers corresponding to the unet
. Dict[str, torch.nn.Module]
or Dict[str, torch.Tensor]
) —
State dict of the LoRA layers corresponding to the text_encoder
. Must explicitly pass the text
encoder LoRA state dict because it comes from 🤗 Transformers. bool
, optional, defaults to True
) —
Whether the process calling this is the main process or not. Useful during distributed training and you
need to call this function on all processes. In this case, set is_main_process=True
only on the main
process to avoid race conditions. Callable
) —
The function to use to save the state dictionary. Useful during distributed training when you need to
replace torch.save
with another method. Can be configured with the environment variable
DIFFUSERS_SAVE_MODE
. bool
, optional, defaults to True
) —
Whether to save the model using safetensors
or the traditional PyTorch way with pickle
. Save the LoRA parameters corresponding to the UNet and text encoder.
( adapter_names: typing.Union[typing.List[str], str] text_encoder: typing.Optional[transformers.modeling_utils.PreTrainedModel] = None text_encoder_weights: typing.List[float] = None )
Parameters
List[str]
or str
) —
The names of the adapters to use. torch.nn.Module
, optional) —
The text encoder module to set the adapter layers for. If None
, it will try to get the text_encoder
attribute. List[float]
, optional) —
The weights to use for the text encoder. If None
, the weights are set to 1.0
for all the adapters. Sets the adapter layers for the text encoder.
( adapter_names: typing.List[str] device: typing.Union[torch.device, str, int] )
Moves the LoRAs listed in adapter_names
to a target device. Useful for offloading the LoRA to the CPU in case
you want to load multiple adapters and free some GPU memory.
( unfuse_unet: bool = True unfuse_text_encoder: bool = True )
Reverses the effect of
pipe.fuse_lora()
.
This is an experimental API.
Unloads the LoRA parameters.
Load model weights saved in the .ckpt
format into a DiffusionPipeline.
( pretrained_model_link_or_path **kwargs )
Parameters
str
or os.PathLike
, optional) —
Can be either:.ckpt
file (for example
"https://huggingface.co/<repo_id>/blob/main/<path_to_file>.ckpt"
) on the Hub.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. Union[str, os.PathLike]
, optional) —
Path to a directory where a downloaded pretrained model configuration is cached if the standard cache
is not used. bool
, optional, defaults to False
) —
Whether or not to resume downloading the model weights and configuration files. If set to False
, any
incompletely downloaded files are deleted. 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 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 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. bool
, optional, defaults to False
) —
Whether to extract the EMA weights or not. Pass True
to extract the EMA weights which usually yield
higher quality images for inference. Non-EMA weights are usually better for continuing finetuning. bool
, optional, defaults to None
) —
Whether the attention computation should always be upcasted. int
, optional, defaults to 512) —
The image size the model was trained on. Use 512 for all Stable Diffusion v1 models and the Stable
Diffusion v2 base model. Use 768 for Stable Diffusion v2. str
, optional) —
The prediction type the model was trained on. Use 'epsilon'
for all Stable Diffusion v1 models and
the Stable Diffusion v2 base model. Use 'v_prediction'
for Stable Diffusion v2. int
, optional, defaults to None
) —
The number of input channels. If None
, it is automatically inferred. str
, optional, defaults to "pndm"
) —
Type of scheduler to use. Should be one of ["pndm", "lms", "heun", "euler", "euler-ancestral", "dpm", "ddim"]
. bool
, optional, defaults to True
) —
Whether to load the safety checker or not. None
) —
An instance of CLIPTextModel
to use, specifically the
clip-vit-large-patch14 variant. If this
parameter is None
, the function loads a new instance of CLIPTextModel
by itself if needed. AutoencoderKL
, optional, defaults to None
) —
Variational Auto-Encoder (VAE) Model to encode and decode images to and from latent representations. If
this parameter is None
, the function will load a new instance of [CLIP] by itself, if needed. None
) —
An instance of CLIPTokenizer
to use. If this parameter is None
, the function loads a new instance
of CLIPTokenizer
by itself if needed. str
) —
Path to .yaml
config file corresponding to the original architecture. If None
, will be
automatically inferred by looking for a key that only exists in SD2.0 models. __init__
method. See example below for more information. Instantiate a DiffusionPipeline from pretrained pipeline weights saved in the .ckpt
or .safetensors
format. The pipeline is set in evaluation mode (model.eval()
) by default.
Examples:
>>> from diffusers import StableDiffusionPipeline
>>> # Download pipeline from huggingface.co and cache.
>>> pipeline = StableDiffusionPipeline.from_single_file(
... "https://huggingface.co/WarriorMama777/OrangeMixs/blob/main/Models/AbyssOrangeMix/AbyssOrangeMix.safetensors"
... )
>>> # Download pipeline from local file
>>> # file is downloaded under ./v1-5-pruned-emaonly.ckpt
>>> pipeline = StableDiffusionPipeline.from_single_file("./v1-5-pruned-emaonly")
>>> # Enable float16 and move to GPU
>>> pipeline = StableDiffusionPipeline.from_single_file(
... "https://huggingface.co/runwayml/stable-diffusion-v1-5/blob/main/v1-5-pruned-emaonly.ckpt",
... torch_dtype=torch.float16,
... )
>>> pipeline.to("cuda")
( pretrained_model_link_or_path **kwargs )
Parameters
str
or os.PathLike
, optional) —
Can be either:.ckpt
file (for example
"https://huggingface.co/<repo_id>/blob/main/<path_to_file>.ckpt"
) on the Hub.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. Union[str, os.PathLike]
, optional) —
Path to a directory where a downloaded pretrained model configuration is cached if the standard cache
is not used. bool
, optional, defaults to False
) —
Whether or not to resume downloading the model weights and configuration files. If set to False
, any
incompletely downloaded files are deleted. 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 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 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. int
, optional, defaults to 512) —
The image size the model was trained on. Use 512 for all Stable Diffusion v1 models and the Stable
Diffusion v2 base model. Use 768 for Stable Diffusion v2. bool
, optional, defaults to None
) —
Whether the attention computation should always be upcasted. __init__
method. See example below for more information. Instantiate a ControlNetModel from pretrained controlnet weights saved in the original .ckpt
or
.safetensors
format. The pipeline is set in evaluation mode (model.eval()
) by default.
Examples:
from diffusers import StableDiffusionControlnetPipeline, ControlNetModel
url = "https://huggingface.co/lllyasviel/ControlNet-v1-1/blob/main/control_v11p_sd15_canny.pth" # can also be a local path
model = ControlNetModel.from_single_file(url)
url = "https://huggingface.co/runwayml/stable-diffusion-v1-5/blob/main/v1-5-pruned.safetensors" # can also be a local path
pipe = StableDiffusionControlnetPipeline.from_single_file(url, controlnet=controlnet)
( pretrained_model_link_or_path **kwargs )
Parameters
str
or os.PathLike
, optional) —
Can be either:.ckpt
file (for example
"https://huggingface.co/<repo_id>/blob/main/<path_to_file>.ckpt"
) on the Hub.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. Union[str, os.PathLike]
, optional) —
Path to a directory where a downloaded pretrained model configuration is cached if the standard cache
is not used. bool
, optional, defaults to False
) —
Whether or not to resume downloading the model weights and configuration files. If set to False
, any
incompletely downloaded files are deleted. 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 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. int
, optional, defaults to 512) —
The image size the model was trained on. Use 512 for all Stable Diffusion v1 models and the Stable
Diffusion v2 base model. Use 768 for Stable Diffusion v2. 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. bool
, optional, defaults to None
) —
Whether the attention computation should always be upcasted. float
, optional, defaults to 0.18215) —
The component-wise standard deviation of the trained latent space computed using the first batch of the
training set. This is used to scale the latent space to have unit variance when training the diffusion
model. The latents are scaled with the formula z = z * scaling_factor
before being passed to the
diffusion model. When decoding, the latents are scaled back to the original scale with the formula: z = 1 / scaling_factor * z
. For more details, refer to sections 4.3.2 and D.1 of the High-Resolution
Image Synthesis with Latent Diffusion Models paper. __init__
method. See example below for more information. Instantiate a AutoencoderKL from pretrained controlnet weights saved in the original .ckpt
or
.safetensors
format. The pipeline is format. The pipeline is set in evaluation mode (model.eval()
) by
default.
Make sure to pass both image_size
and scaling_factor
to from_single_file()
if you want to load
a VAE that does accompany a stable diffusion model of v2 or higher or SDXL.