Integrate MultimodalQnA set_env to ut scripts. (opea-project#1965)

ZePan110 · edlee123 · commit 67977a024584 · 2025-06-05T16:54:27.000-05:00
Integrate MultimodalQnA set_env to ut scripts.
Add README.md for UT scripts.

Signed-off-by: ZePan110 &lt;ze.pan@intel.com&gt;
Signed-off-by: Ed Lee &lt;16417837+edlee123@users.noreply.github.com&gt;
diff --git a/MultimodalQnA/docker_compose/amd/gpu/rocm/compose.yaml b/MultimodalQnA/docker_compose/amd/gpu/rocm/compose.yaml
@@ -166,7 +166,7 @@ services:
       MM_EMBEDDING_PORT_MICROSERVICE: ${MM_EMBEDDING_PORT_MICROSERVICE}
       MM_RETRIEVER_SERVICE_HOST_IP: ${MM_RETRIEVER_SERVICE_HOST_IP}
       LVM_SERVICE_HOST_IP: ${LVM_SERVICE_HOST_IP}
-      WHISPER_SERVER_PORT: ${WHISPER_PORT}
+      WHISPER_SERVER_PORT: ${WHISPER_SERVER_PORT}
       WHISPER_SERVER_ENDPOINT: ${WHISPER_SERVER_ENDPOINT}
     ipc: host
     restart: always
diff --git a/MultimodalQnA/docker_compose/amd/gpu/rocm/compose_vllm.yaml b/MultimodalQnA/docker_compose/amd/gpu/rocm/compose_vllm.yaml
@@ -170,7 +170,7 @@ services:
       MM_EMBEDDING_PORT_MICROSERVICE: ${MM_EMBEDDING_PORT_MICROSERVICE}
       MM_RETRIEVER_SERVICE_HOST_IP: ${MM_RETRIEVER_SERVICE_HOST_IP}
       LVM_SERVICE_HOST_IP: ${LVM_SERVICE_HOST_IP}
-      WHISPER_SERVER_PORT: ${WHISPER_PORT}
+      WHISPER_SERVER_PORT: ${WHISPER_SERVER_PORT}
       WHISPER_SERVER_ENDPOINT: ${WHISPER_SERVER_ENDPOINT}
     ipc: host
     restart: always
diff --git a/MultimodalQnA/docker_compose/amd/gpu/rocm/set_env.sh b/MultimodalQnA/docker_compose/amd/gpu/rocm/set_env.sh
@@ -3,8 +3,8 @@
 # Copyright (C) 2024 Advanced Micro Devices, Inc.
 # SPDX-License-Identifier: Apache-2.0
 
-export HOST_IP=${your_host_ip_address}
-export MULTIMODAL_HUGGINGFACEHUB_API_TOKEN=${your_huggingfacehub_token}
+export HOST_IP=${ip_address}
+export MULTIMODAL_HUGGINGFACEHUB_API_TOKEN=${HF_TOKEN}
 export MULTIMODAL_TGI_SERVICE_PORT="8399"
 export no_proxy=${your_no_proxy}
 export http_proxy=${your_http_proxy}
@@ -31,5 +31,5 @@ export DATAPREP_GEN_TRANSCRIPT_SERVICE_ENDPOINT="http://${HOST_IP}:6007/v1/datap
 export DATAPREP_GEN_CAPTION_SERVICE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/generate_captions"
 export DATAPREP_GET_FILE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/get"
 export DATAPREP_DELETE_FILE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/delete"
-export WHISPER_PORT="7066"
-export WHISPER_SERVER_ENDPOINT="http://${host_ip}:${WHISPER_PORT}/v1/asr"
+export WHISPER_SERVER_PORT=7066
+export WHISPER_SERVER_ENDPOINT="http://${host_ip}:${WHISPER_SERVER_PORT}/v1/asr"
diff --git a/MultimodalQnA/docker_compose/amd/gpu/rocm/set_env_vllm.sh b/MultimodalQnA/docker_compose/amd/gpu/rocm/set_env_vllm.sh
@@ -3,9 +3,9 @@
 # Copyright (C) 2024 Advanced Micro Devices, Inc.
 # SPDX-License-Identifier: Apache-2.0
 
-export HOST_IP=${your_host_ip_address}
-export MULTIMODAL_HUGGINGFACEHUB_API_TOKEN=${your_huggingfacehub_token}
-export MULTIMODAL_TGI_SERVICE_PORT="8399"
+export HOST_IP=${ip_address}
+export MULTIMODAL_HUGGINGFACEHUB_API_TOKEN=${HF_TOKEN}
+export MULTIMODAL_VLLM_SERVICE_PORT="8399"
 export no_proxy=${your_no_proxy}
 export http_proxy=${your_http_proxy}
 export https_proxy=${your_http_proxy}
@@ -17,9 +17,9 @@ export REDIS_URL="redis://${HOST_IP}:6379"
 export REDIS_HOST=${HOST_IP}
 export INDEX_NAME="mm-rag-redis"
 export VLLM_SERVER_PORT=8081
-export LVM_ENDPOINT="http://${HOST_IP}:${VLLM_SERVER_PORT}"
+export LVM_ENDPOINT="http://${HOST_IP}:8399"
 export EMBEDDING_MODEL_ID="BridgeTower/bridgetower-large-itm-mlm-itc"
-export LVM_MODEL_ID="Xkev/Llama-3.2V-11B-cot"
+export MULTIMODAL_LLM_MODEL_ID="Xkev/Llama-3.2V-11B-cot"
 export WHISPER_MODEL="base"
 export MM_EMBEDDING_SERVICE_HOST_IP=${HOST_IP}
 export MM_RETRIEVER_SERVICE_HOST_IP=${HOST_IP}
@@ -31,5 +31,5 @@ export DATAPREP_GEN_TRANSCRIPT_SERVICE_ENDPOINT="http://${HOST_IP}:6007/v1/datap
 export DATAPREP_GEN_CAPTION_SERVICE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/generate_captions"
 export DATAPREP_GET_FILE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/get"
 export DATAPREP_DELETE_FILE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/delete"
-export WHISPER_PORT="7066"
-export WHISPER_SERVER_ENDPOINT="http://${host_ip}:${WHISPER_PORT}/v1/asr"
+export WHISPER_SERVER_PORT=7066
+export WHISPER_SERVER_ENDPOINT="http://${HOST_IP}:${WHISPER_SERVER_PORT}/v1/asr"
diff --git a/MultimodalQnA/docker_compose/intel/cpu/xeon/compose.yaml b/MultimodalQnA/docker_compose/intel/cpu/xeon/compose.yaml
@@ -39,7 +39,7 @@ services:
       - redis-vector-db
       - lvm-llava
     ports:
-      - "${DATAPREP_MMR_PORT}:5000"
+      - "${DATAPREP_MMR_PORT:-6007}:5000"
     environment:
       no_proxy: ${no_proxy}
       http_proxy: ${http_proxy}
diff --git a/MultimodalQnA/docker_compose/intel/cpu/xeon/compose_milvus.yaml b/MultimodalQnA/docker_compose/intel/cpu/xeon/compose_milvus.yaml
@@ -81,7 +81,7 @@ services:
       - milvus-standalone
       - lvm-llava
     ports:
-      - "${DATAPREP_MMR_PORT}:5000"
+      - "${DATAPREP_MMR_PORT:-6007}:5000"
     environment:
       no_proxy: ${no_proxy}
       http_proxy: ${http_proxy}
diff --git a/MultimodalQnA/docker_compose/intel/cpu/xeon/set_env.sh b/MultimodalQnA/docker_compose/intel/cpu/xeon/set_env.sh
diff --git a/MultimodalQnA/docker_compose/intel/hpu/gaudi/compose.yaml b/MultimodalQnA/docker_compose/intel/hpu/gaudi/compose.yaml
@@ -41,7 +41,7 @@ services:
       - redis-vector-db
       - lvm
     ports:
-      - "${DATAPREP_MMR_PORT}:5000"
+      - "${DATAPREP_MMR_PORT:-6007}:5000"
     environment:
       no_proxy: ${no_proxy}
       http_proxy: ${http_proxy}
diff --git a/MultimodalQnA/docker_compose/intel/hpu/gaudi/compose_milvus.yaml b/MultimodalQnA/docker_compose/intel/hpu/gaudi/compose_milvus.yaml
@@ -79,7 +79,7 @@ services:
       - "milvus-standalone"
       - "lvm"
     ports:
-      - "${DATAPREP_MMR_PORT}:5000"
+      - "${DATAPREP_MMR_PORT:-6007}:5000"
     environment:
       no_proxy: ${no_proxy}
       http_proxy: ${http_proxy}
diff --git a/MultimodalQnA/docker_compose/intel/set_env.sh b/MultimodalQnA/docker_compose/intel/set_env.sh
@@ -2,12 +2,12 @@
 
 # Copyright (C) 2024 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
-pushd "../../../../../" > /dev/null
+pushd "../../../" > /dev/null
 source .set_env.sh
 popd > /dev/null
 
 export host_ip=$(hostname -I | awk '{print $1}')
-
+export HUGGINGFACEHUB_API_TOKEN=${HF_TOKEN}
 export MM_EMBEDDING_SERVICE_HOST_IP=${host_ip}
 export MM_RETRIEVER_SERVICE_HOST_IP=${host_ip}
 export LVM_SERVICE_HOST_IP=${host_ip}
diff --git a/MultimodalQnA/tests/README.md b/MultimodalQnA/tests/README.md
@@ -0,0 +1,45 @@
+# MultimodalQnA E2E test scripts
+
+## Set the required environment variable
+
+```bash
+export HUGGINGFACEHUB_API_TOKEN="Your_Huggingface_API_Token"
+```
+
+## Run test
+
+On Intel Xeon with vLLM:
+
+```bash
+bash test_compose_on_xeon.sh
+```
+
+On Intel Xeon with TGI:
+
+```bash
+bash test_compose_tgi_on_xeon.sh
+```
+
+On Intel Gaudi with vLLM:
+
+```bash
+bash test_compose_on_gaudi.sh
+```
+
+On Intel Gaudi with TGI:
+
+```bash
+bash test_compose_tgi_on_gaudi.sh
+```
+
+On AMD ROCm with TGI:
+
+```bash
+bash test_compose_on_rocm.sh
+```
+
+On AMD ROCm with vLLM:
+
+```bash
+bash test_compose_vllm_on_rocm.sh
+```
diff --git a/MultimodalQnA/tests/test_compose_milvus_on_xeon.sh b/MultimodalQnA/tests/test_compose_milvus_on_xeon.sh
@@ -65,37 +65,12 @@ function build_docker_images() {
 }
 
 function setup_env() {
-    export host_ip=${ip_address}
-    export MM_EMBEDDING_SERVICE_HOST_IP=${host_ip}
-    export MM_RETRIEVER_SERVICE_HOST_IP=${host_ip}
-    export LVM_SERVICE_HOST_IP=${host_ip}
-    export MEGA_SERVICE_HOST_IP=${host_ip}
-    export HUGGINGFACEHUB_API_TOKEN=${HUGGINGFACEHUB_API_TOKEN}
-    export WHISPER_PORT=7066
-    export MAX_IMAGES=1
-    export WHISPER_MODEL="base"
-    export WHISPER_SERVER_ENDPOINT="http://${host_ip}:${WHISPER_PORT}/v1/asr"
     export COLLECTION_NAME="LangChainCollection"
     export MILVUS_HOST=${host_ip}
-    export DATAPREP_MMR_PORT=6007
-    export DATAPREP_INGEST_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/ingest"
-    export DATAPREP_GEN_TRANSCRIPT_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/generate_transcripts"
-    export DATAPREP_GEN_CAPTION_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/generate_captions"
-    export DATAPREP_GET_FILE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/get"
-    export DATAPREP_DELETE_FILE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/delete"
-    export EMM_BRIDGETOWER_PORT=6006
-    export BRIDGE_TOWER_EMBEDDING=true
-    export EMBEDDING_MODEL_ID="BridgeTower/bridgetower-large-itm-mlm-itc"
-    export MMEI_EMBEDDING_ENDPOINT="http://${host_ip}:$EMM_BRIDGETOWER_PORT"
-    export MM_EMBEDDING_PORT_MICROSERVICE=6000
     export MILVUS_RETRIEVER_PORT=7000
-    export LVM_PORT=9399
-    export LLAVA_SERVER_PORT=8399
     export LVM_MODEL_ID="llava-hf/llava-1.5-7b-hf"
-    export LVM_ENDPOINT="http://${host_ip}:$LLAVA_SERVER_PORT"
-    export MEGA_SERVICE_PORT=8888
-    export BACKEND_SERVICE_ENDPOINT="http://${host_ip}:$MEGA_SERVICE_PORT/v1/multimodalqna"
-    export UI_PORT=5173
+    cd $WORKPATH/docker_compose/intel
+    source set_env.sh
 }
 
 
diff --git a/MultimodalQnA/tests/test_compose_on_gaudi.sh b/MultimodalQnA/tests/test_compose_on_gaudi.sh
@@ -69,42 +69,8 @@ function build_docker_images() {
 }
 
 function setup_env() {
-    export host_ip=${ip_address}
-    export MM_EMBEDDING_SERVICE_HOST_IP=${host_ip}
-    export MM_RETRIEVER_SERVICE_HOST_IP=${host_ip}
-    export LVM_SERVICE_HOST_IP=${host_ip}
-    export MEGA_SERVICE_HOST_IP=${host_ip}
-    export REDIS_DB_PORT=6379
-    export REDIS_INSIGHTS_PORT=8001
-    export REDIS_URL="redis://${host_ip}:${REDIS_DB_PORT}"
-    export REDIS_HOST=${host_ip}
-    export INDEX_NAME="mm-rag-redis"
-    export WHISPER_PORT=7066
-    export MAX_IMAGES=1
-    export WHISPER_MODEL="base"
-    export WHISPER_SERVER_ENDPOINT="http://${host_ip}:${WHISPER_PORT}/v1/asr"
-    export TTS_PORT=7055
-    export TTS_ENDPOINT="http://${host_ip}:${TTS_PORT}/v1/tts"
-    export DATAPREP_MMR_PORT=6007
-    export DATAPREP_INGEST_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/ingest"
-    export DATAPREP_GEN_TRANSCRIPT_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/generate_transcripts"
-    export DATAPREP_GEN_CAPTION_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/generate_captions"
-    export DATAPREP_GET_FILE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/get"
-    export DATAPREP_DELETE_FILE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/delete"
-    export EMM_BRIDGETOWER_PORT=6006
-    export BRIDGE_TOWER_EMBEDDING=true
-    export EMBEDDING_MODEL_ID="BridgeTower/bridgetower-large-itm-mlm-itc"
-    export MMEI_EMBEDDING_ENDPOINT="http://${host_ip}:$EMM_BRIDGETOWER_PORT"
-    export MM_EMBEDDING_PORT_MICROSERVICE=6000
-    export REDIS_RETRIEVER_PORT=7000
-    export LVM_PORT=9399
-    export LLAVA_SERVER_PORT=8399
-    export TGI_GAUDI_PORT="${LLAVA_SERVER_PORT}:80"
-    export LVM_MODEL_ID="llava-hf/llava-v1.6-vicuna-13b-hf"
-    export LVM_ENDPOINT="http://${host_ip}:${LLAVA_SERVER_PORT}"
-    export MEGA_SERVICE_PORT=8888
-    export BACKEND_SERVICE_ENDPOINT="http://${host_ip}:${MEGA_SERVICE_PORT}/v1/multimodalqna"
-    export UI_PORT=5173
+    cd $WORKPATH/docker_compose/intel
+    source set_env.sh
 }
 
 function start_services() {
diff --git a/MultimodalQnA/tests/test_compose_on_rocm.sh b/MultimodalQnA/tests/test_compose_on_rocm.sh
@@ -42,38 +42,10 @@ function build_docker_images() {
 }
 
 function setup_env() {
-    export HOST_IP=${ip_address}
     export host_ip=${ip_address}
-    export MULTIMODAL_HUGGINGFACEHUB_API_TOKEN=${HUGGINGFACEHUB_API_TOKEN}
-    export MULTIMODAL_TGI_SERVICE_PORT="8399"
-    export no_proxy=${your_no_proxy}
-    export http_proxy=${your_http_proxy}
-    export https_proxy=${your_http_proxy}
-    export BRIDGE_TOWER_EMBEDDING=true
-    export EMBEDDER_PORT=6006
-    export MMEI_EMBEDDING_ENDPOINT="http://${HOST_IP}:$EMBEDDER_PORT"
-    export MM_EMBEDDING_PORT_MICROSERVICE=6000
-    export WHISPER_SERVER_PORT=7066
-    export WHISPER_SERVER_ENDPOINT="http://${HOST_IP}:${WHISPER_SERVER_PORT}/v1/asr"
-    export REDIS_URL="redis://${HOST_IP}:6379"
-    export REDIS_HOST=${HOST_IP}
-    export INDEX_NAME="mm-rag-redis"
-    export LLAVA_SERVER_PORT=8399
-    export LVM_ENDPOINT="http://${HOST_IP}:8399"
-    export EMBEDDING_MODEL_ID="BridgeTower/bridgetower-large-itm-mlm-itc"
-    export LVM_MODEL_ID="Xkev/Llama-3.2V-11B-cot"
-    export WHISPER_MODEL="base"
-    export MM_EMBEDDING_SERVICE_HOST_IP=${HOST_IP}
-    export MM_RETRIEVER_SERVICE_HOST_IP=${HOST_IP}
-    export LVM_SERVICE_HOST_IP=${HOST_IP}
-    export MEGA_SERVICE_HOST_IP=${HOST_IP}
-    export BACKEND_SERVICE_ENDPOINT="http://${HOST_IP}:8888/v1/multimodalqna"
-    export DATAPREP_INGEST_SERVICE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/ingest"
-    export DATAPREP_GEN_TRANSCRIPT_SERVICE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/generate_transcripts"
-    export DATAPREP_GEN_CAPTION_SERVICE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/generate_captions"
-    export DATAPREP_GET_FILE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/get"
-    export DATAPREP_DELETE_FILE_ENDPOINT="http://${HOST_IP}:6007/v1/dataprep/delete"
     export MODEL_CACHE=${model_cache:-"/var/opea/multimodalqna-service/data"}
+    cd $WORKPATH/docker_compose/amd/gpu/rocm
+    source set_env.sh
 }
 
 function start_services() {
diff --git a/MultimodalQnA/tests/test_compose_on_xeon.sh b/MultimodalQnA/tests/test_compose_on_xeon.sh
@@ -66,41 +66,8 @@ function build_docker_images() {
 }
 
 function setup_env() {
-    export host_ip=${ip_address}
-    export MM_EMBEDDING_SERVICE_HOST_IP=${host_ip}
-    export MM_RETRIEVER_SERVICE_HOST_IP=${host_ip}
-    export LVM_SERVICE_HOST_IP=${host_ip}
-    export MEGA_SERVICE_HOST_IP=${host_ip}
-    export WHISPER_PORT=7066
-    export MAX_IMAGES=1
-    export WHISPER_MODEL="base"
-    export WHISPER_SERVER_ENDPOINT="http://${host_ip}:${WHISPER_PORT}/v1/asr"
-    export TTS_PORT=7055
-    export TTS_ENDPOINT="http://${host_ip}:${TTS_PORT}/v1/tts"
-    export REDIS_DB_PORT=6379
-    export REDIS_INSIGHTS_PORT=8001
-    export REDIS_URL="redis://${host_ip}:${REDIS_DB_PORT}"
-    export REDIS_HOST=${host_ip}
-    export INDEX_NAME="mm-rag-redis"
-    export DATAPREP_MMR_PORT=6007
-    export DATAPREP_INGEST_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/ingest"
-    export DATAPREP_GEN_TRANSCRIPT_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/generate_transcripts"
-    export DATAPREP_GEN_CAPTION_SERVICE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/generate_captions"
-    export DATAPREP_GET_FILE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/get"
-    export DATAPREP_DELETE_FILE_ENDPOINT="http://${host_ip}:${DATAPREP_MMR_PORT}/v1/dataprep/delete"
-    export EMM_BRIDGETOWER_PORT=6006
-    export BRIDGE_TOWER_EMBEDDING=true
-    export EMBEDDING_MODEL_ID="BridgeTower/bridgetower-large-itm-mlm-itc"
-    export MMEI_EMBEDDING_ENDPOINT="http://${host_ip}:$EMM_BRIDGETOWER_PORT"
-    export MM_EMBEDDING_PORT_MICROSERVICE=6000
-    export REDIS_RETRIEVER_PORT=7000
-    export LVM_PORT=9399
-    export LLAVA_SERVER_PORT=8399
-    export LVM_MODEL_ID="llava-hf/llava-1.5-7b-hf"
-    export LVM_ENDPOINT="http://${host_ip}:$LLAVA_SERVER_PORT"
-    export MEGA_SERVICE_PORT=8888
-    export BACKEND_SERVICE_ENDPOINT="http://${host_ip}:$MEGA_SERVICE_PORT/v1/multimodalqna"
-    export UI_PORT=5173
+    cd $WORKPATH/docker_compose/intel
+    source set_env.sh
 }
 
 
diff --git a/MultimodalQnA/tests/test_compose_vllm_on_rocm.sh b/MultimodalQnA/tests/test_compose_vllm_on_rocm.sh
