Skip to content

Commit 8ccc76a

Browse files
stevhliusayakpaul
andauthored
[docs] IP-Adapter API doc (huggingface#6140)
add ip-adapter Co-authored-by: Sayak Paul <[email protected]>
1 parent c46711e commit 8ccc76a

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

docs/source/en/_toctree.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,8 @@
198198
title: Outputs
199199
title: Main Classes
200200
- sections:
201+
- local: api/loaders/ip_adapter
202+
title: IP-Adapter
201203
- local: api/loaders/lora
202204
title: LoRA
203205
- local: api/loaders/single_file
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--Copyright 2023 The HuggingFace Team. All rights reserved.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
4+
the License. You may obtain a copy of the License at
5+
6+
http://www.apache.org/licenses/LICENSE-2.0
7+
8+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
9+
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
10+
specific language governing permissions and limitations under the License.
11+
-->
12+
13+
# IP-Adapter
14+
15+
[IP-Adapter](https://hf.co/papers/2308.06721) 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. Files generated from IP-Adapter are only ~100MBs.
16+
17+
<Tip>
18+
19+
Learn how to load an IP-Adapter checkpoint and image in the [IP-Adapter](../../using-diffusers/loading_adapters#ip-adapter) loading guide.
20+
21+
</Tip>
22+
23+
## IPAdapterMixin
24+
25+
[[autodoc]] loaders.ip_adapter.IPAdapterMixin

0 commit comments

Comments
 (0)