Update README.md

README.md

@@ -1,5 +1,74 @@
----
-license: other
-license_name: no-commercial
-license_link: https://github.com/River-Zhang/ICEdit/blob/main/LICENSE
----
+---
+license: other
+license_name: no-commercial
+license_link: https://github.com/River-Zhang/ICEdit/blob/main/LICENSE
+datasets:
+- osunlp/MagicBrush
+- TIGER-Lab/OmniEdit-Filtered-1.2M
+language:
+- en
+base_model:
+- black-forest-labs/FLUX.1-Fill-dev
+pipeline_tag: image-to-image
+library_name: diffusers
+tags:
+- art
+---
+<div align="center">
+
+<h1>In-Context Edit: Enabling Instructional Image Editing with In-Context Generation in Large Scale Diffusion Transformer</h1>
+
+<div>
+    <a href="https://river-zhang.github.io/zechuanzhang//" target="_blank">Zechuan Zhang</a>&emsp;
+    <a href="https://horizonwind2004.github.io/" target="_blank">Ji Xie</a>&emsp;
+    <a href="https://yulu.net.cn/" target="_blank">Yu Lu</a>&emsp;
+    <a href="https://z-x-yang.github.io/" target="_blank">Zongxin Yang</a>&emsp;
+    <a href="https://scholar.google.com/citations?user=RMSuNFwAAAAJ&hl=zh-CN&oi=ao" target="_blank">Yi Yang✉</a>&emsp;
+</div>
+<div>
+    ReLER, CCAI, Zhejiang University; Harvard University
+</div>
+<div>
+     <sup>✉</sup>Corresponding Author
+</div>
+<div>
+    <a href="https://arxiv.org/abs/2504.20690" target="_blank">Arxiv</a>&emsp;
+    <a href="https://github.com/River-Zhang/ICEdit?tab=readme-ov-file" target="_blank">Github</a>&emsp;
+    <a href="https://huggingface.co/spaces/RiverZ/ICEdit" target="_blank">Huggingface Demo 🤗</a>&emsp;
+    <a href="https://river-zhang.github.io/ICEdit-gh-pages/" target="_blank">Project Page</a>
+</div>
+
+
+<div style="width: 80%; margin:auto;">
+    <img style="width:100%; display: block; margin: auto;" src="docs/images/teaser.png">
+    <p style="text-align: left;">We present In-Context Edit, a novel approach that achieves state-of-the-art instruction-based editing <b>using just 0.5% of the training data and 1% of the parameters required by prior SOTA methods</b>. The first row illustrates a series of multi-turn edits, executed with high precision, while the second and third rows highlight diverse, visually impressive single-turn editing results from our method.</p>
+</div>
+
+:open_book: For more visual results, go checkout our <a href="https://river-zhang.github.io/ICEdit-gh-pages/" target="_blank">project page</a>
+
+This repository will contain the official implementation of _ICEdit_.
+
+
+<div align="left">
+
+# ⚠️ Tips
+
+### If you encounter such a failure case, please **try again with a different seed**!
+
+- Our base model, FLUX, does not inherently support a wide range of styles, so a large portion of our dataset involves style transfer. As a result, the model **may sometimes inexplicably change your artistic style**.
+
+- Our training dataset is **mostly targeted at realistic images**. For non-realistic images, such as **anime** or **blurry pictures**, the success rate of the editing **drop and could potentially affect the final image quality**.
+
+- While the success rates for adding objects, modifying color attributes, applying style transfer, and changing backgrounds are high, the success rate for object removal is relatively lower due to the low quality of the OmniEdit removal dataset.
+
+The current model is the one used in the experiments in the paper, trained with only 4 A800 GPUs (total `batch_size` = 2 x 2 x 4 = 16). In the future, we will enhance the dataset, and do scale-up, finally release a more powerful model.
+
+# To Do List
+
+- [x] Inference Code
+- [ ] Inference-time Scaling with VLM
+- [x] Pretrained Weights
+- [ ] More Inference Demos
+- [x] Gradio demo
+- [ ] Comfy UI demo
+- [ ] Training Code