Update README.md

README.md

@@ -4,12 +4,11 @@ pipeline_tag: text-to-image
 tags:
 - image-to-image
 ---
-
 <h1 align="center">OmniGen: Unified Image Generation</h1>
 
 
 <p align="center">
-    <a href="">
+    <a href="https://vectorspacelab.github.io/OmniGen/">
         <img alt="Build" src="https://img.shields.io/badge/Project%20Page-OmniGen-yellow">
     </a>
     <a href="https://arxiv.org/abs/2409.11340">
@@ -20,12 +19,15 @@ tags:
     </a>
     <a href="https://huggingface.co/Shitao/OmniGen-v1">
         <img alt="Build" src="https://img.shields.io/badge/HF%20Model-🤗-yellow">
+    </a>    
+    <a href="https://replicate.com/chenxwh/omnigen">
+        <img alt="Build" src="https://replicate.com/chenxwh/omnigen/badge">
     </a>
 </p>
 
 <h4 align="center">
     <p>
-        <a href=#2-news>News</a> |
+        <a href=#1-news>News</a> |
         <a href=#3-methodology>Methodology</a> |
         <a href=#4-what-can-omnigen-do>Capabilities</a> |
         <a href=#5-quick-start>Quick Start</a> |
@@ -35,23 +37,24 @@ tags:
     <p>
 </h4>
 
-More information please refer to our github repo: https://github.com/VectorSpaceLab/OmniGen
 
-## 1. Overview
 
