Ephemeral182 commited on
Commit
562355d
·
verified ·
1 Parent(s): a81278f

README: sync Quick Start with latest GitHub (separate Qwen-Image-Edit FastAPI service, MeiGen-AI/GenEvolve as MODEL_PATH, install order)

Browse files
Files changed (1) hide show
  1. README.md +34 -5
README.md CHANGED
@@ -111,27 +111,56 @@ For a user request, the agent samples a multi-turn trajectory of tool calls befo
111
 
112
  ## 🚀 Quick Start
113
 
114
- The deployed checkpoint is the **student policy** — it consumes a user prompt and returns a JSON `gen_prompt + reference_images` program through a `<think>/<tool_call>/<answer>` loop. The end-to-end runtime (vLLM/SGLang server + agent loop + tools + Qwen/Nano renderers) lives in the [GitHub repo](https://github.com/Ephemeral182/GenEvolve).
 
 
115
 
116
  ```bash
117
  git clone https://github.com/Ephemeral182/GenEvolve.git
118
  cd GenEvolve
 
119
  conda create -n genevolve python=3.11 -y && conda activate genevolve
 
120
  pip install torch==2.8.0 torchvision==0.23.0 --index-url https://download.pytorch.org/whl/cu128
121
- pip install --no-build-isolation -r requirements.txt && pip install -e .
 
 
 
 
122
 
123
- # Serve the policy (TP/DP knobs scale across GPUs)
 
 
 
 
 
 
124
  MODEL_PATH=MeiGen-AI/GenEvolve PORT=8000 TP=1 DP=8 bash scripts/serve_vllm.sh
 
125
 
126
- # End-to-end example (Nano backend)
 
 
 
 
127
  export SERPER_API_KEY=<your_key> # required for search / image_search
128
- export GOOGLE_API_KEY=<your_key> # only for the Nano Banana Pro backend
 
 
129
  python examples/quickstart.py \
130
  --backend nano-banana-pro \
131
  --base-url http://localhost:8000/v1 \
132
  --model GenEvolve \
133
  --prompt "A 1990s travel-magazine cover of two backpackers in front of the Eiffel Tower at golden hour, the title \"PARIS\" in bold serif." \
134
  --output paris.png
 
 
 
 
 
 
 
 
135
  ```
136
 
137
  The agent's final `<answer>` is a JSON object:
 
111
 
112
  ## 🚀 Quick Start
113
 
114
+ The deployed checkpoint is the **student policy** — it consumes a user prompt and returns a JSON `gen_prompt + reference_images` program through a `<think>/<tool_call>/<answer>` loop. The end-to-end runtime (vLLM serving + agent loop + tools + Qwen/Nano renderers) lives in the [GitHub repo](https://github.com/Ephemeral182/GenEvolve); the snippet below mirrors its installation and usage.
115
+
116
+ ### 1. Install the main GenEvolve runtime
117
 
118
  ```bash
119
  git clone https://github.com/Ephemeral182/GenEvolve.git
120
  cd GenEvolve
121
+
122
  conda create -n genevolve python=3.11 -y && conda activate genevolve
123
+ pip install -U pip setuptools wheel packaging psutil ninja
124
  pip install torch==2.8.0 torchvision==0.23.0 --index-url https://download.pytorch.org/whl/cu128
125
+ pip install --no-build-isolation -r requirements.txt
126
+ pip install -e .
127
+ ```
128
+
129
+ Qwen-Image-Edit rendering runs as a **separate FastAPI service** (kept out of the vLLM environment to avoid CUDA/diffusers conflicts). Set up that service from the GitHub README when you want to use `--backend qwen-image-edit-service`.
130
 
131
+ ### 2. Serve the agent policy
132
+
133
+ ```bash
134
+ # Single GPU / single replica.
135
+ MODEL_PATH=MeiGen-AI/GenEvolve PORT=8000 TP=1 DP=1 bash scripts/serve_vllm.sh
136
+
137
+ # Higher throughput on one 8-GPU node (8 replicas, 1 GPU each).
138
  MODEL_PATH=MeiGen-AI/GenEvolve PORT=8000 TP=1 DP=8 bash scripts/serve_vllm.sh
139
+ ```
140
 
141
+ `TP` shards one model replica across multiple GPUs; `DP` launches multiple replicas; total GPU usage is `TP × DP`.
142
+
143
+ ### 3. End-to-end example
144
+
145
+ ```bash
146
  export SERPER_API_KEY=<your_key> # required for search / image_search
147
+ export GOOGLE_API_KEY=<your_key> # only for --backend nano-banana-pro
148
+
149
+ # Nano Banana Pro renderer
150
  python examples/quickstart.py \
151
  --backend nano-banana-pro \
152
  --base-url http://localhost:8000/v1 \
153
  --model GenEvolve \
154
  --prompt "A 1990s travel-magazine cover of two backpackers in front of the Eiffel Tower at golden hour, the title \"PARIS\" in bold serif." \
155
  --output paris.png
156
+
157
+ # Qwen-Image-Edit renderer (point at your Qwen-Image-Edit FastAPI service)
158
+ python examples/quickstart.py \
159
+ --backend qwen-image-edit-service \
160
+ --service-url http://your-qwen-service:8001 \
161
+ --base-url http://localhost:8000/v1 \
162
+ --model GenEvolve \
163
+ --output paris_qwen.png
164
  ```
165
 
166
  The agent's final `<answer>` is a JSON object: