Update README.md

README.md

@@ -2,201 +2,70 @@
 library_name: diffusers
 ---
 
-# Model Card for Model ID
+# Paint by Inpaint: Learning to Add Image Objects by Removing Them First
 
-<!-- Provide a quick summary of what the model is/does. -->
+The model is designed for instruction-following object addition to images.
 
+We offer four different models:
+- Trained on the PIPE dataset, specifically designed for object addition.
+- The object addition model fine-tuned on a MagicBrush addition subset.
+- **Trained on the combined PIPE and InstructPix2Pix datasets, intended for general editing (This one).**
+- The general model fine-tuned on the full MagicBrush dataset.
 
 
-## Model Details
+## Resources
 
-### Model Description
+- 💻 [**Project Page**](https://rotsteinnoam.github.io/Paint-by-Inpaint/).
 
-<!-- Provide a longer summary of what this model is. -->
+- 📝 [**Read the Paper**](https://arxiv.org/abs/2404.18212).
 
-This is the model card of a 🧨 diffusers model that has been pushed on the Hub. This model card has been automatically generated.
+- 🚀 [**Try Our Demo**](https://huggingface.co/spaces/paint-by-inpaint/demo).
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- 🗂️ [**Use the PIPE Dataset**](https://huggingface.co/datasets/paint-by-inpaint/PIPE).
 
-### Model Sources [optional]
 
-<!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+#### Running the model
 
-## Uses
+The model is simple to run using the InstructPix2Pix pipeline:
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+```python
+from diffusers import StableDiffusionInstructPix2PixPipeline, EulerAncestralDiscreteScheduler
+import torch
+import requests
+from io import BytesIO
 
-### Direct Use
+model_name = "paint-by-inpaint/add-base"  # addition-base-model
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+diffusion_steps = 50
+device = "cuda"
+image_url = "https://paint-by-inpaint-demo.hf.space/file=/tmp/gradio/99cd3a15aa9bdd3220b4063ebc3ac05e07a611b8/messi.jpeg"
+image = Image.open(BytesIO(requests.get(image_url).content)).resize((512, 512))
 
-[More Information Needed]
+pipe = StableDiffusionInstructPix2PixPipeline.from_pretrained(model_name, torch_dtype=torch.float16, safety_checker=None).to(device)
+pipe.scheduler = EulerAncestralDiscreteScheduler.from_config(pipe.scheduler.config)
 
-### Downstream Use [optional]
+# Generate the modified image
+out_images = pipe(
+    "Add a royal silver crown", 
+    image=image, 
+    guidance_scale=7, 
+    image_guidance_scale=1.5, 
+    num_inference_steps=diffusion_steps,
+    num_images_per_prompt=1
+).images
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+```
 
-[More Information Needed]
 
-### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure 
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-arxiv.org/abs/2404.18212
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+## BibTeX
 
+``` Citation
+@article{wasserman2024paint,
+  title={Paint by Inpaint: Learning to Add Image Objects by Removing Them First},
+  author={Wasserman, Navve and Rotstein, Noam and Ganz, Roy and Kimmel, Ron},
+  journal={arXiv preprint arXiv:2404.18212},
+  year={2024}
+}