-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Add InstructPix2Pix pipeline #2040
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
31 commits
Select commit
Hold shift + click to select a range
38cc262
being pix2pix
patil-suraj f6cea81
ifx
patil-suraj 8a84549
cfg image_latents
patil-suraj 7ae9fd5
fix some docstr
patil-suraj b805775
fix
patil-suraj 53f9eb5
fix
patil-suraj 4c6d006
hack
patil-suraj 6b84514
fix
patil-suraj f91e232
Apply suggestions from code review
patil-suraj a5bfb04
add comments to explain the hack
patil-suraj f624b3f
Merge branch 'pix2pix' of https://github.com/huggingface/diffusers in…
patil-suraj 8941296
move __call__ to the top
patil-suraj 62ee0ee
doc
patil-suraj 3c5953a
remove height and width
patil-suraj 3a01b54
remove depreications
patil-suraj 74890b0
fix doc str
patil-suraj c4ab485
quality
patil-suraj 297b8ca
fast tests
patil-suraj 61b09f0
chnage model id
patil-suraj c4b6a77
fast tests
patil-suraj db37ae2
fix test
patil-suraj c2d1088
address Pedro's comments
patil-suraj 67ba0ba
copyright
patil-suraj 0a39f9d
Simple doc page.
pcuenca 83b81a3
Apply suggestions from code review
patil-suraj 685ff5d
style
patil-suraj 93cd764
Remove import
pcuenca 16b9400
address some review comments
patil-suraj 2382a65
Merge branch 'pix2pix' of https://github.com/huggingface/diffusers in…
patil-suraj a7e8448
Apply suggestions from code review
patil-suraj 5a6e86e
style
patil-suraj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
<!--Copyright 2023 The HuggingFace Team. All rights reserved. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
the License. You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
specific language governing permissions and limitations under the License. | ||
--> | ||
|
||
# InstructPix2Pix: Learning to Follow Image Editing Instructions | ||
|
||
## Overview | ||
|
||
[InstructPix2Pix: Learning to Follow Image Editing Instructions](https://arxiv.org/abs/2211.09800) by Tim Brooks, Aleksander Holynski and Alexei A. Efros. | ||
|
||
The abstract of the paper is the following: | ||
|
||
*We propose a method for editing images from human instructions: given an input image and a written instruction that tells the model what to do, our model follows these instructions to edit the image. To obtain training data for this problem, we combine the knowledge of two large pretrained models -- a language model (GPT-3) and a text-to-image model (Stable Diffusion) -- to generate a large dataset of image editing examples. Our conditional diffusion model, InstructPix2Pix, is trained on our generated data, and generalizes to real images and user-written instructions at inference time. Since it performs edits in the forward pass and does not require per example fine-tuning or inversion, our model edits images quickly, in a matter of seconds. We show compelling editing results for a diverse collection of input images and written instructions.* | ||
|
||
Resources: | ||
|
||
* [Project Page](https://www.timothybrooks.com/instruct-pix2pix). | ||
* [Paper](https://arxiv.org/abs/2211.09800). | ||
* [Original Code](https://github.com/timothybrooks/instruct-pix2pix). | ||
* [Demo](https://huggingface.co/spaces/timbrooks/instruct-pix2pix). | ||
|
||
|
||
## Available Pipelines: | ||
|
||
| Pipeline | Tasks | Demo | ||
|---|---|:---:| | ||
| [StableDiffusionInstructPix2PixPipeline](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/stable_diffusion/pipeline_stable_diffusion_instruct_pix2pix.py) | *Text-Based Image Editing* | [🤗 Space](https://huggingface.co/spaces/timbrooks/instruct-pix2pix) | | ||
|
||
<!-- TODO: add Colab --> | ||
|
||
## Usage example | ||
|
||
```python | ||
import PIL | ||
import requests | ||
import torch | ||
from diffusers import StableDiffusionInstructPix2PixPipeline | ||
|
||
model_id = "timbrooks/instruct-pix2pix" | ||
pipe = StableDiffusionInstructPix2PixPipeline.from_pretrained( | ||
model_id, torch_dtype=torch.float16, revision="fp16", safety_checker=None | ||
).to("cuda") | ||
|
||
url = "https://raw.githubusercontent.com/timothybrooks/instruct-pix2pix/main/imgs/example.jpg" | ||
|
||
|
||
def download_image(url): | ||
image = PIL.Image.open(requests.get(url, stream=True).raw) | ||
image = PIL.ImageOps.exif_transpose(image) | ||
image = image.convert("RGB") | ||
return image | ||
|
||
|
||
image = download_image(url) | ||
|
||
prompt = "turn him into a cyborg" | ||
images = pipe(prompt, image=image, num_inference_steps=10, guidance_scale=1.1, image_guidance_scale=1).images | ||
images[0].save("david_cyborg.png") | ||
``` | ||
|
||
## StableDiffusionInstructPix2PixPipeline | ||
[[autodoc]] StableDiffusionInstructPix2PixPipeline | ||
- __call__ | ||
- all |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.