Skip to content

Commit 31b6635

Browse files
ZePan110cogniware-devops
authored andcommitted
Change CodeGen default ui from gradio to svelte. (opea-project#2321)
Signed-off-by: ZePan110 <ze.pan@intel.com> Signed-off-by: cogniware-devops <ambarish.desai@cogniware.ai>
1 parent 6875323 commit 31b6635

8 files changed

Lines changed: 23 additions & 24 deletions

File tree

CodeGen/docker_compose/intel/cpu/xeon/README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ Different Docker Compose files are available to select the LLM serving backend.
8484

8585
- **Compose File:** `compose.yaml`
8686
- **Description:** Uses vLLM optimized for Intel CPUs as the LLM serving engine. This is the default deployment option used in the Quick Start.
87-
- **Services Deployed:** `codegen-vllm-server`, `codegen-llm-server`, `codegen-tei-embedding-server`, `codegen-retriever-server`, `redis-vector-db`, `codegen-dataprep-server`, `codegen-backend-server`, `codegen-gradio-ui-server`.
87+
- **Services Deployed:** `codegen-vllm-server`, `codegen-llm-server`, `codegen-tei-embedding-server`, `codegen-retriever-server`, `redis-vector-db`, `codegen-dataprep-server`, `codegen-backend-server`, `codegen-ui-server`.
8888

8989
#### TGI-based Deployment (`compose_tgi.yaml`)
9090

9191
- **Compose File:** `compose_tgi.yaml`
9292
- **Description:** Uses Hugging Face Text Generation Inference (TGI) optimized for Intel CPUs as the LLM serving engine.
93-
- **Services Deployed:** `codegen-tgi-server`, `codegen-llm-server`, `codegen-tei-embedding-server`, `codegen-retriever-server`, `redis-vector-db`, `codegen-dataprep-server`, `codegen-backend-server`, `codegen-gradio-ui-server`.
93+
- **Services Deployed:** `codegen-tgi-server`, `codegen-llm-server`, `codegen-tei-embedding-server`, `codegen-retriever-server`, `redis-vector-db`, `codegen-dataprep-server`, `codegen-backend-server`, `codegen-ui-server`.
9494
- **To Run:**
9595

9696
```bash
@@ -102,7 +102,7 @@ Different Docker Compose files are available to select the LLM serving backend.
102102

103103
- **Compose File:** `compose_remote.yaml`
104104
- **Description:** Uses remote endpoints to access the served LLM's. This is the default configurations except for the LLM serving engine.
105-
- **Services Deployed:** `codegen-tei-embedding-server`, `codegen-retriever-server`, `redis-vector-db`, `codegen-dataprep-server`, `codegen-backend-server`, `codegen-gradio-ui-server`.
105+
- **Services Deployed:** `codegen-tei-embedding-server`, `codegen-retriever-server`, `redis-vector-db`, `codegen-dataprep-server`, `codegen-backend-server`, `codegen-ui-server`.
106106
- **To Run:**
107107
108108
When models are deployed on a remote server, a base URL and an API key are required to access them. To set up a remote server and acquire the base URL and API key, refer to [Intel® AI for Enterprise Inference](https://www.intel.com/content/www/us/en/developer/topic-technology/artificial-intelligence/enterprise-inference.html) offerings.
@@ -159,7 +159,7 @@ Different Docker Compose files (`compose.yaml`, `compose_tgi.yaml`) control whic
159159
If you need to modify the microservices:
160160
161161
1. Clone the [OPEA GenAIComps](https://github.com/opea-project/GenAIComps) repository.
162-
2. Follow build instructions in the respective component directories (e.g., `comps/llms/text-generation`, `comps/codegen`, `comps/ui/gradio`, etc.). Use the provided Dockerfiles (e.g., `CodeGen/Dockerfile`, `CodeGen/ui/docker/Dockerfile.gradio`).
162+
2. Follow build instructions in the respective component directories (e.g., `comps/llms/text-generation`, `comps/codegen`, etc.). Use the provided Dockerfiles (e.g., `CodeGen/Dockerfile`, `CodeGen/ui/docker/Dockerfile`).
163163
3. Tag your custom images appropriately (e.g., `my-custom-codegen:latest`).
164164
4. Update the `image:` fields in the compose files (`compose.yaml` or `compose_tgi.yaml`) to use your custom image tags.
165165
@@ -207,18 +207,17 @@ Use `curl` commands to test the main service endpoints. Ensure `HOST_IP` is corr
207207
208208
Multiple UI options can be configured via the compose files.
209209
210-
### Gradio UI (Default)
210+
### Svelte UI (Default)
211211
212-
Access the default Gradio UI by navigating to:
212+
Access the default Svelte UI by navigating to:
213213
`http://{HOST_IP}:5173`
214-
_(Port `5173` is the default host mapping for `codegen-gradio-ui-server`)_
214+
_(Port `5173` is the default host mapping for `codegen-ui-server`)_
215215
216-
![Gradio UI - Code Generation](../../../../assets/img/codegen_gradio_ui_main.png)
217-
![Gradio UI - Resource Management](../../../../assets/img/codegen_gradio_ui_dataprep.png)
216+
![Svelte UI - Code Generation](../../../../assets/img/codeGen_ui_init.jpg)
218217
219-
### Svelte UI (Optional)
218+
### Gradio UI (Optional)
220219
221-
1. Modify the compose file (either `compose.yaml` or `compose_tgi.yaml`): Comment out the `codegen-gradio-ui-server` service and uncomment/add the `codegen-xeon-ui-server` (Svelte) service definition, ensuring the port mapping is correct (e.g., `"- 5173:5173"`).
220+
1. Modify the compose file (either `compose.yaml` or `compose_tgi.yaml`): Comment out the `codegen-xeon-ui-server` (Svelte) service and uncomment/add the `codegen-gradio-ui-server` service definition, ensuring the port mapping is correct (e.g., `"- 5173:5173"`).
222221
2. Restart Docker Compose: `docker compose up -d` or `docker compose -f compose_tgi.yaml up -d`
223222
3. Access: `http://{HOST_IP}:5173` (or the host port you mapped).
224223

CodeGen/docker_compose/intel/cpu/xeon/compose_remote.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ services:
2525
ipc: host
2626
restart: always
2727
codegen-xeon-ui-server:
28-
image: ${REGISTRY:-opea}/codegen-gradio-ui:${TAG:-latest}
28+
image: ${REGISTRY:-opea}/codegen-ui:${TAG:-latest}
2929
container_name: codegen-xeon-ui-server
3030
depends_on:
3131
- codegen-xeon-backend-server

CodeGen/docker_compose/intel/hpu/gaudi/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ There are two separate Docker Compose files to select the LLM serving backend ac
8686
- **Compose File:** `compose.yaml`
8787
- **Description:** Uses vLLM optimized for Intel Gaudi HPUs as the LLM serving engine. This is the default deployment used in the Quick Start.
8888
- **Gaudi Service:** `codegen-vllm-gaudi-server`
89-
- **Other Services:** `codegen-llm-server`, `codegen-tei-embedding-server` (CPU), `codegen-retriever-server` (CPU), `redis-vector-db` (CPU), `codegen-dataprep-server` (CPU), `codegen-backend-server` (CPU), `codegen-gradio-ui-server` (CPU).
89+
- **Other Services:** `codegen-llm-server`, `codegen-tei-embedding-server` (CPU), `codegen-retriever-server` (CPU), `redis-vector-db` (CPU), `codegen-dataprep-server` (CPU), `codegen-backend-server` (CPU), `codegen-ui-server` (CPU).
9090

9191
### TGI-based Deployment (`compose_tgi.yaml`)
9292

@@ -197,23 +197,23 @@ Use `curl` commands targeting the main service endpoints. Ensure `HOST_IP` is co
197197

198198
UI options are similar to the Xeon deployment.
199199

200-
### Gradio UI (Default)
200+
### Svelte UI (Default)
201201

202-
Access the default Gradio UI:
202+
Access the default Svelte UI:
203203
`http://{HOST_IP}:5173`
204204
_(Port `5173` is the default host mapping)_
205205

206-
![Gradio UI](../../../../assets/img/codegen_gradio_ui_main.png)
206+
![Svelte UI](../../../../assets/img/codeGen_ui_init.jpg)
207207

208-
### Svelte UI (Optional)
208+
### Gradio UI (Optional)
209209

210-
1. Modify the compose file (either `compose.yaml` or `compose_tgi.yaml`): Swap Gradio service for Svelte (`codegen-gaudi-ui-server`), check port map (e.g., `5173:5173`).
210+
1. Modify the compose file (either `compose.yaml` or `compose_tgi.yaml`): Swap Svelte service for Gradio (`codegen-gradio-ui-server`), check port map (e.g., `5173:5173`).
211211
2. Restart: `docker compose up -d` or `docker compose -f compose_tgi.yaml up -d`
212212
3. Access: `http://{HOST_IP}:5173`
213213

214214
### React UI (Optional)
215215

216-
1. Modify the compose file (either `compose.yaml` or `compose_tgi.yaml`): Swap Gradio service for React (`codegen-gaudi-react-ui-server`), check port map (e.g., `5174:80`).
216+
1. Modify the compose file (either `compose.yaml` or `compose_tgi.yaml`): Swap Svelte service for React (`codegen-gaudi-react-ui-server`), check port map (e.g., `5174:80`).
217217
2. Restart: `docker compose up -d` or `docker compose -f compose_tgi.yaml up -d`
218218
3. Access: `http://{HOST_IP}:5174`
219219

CodeGen/docker_compose/intel/hpu/gaudi/compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ services:
7474
ipc: host
7575
restart: always
7676
codegen-gaudi-ui-server:
77-
image: ${REGISTRY:-opea}/codegen-gradio-ui:${TAG:-latest}
77+
image: ${REGISTRY:-opea}/codegen-ui:${TAG:-latest}
7878
container_name: codegen-gaudi-ui-server
7979
depends_on:
8080
- codegen-gaudi-backend-server

CodeGen/docker_compose/intel/hpu/gaudi/compose_tgi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ services:
7474
ipc: host
7575
restart: always
7676
codegen-gaudi-ui-server:
77-
image: ${REGISTRY:-opea}/codegen-gradio-ui:${TAG:-latest}
77+
image: ${REGISTRY:-opea}/codegen-ui:${TAG:-latest}
7878
container_name: codegen-gaudi-ui-server
7979
depends_on:
8080
- codegen-gaudi-backend-server

CodeGen/tests/test_compose_on_epyc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ function build_docker_images() {
3232
popd && sleep 1s
3333

3434
echo "Build all the images with --no-cache, check docker_image_build.log for details..."
35-
service_list="codegen codegen-gradio-ui llm-textgen dataprep retriever embedding"
35+
service_list="codegen codegen-ui llm-textgen dataprep retriever embedding"
3636

3737
docker compose -f build.yaml build ${service_list} --no-cache >${LOG_PATH}/docker_image_build.log
3838

CodeGen/tests/test_compose_on_gaudi.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ function build_docker_images() {
2626
popd && sleep 1s
2727

2828
echo "Build all the images with --no-cache, check docker_image_build.log for details..."
29-
service_list="codegen codegen-gradio-ui llm-textgen dataprep retriever embedding"
29+
service_list="codegen codegen-ui llm-textgen dataprep retriever embedding"
3030
docker compose -f build.yaml build ${service_list} --no-cache > ${LOG_PATH}/docker_image_build.log
3131

3232
docker images && sleep 1s

CodeGen/tests/test_compose_tgi_on_epyc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ function build_docker_images() {
3232
popd && sleep 1s
3333

3434
echo "Build all the images with --no-cache, check docker_image_build.log for details..."
35-
service_list="codegen codegen-gradio-ui llm-textgen dataprep retriever embedding"
35+
service_list="codegen codegen-ui llm-textgen dataprep retriever embedding"
3636

3737
docker compose -f build.yaml build ${service_list} --no-cache >${LOG_PATH}/docker_image_build.log
3838

0 commit comments

Comments
 (0)