IP-Adapter¶
IP-Adapter is a lightweight adapter that enables prompting a diffusion model with an image. This method decouples the cross-attention layers of the image and text features. The image features are generated from an image encoder.
Tip
Learn how to load an IP-Adapter checkpoint and image in the IP-Adapter loading guide, and you can see how to use it in the usage guide.
mindone.diffusers.loaders.ip_adapter.IPAdapterMixin
¶
Mixin for handling IP Adapters.
Source code in mindone/diffusers/loaders/ip_adapter.py
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
|
mindone.diffusers.loaders.ip_adapter.IPAdapterMixin.load_ip_adapter(pretrained_model_name_or_path_or_dict, subfolder, weight_name, image_encoder_folder='image_encoder', **kwargs)
¶
PARAMETER | DESCRIPTION |
---|---|
pretrained_model_name_or_path_or_dict |
Can be either:
TYPE:
|
subfolder |
The subfolder location of a model file within a larger model repository on the Hub or locally. If a
list is passed, it should have the same length as
TYPE:
|
weight_name |
The name of the weight file to load. If a list is passed, it should have the same length as
TYPE:
|
image_encoder_folder |
The subfolder location of the image encoder within a larger model repository on the Hub or locally.
Pass
TYPE:
|
cache_dir |
Path to a directory where a downloaded pretrained model configuration is cached if the standard cache is not used.
TYPE:
|
force_download |
Whether or not to force the (re-)download of the model weights and configuration files, overriding the cached versions if they exist.
TYPE:
|
proxies |
A dictionary of proxy servers to use by protocol or endpoint, for example,
TYPE:
|
local_files_only |
Whether to only load local model weights and configuration files or not. If set to
TYPE:
|
token |
The token to use as HTTP bearer authorization for remote files. If
TYPE:
|
revision |
The specific model version to use. It can be a branch name, a tag name, a commit id, or any identifier allowed by Git.
TYPE:
|
Source code in mindone/diffusers/loaders/ip_adapter.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
|
mindone.diffusers.loaders.ip_adapter.IPAdapterMixin.set_ip_adapter_scale(scale)
¶
Set IP-Adapter scales per-transformer block. Input scale
could be a single config or a list of configs for
granular control over each IP-Adapter behavior. A config can be a float or a dictionary.
Example:
# To use original IP-Adapter
scale = 1.0
pipeline.set_ip_adapter_scale(scale)
# To use style block only
scale = {
"up": {"block_0": [0.0, 1.0, 0.0]},
}
pipeline.set_ip_adapter_scale(scale)
# To use style+layout blocks
scale = {
"down": {"block_2": [0.0, 1.0]},
"up": {"block_0": [0.0, 1.0, 0.0]},
}
pipeline.set_ip_adapter_scale(scale)
# To use style and layout from 2 reference images
scales = [{"down": {"block_2": [0.0, 1.0]}}, {"up": {"block_0": [0.0, 1.0, 0.0]}}]
pipeline.set_ip_adapter_scale(scales)
Source code in mindone/diffusers/loaders/ip_adapter.py
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
|
mindone.diffusers.loaders.ip_adapter.IPAdapterMixin.unload_ip_adapter()
¶
Unloads the IP Adapter weights
Examples:
>>> # Assuming `pipeline` is already loaded with the IP Adapter weights.
>>> pipeline.unload_ip_adapter()
>>> ...
Source code in mindone/diffusers/loaders/ip_adapter.py
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
|
mindone.diffusers.image_processor.IPAdapterMaskProcessor
¶
Bases: VaeImageProcessor
Image processor for IP Adapter image masks.
PARAMETER | DESCRIPTION |
---|---|
do_resize |
Whether to downscale the image's (height, width) dimensions to multiples of
TYPE:
|
vae_scale_factor |
VAE scale factor. If
TYPE:
|
resample |
Resampling filter to use when resizing the image.
TYPE:
|
do_normalize |
Whether to normalize the image to [-1,1].
TYPE:
|
do_binarize |
Whether to binarize the image to 0/1.
TYPE:
|
do_convert_grayscale |
Whether to convert the images to grayscale format.
TYPE:
|
Source code in mindone/diffusers/image_processor.py
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 |
|
mindone.diffusers.image_processor.IPAdapterMaskProcessor.downsample(mask, batch_size, num_queries, value_embed_dim)
staticmethod
¶
Downsamples the provided mask tensor to match the expected dimensions for scaled dot-product attention. If the aspect ratio of the mask does not match the aspect ratio of the output image, a warning is issued.
PARAMETER | DESCRIPTION |
---|---|
mask |
The input mask tensor generated with
TYPE:
|
batch_size |
The batch size.
TYPE:
|
num_queries |
The number of queries.
TYPE:
|
value_embed_dim |
The dimensionality of the value embeddings.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
|
Source code in mindone/diffusers/image_processor.py
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 |
|