Update README.md

README.md

@@ -14,7 +14,39 @@ library_name: diffusers
 
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🧨 diffusers model that has been pushed on the Hub. This model card has been automatically generated.
+StableDiffusion3 model trained with the UltraEdit data to perform the mask-based and free-form image editing.
+
+You can get the modified verson of diffusers from the github [Page](https://github.com/HaozheZhao/UltraEdit): `cd diffusers && pip install -e .`. And then you can run:
+
+```python
+# For Editing with SD3
+import torch
+from diffusers import StableDiffusion3InstructPix2PixPipeline
+from diffusers.utils import load_image
+import requests
+import PIL.Image
+
+pipe = StableDiffusion3InstructPix2PixPipeline.from_pretrained("BleachNick/SD3_UltraEdit_w_mask", torch_dtype=torch.float16)
+pipe = pipe.to("cuda")
+prompt="What if the horse wears a hat?"
+img = load_image("input.png").resize((512, 512))
+mask_img = load_image("mask_img.png").resize(img.size)
+# For free form Editing, seed a blank mask
+# mask_img = PIL.Image.new("RGB", img.size, (255, 255, 255))
+image = pipe(
+    prompt,
+    image=img,
+    mask_img=mask_img,
+    negative_prompt="",
+    num_inference_steps=50,
+    image_guidance_scale=1.5,
+    guidance_scale=7.5,
+).images[0]
+image.save("edited_image.png")
+# display image
+
+
+```
 
 - **Developed by:** [More Information Needed]
 - **Funded by [optional]:** [More Information Needed]