-OmniGen is a unified image generation model that can generate a wide range of images from multi-modal prompts. It is designed to be simple, flexible and easy to use. We provide [inference code](#5-quick-start) so that everyone can explore more functionalities of OmniGen.
+## 1. News
+- 2024-11-03: Added Replicate Demo and API: [![Replicate](https://replicate.com/chenxwh/omnigen/badge)](https://replicate.com/chenxwh/omnigen)
+- 2024-10-28: We release new version of inference code, optimizing the memory usage and time cost. You can refer to [docs/inference.md](docs/inference.md#requiremented-resources) for detailed information.
+- 2024-10-22: :fire: We release the code for OmniGen. Inference: [docs/inference.md](docs/inference.md) Train: [docs/fine-tuning.md](docs/fine-tuning.md) 
+- 2024-10-22: :fire: We release the first version of OmniGen. Model Weight: [Shitao/OmniGen-v1](https://huggingface.co/Shitao/OmniGen-v1) HF Demo: [🤗](https://huggingface.co/spaces/Shitao/OmniGen)  
 
-Existing image generation models often require loading several additional network modules (such as ControlNet, IP-Adapter, Reference-Net, etc.) and performing extra preprocessing steps (e.g., face detection, pose estimation, cropping, etc.) to generate a satisfactory image. However, **we believe that the future image generation paradigm should be more simple and flexible, that is, generating various images directly through arbitrarily multi-modal instructions without the need for additional plugins and operations, similar to how GPT works in language generation.** 
 
-Due to the limited resources, OmniGen still has room for improvement. We will continue to optimize it, and hope it inspire more universal image generation models. You can also easily fine-tune OmniGen without worrying about designing networks for specific tasks; you just need to prepare the corresponding data, and then run the [script](#6-finetune). Imagination is no longer limited; everyone can construct any image generation task, and perhaps we can achieve very interesting, wonderful and creative things.
+## 2. Overview
 
-If you have any questions, ideas or interesting tasks you want OmniGen to accomplish, feel free to discuss with us: 2906698981@qq.com, wangyueze@tju.edu.cn, zhengliu1026@gmail.com. We welcome any feedback to help us improve the model.
+OmniGen is a unified image generation model that can generate a wide range of images from multi-modal prompts. It is designed to be simple, flexible, and easy to use. We provide [inference code](#5-quick-start) so that everyone can explore more functionalities of OmniGen.
 
+Existing image generation models often require loading several additional network modules (such as ControlNet, IP-Adapter, Reference-Net, etc.) and performing extra preprocessing steps (e.g., face detection, pose estimation, cropping, etc.) to generate a satisfactory image. However, **we believe that the future image generation paradigm should be more simple and flexible, that is, generating various images directly through arbitrarily multi-modal instructions without the need for additional plugins and operations, similar to how GPT works in language generation.** 
 
+Due to the limited resources, OmniGen still has room for improvement. We will continue to optimize it, and hope it inspires more universal image-generation models. You can also easily fine-tune OmniGen without worrying about designing networks for specific tasks; you just need to prepare the corresponding data, and then run the [script](#6-finetune). Imagination is no longer limited; everyone can construct any image-generation task, and perhaps we can achieve very interesting, wonderful, and creative things.
 
-## 2. News
-- 2024-10-22: :fire: We release the code for OmniGen. Inference: [docs/inference.md](https://github.com/VectorSpaceLab/OmniGen/blob/main/docs/inference.md) Train: [docs/fine-tuning.md](https://github.com/VectorSpaceLab/OmniGen/blob/main/docs/fine-tuning.md) 
-- 2024-10-22: :fire: We release the first version of OmniGen. Model Weight: [Shitao/OmniGen-v1](https://huggingface.co/Shitao/OmniGen-v1) HF Demo: [🤗](https://huggingface.co/spaces/Shitao/OmniGen)  
+If you have any questions, ideas, or interesting tasks you want OmniGen to accomplish, feel free to discuss with us: 2906698981@qq.com, wangyueze@tju.edu.cn, zhengliu1026@gmail.com. We welcome any feedback to help us improve the model.
 
 
 
@@ -60,11 +63,17 @@ If you have any questions, ideas or interesting tasks you want OmniGen to accomp
 You can see details in our [paper](https://arxiv.org/abs/2409.11340). 
 
 
+
 ## 4. What Can OmniGen do?
-![demo](./demo_cases.png)
 
-OmniGen is a unified image generation model that you can use to perform various tasks, including but not limited to text-to-image generation, subject-driven generation, Identity-Preserving Generation, image editing, and image-conditioned generation. **OmniGen don't need additional plugins or operations, it can automatically identify the features (e.g., required object, human pose, depth mapping) in input images according the text prompt.**
-We showcase some examples in [inference.ipynb](https://github.com/VectorSpaceLab/OmniGen/blob/main/inference.ipynb). And in [inference_demo.ipynb](https://github.com/VectorSpaceLab/OmniGen/blob/main/inference_demo.ipynb), we show a insteresting pipeline to generate and modify a image.
+OmniGen is a unified image generation model that you can use to perform various tasks, including but not limited to text-to-image generation, subject-driven generation, Identity-Preserving Generation, image editing, and image-conditioned generation. **OmniGen doesn't need additional plugins or operations, it can automatically identify the features (e.g., required object, human pose, depth mapping) in input images according to the text prompt.**
+We showcase some examples in [inference.ipynb](inference.ipynb). And in [inference_demo.ipynb](inference_demo.ipynb), we show an interesting pipeline to generate and modify an image.
+
+Here are the illustrations of OmniGen's capabilities: 
+- You can control the image generation flexibly via OmniGen
+![demo](./imgs/demo_cases.png)
+- Referring Expression Generation: You can input multiple images and use simple, general language to refer to the objects within those images. OmniGen can automatically recognize the necessary objects in each image and generate new images based on them. No additional operations, such as image cropping or face detection, are required.
+![demo](./imgs/referring.png)
 
 If you are not entirely satisfied with certain functionalities or wish to add new capabilities, you can try [fine-tuning OmniGen](#6-finetune).
 
@@ -74,24 +83,36 @@ If you are not entirely satisfied with certain functionalities or wish to add ne
 
 
 ### Using OmniGen
-Install via Github(Recommend):
+Install via Github:
 ```bash
 git clone https://github.com/staoxiao/OmniGen.git
 cd OmniGen
 pip install -e .
 ```
-or via pypi:
-```bash
-pip install OmniGen
+
+You also can create a new environment to avoid conflicts:
+```
+# Create a python 3.10.12 conda env (you could also use virtualenv)
+conda create -n omnigen python=3.10.12
+conda activate omnigen
+
+# Install pytorch with your CUDA version, e.g.
+pip install torch==2.3.1+cu118 torchvision --extra-index-url https://download.pytorch.org/whl/cu118
+
+git clone https://github.com/staoxiao/OmniGen.git
+cd OmniGen
+pip install -e .
 ```
 
 Here are some examples:
 ```python
 from OmniGen import OmniGenPipeline
 
-pipe = OmniGenPipeline.from_pretrained("Shitao/OmniGen-v1")
+pipe = OmniGenPipeline.from_pretrained("Shitao/OmniGen-v1")  
+# Note: Your local model path is also acceptable, such as 'pipe = OmniGenPipeline.from_pretrained(your_local_model_path)', where all files in your_local_model_path should be organized as https://huggingface.co/Shitao/OmniGen-v1/tree/main
 
-# Text to Image
+
+## Text to Image
 images = pipe(
     prompt="A curly-haired man in a red shirt is drinking tea.", 
     height=1024, 
@@ -101,25 +122,27 @@ images = pipe(
 )
 images[0].save("example_t2i.png")  # save output PIL Image
 
-# Multi-modal to Image
-# In prompt, we use the placeholder to represent the image. The image placeholder should be in the format of <img><|image_*|></img>
+## Multi-modal to Image
+# In the prompt, we use the placeholder to represent the image. The image placeholder should be in the format of <img><|image_*|></img>
 # You can add multiple images in the input_images. Please ensure that each image has its placeholder. For example, for the list input_images [img1_path, img2_path], the prompt needs to have two placeholders: <img><|image_1|></img>, <img><|image_2|></img>.
 images = pipe(
-    prompt="A man in a black shirt is reading a book. The man is the right man in <img><|image_1|></img>."
-    input_images=["./imgs/test_cases/two_man.jpg"]
+    prompt="A man in a black shirt is reading a book. The man is the right man in <img><|image_1|></img>.",
+    input_images=["./imgs/test_cases/two_man.jpg"],
     height=1024, 
     width=1024,
-    separate_cfg_infer=False,  # if OOM, you can set separate_cfg_infer=True 
-    guidance_scale=3, 
-    img_guidance_scale=1.6
+    guidance_scale=2.5, 
+    img_guidance_scale=1.6,
+    seed=0
 )
 images[0].save("example_ti2i.png")  # save output PIL image
 ```
-For more details about the argument in inference, please refer to [docs/inference.md](https://github.com/VectorSpaceLab/OmniGen/blob/main/docs/inference.md). 
-For more examples for image generation, you can refer to [inference.ipynb](https://github.com/VectorSpaceLab/OmniGen/blob/main/inference.ipynb) and [inference_demo.ipynb](https://github.com/VectorSpaceLab/OmniGen/blob/main/inference_demo.ipynb)
+- If out of memory, you can set `offload_model=True`. If the inference time is too long when inputting multiple images, you can reduce the `max_input_image_size`.  For the required resources and the method to run OmniGen efficiently, please refer to [docs/inference.md#requiremented-resources](docs/inference.md#requiremented-resources).
+- For more examples of image generation, you can refer to [inference.ipynb](inference.ipynb) and [inference_demo.ipynb](inference_demo.ipynb)
+- For more details about the argument in inference, please refer to [docs/inference.md](docs/inference.md). 
 
 
 ### Using Diffusers
+
 Coming soon.
 
 
@@ -127,12 +150,22 @@ Coming soon.
 
 We construct an online demo in [Huggingface](https://huggingface.co/spaces/Shitao/OmniGen).
 
-For the local gradio demo, you can run:
+For the local gradio demo, you need to install `pip install gradio spaces`, and then you can run:
 ```python
+pip install gradio spaces
 python app.py
 ```
 
+#### Use Google Colab
+To use with Google Colab, please use the following command:
 
+```
+!git clone https://github.com/staoxiao/OmniGen.git
+%cd OmniGen
+!pip install -e .
+!pip install gradio spaces
+!python app.py --share
+```
 
 ## 6. Finetune
 We provide a training script `train.py` to fine-tune OmniGen. 
@@ -157,9 +190,14 @@ accelerate launch --num_processes=1 train.py \
     --results_dir ./results/toy_finetune_lora
 ```
 
-Please refer to [docs/finetune.md](https://github.com/VectorSpaceLab/OmniGen/blob/main/docs/fine-tune.md) for more details (e.g. full finetune).
+Please refer to [docs/fine-tuning.md](docs/fine-tuning.md) for more details (e.g. full finetune).
 
+### Contributors:
+Thank all our contributors for their efforts and warmly welcome new members to join in!
 
+<a href="https://github.com/VectorSpaceLab/OmniGen/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=VectorSpaceLab/OmniGen" />
+</a>
 
 ## License
 This repo is licensed under the [MIT License](LICENSE).