Single node on-prem deployment with vLLM or TGI on Gaudi AI Accelerator¶

This section covers single-node on-prem deployment of the ChatQnA example using the vLLM or TGI LLM service. There are several ways to enable RAG with vectordb and LLM models, but this tutorial will be covering how to build an end-to-end ChatQnA pipeline with the Redis vector database and meta-llama/Meta-Llama-3-8B-Instruct model deployed on Intel® Gaudi® AI Accelerators. To quickly learn about OPEA and set up the required hardware and software, follow the instructions in the Getting Started Guide.

Overview¶

The OPEA GenAIComps microservices used to deploy a single node vLLM or TGI megaservice solution for ChatQnA are listed below:

Data Prep
Embedding
Retriever
Reranking
LLM with vLLM or TGI

This solution is designed to demonstrate the use of Redis vectorDB for RAG and the Meta-Llama-3-8B-Instruct model for LLM inference on Intel® Gaudi® AI Accelerators. The steps will involve setting up Docker containers, using a sample Nike dataset in PDF format, and posing a question about Nike to receive a response. Although multiple versions of the UI can be deployed, this tutorial will focus solely on the default version.

Prerequisites¶

Set up a workspace and clone the GenAIExamples GitHub repo.

export WORKSPACE=<Path>
cd $WORKSPACE
git clone https://github.com/opea-project/GenAIExamples.git # GenAIExamples

(Optional) It is recommended to use a stable release version by setting RELEASE_VERSION to a number only (i.e. 1.0, 1.1, etc) and checkout that version using the tag. Otherwise, by default, the main branch with the latest updates will be used.

export RELEASE_VERSION=<Release_Version> # Set desired release version - number only
cd GenAIExamples
git checkout tags/v${RELEASE_VERSION}
cd ..

Set up a HuggingFace account and generate a user access token. Request access to the meta-llama/Meta-Llama-3-8B-Instruct model.

Set the HUGGINGFACEHUB_API_TOKEN environment variable to the value of the Hugging Face token by executing the following command:

export HUGGINGFACEHUB_API_TOKEN="Your_Huggingface_API_Token"

The example requires setting the host_ip to “localhost” to deploy the microservices on endpoints enabled with ports.

export host_ip="localhost"

Set the NGINX port.

# Example: NGINX_PORT=80
export NGINX_PORT=<Nginx_Port>

For machines behind a firewall, set up the proxy environment variables:

export http_proxy="Your_HTTP_Proxy"
export https_proxy="Your_HTTPs_Proxy"
# Example: no_proxy="localhost, 127.0.0.1, 192.168.1.1"
export no_proxy="Your_No_Proxy",chatqna-gaudi-ui-server,chatqna-gaudi-backend-server,dataprep-redis-service,tei-embedding-service,retriever,tei-reranking-service,tgi-service,vllm-service,guardrails,jaeger,prometheus,grafana,gaudi-node-exporter-1

Use Case Setup¶

ChatQnA will utilize the following GenAIComps services and associated tools. The tools and models listed in the table can be configured via environment variables in either the set_env.sh script or the compose.yaml file.

vllm

use case components	Tools	Model	Service Type
Data Prep	LangChain	NA	OPEA Microservice
VectorDB	Redis	NA	Open source service
Embedding	TEI	BAAI/bge-base-en-v1.5	OPEA Microservice
Reranking	TEI	BAAI/bge-reranker-base	OPEA Microservice
LLM	vLLM	meta-llama/Meta-Llama-3-8B-Instruct	OPEA Microservice
UI		NA	Gateway Service

TGI

use case components	Tools	Model	Service Type
Data Prep	LangChain	NA	OPEA Microservice
VectorDB	Redis	NA	Open source service
Embedding	TEI	BAAI/bge-base-en-v1.5	OPEA Microservice
Reranking	TEI	BAAI/bge-reranker-base	OPEA Microservice
LLM	TGI	meta-llama/Meta-Llama-3-8B-Instruct	OPEA Microservice
UI		NA	Gateway Service

Set the necessary environment variables to set up the use case. To swap out models, modify set_env.sh before running it. For example, the environment variable LLM_MODEL_ID can be changed to another model by specifying the HuggingFace model card ID.

cd $WORKSPACE/GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi
source ./set_env.sh

Deploy the Use Case¶

Run docker compose with the provided YAML file to start all the services mentioned above as containers.

vllm

docker compose -f compose.yaml up -d

TGI

Follow ONE of the methods below.

Use TGI for the LLM backend.

docker compose -f compose_tgi.yaml up -d

Enable the Guardrails microservice in the pipeline. It will use a TGI Guardrails service.

docker compose -f compose_guardrails.yaml up -d

Check Env Variables¶

After running docker compose, check for warning messages for environment variables that are NOT set. Address them if needed.

vllm

ubuntu@xeon-vm:~/GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi$ docker compose -f compose.yaml up -d
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] /home/ubuntu/GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi/compose.yaml: `version` is obsolete

TGI

ubuntu@xeon-vm:~/GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi$ docker compose -f compose_tgi.yaml up -d
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_API_KEY" variable is not set. Defaulting to a blank string.
WARN[0000] The "LANGCHAIN_TRACING_V2" variable is not set. Defaulting to a blank string.
WARN[0000] /home/ubuntu/GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi/compose_tgi.yaml: `version` is obsolete

Check Container Statuses¶

Check if all the containers launched via docker compose are running i.e. each container’s STATUS is Up and Healthy.

Run this command to see this info:

docker ps -a

Sample output:

vllm

CONTAINER ID   IMAGE                                                   COMMAND                  CREATED          STATUS                            PORTS
                                        NAMES
eabb930edad6   opea/nginx:latest                                          "/docker-entrypoint.…"   9 seconds ago    Up 8 seconds                      0.0.0.0:80->80/tcp, [::]:80->80/tcp
                                        chatqna-gaudi-nginx-server
7e3c16a791b1   opea/chatqna-ui:latest                                     "docker-entrypoint.s…"   9 seconds ago    Up 8 seconds                      0.0.0.0:5173->5173/tcp, [::]:5173->5173/tcp
                                        chatqna-gaudi-ui-server
482365a6e945   opea/chatqna:latest                                        "python chatqna.py"      9 seconds ago    Up 9 seconds                      0.0.0.0:8888->8888/tcp, [::]:8888->8888/tcp
                                        chatqna-gaudi-backend-server
1379226ad3ff   opea/dataprep:latest                                       "sh -c 'python $( [ …"   9 seconds ago    Up 9 seconds                      0.0.0.0:6007->5000/tcp, [::]:6007->5000/tcp
                                        dataprep-redis-server
1cebe2d70e40   opea/retriever:latest                                      "python opea_retriev…"   9 seconds ago    Up 9 seconds                      0.0.0.0:7000->7000/tcp, [::]:7000->7000/tcp
                                        retriever-redis-server
bfe41a5353b6   ghcr.io/huggingface/tei-gaudi:1.5.0                     "text-embeddings-rou…"   10 seconds ago   Up 9 seconds                      0.0.0.0:8808->80/tcp, [::]:8808->80/tcp
                                        tei-reranking-gaudi-server
11a94e7ce3c9   opea/vllm-gaudi:latest                                     "python3 -m vllm.ent…"   10 seconds ago   Up 9 seconds (health: starting)   0.0.0.0:8007->80/tcp, [::]:8007->80/tcp
                                        vllm-gaudi-server
4d7b9aab82b1   redis/redis-stack:7.2.0-v9                              "/entrypoint.sh"         10 seconds ago   Up 9 seconds                      0.0.0.0:6379->6379/tcp, [::]:6379->6379/tcp, 0.0.0.
0:8001->8001/tcp, [::]:8001->8001/tcp   redis-vector-db
9e0d0807bbf6   ghcr.io/huggingface/text-embeddings-inference:cpu-1.5   "text-embeddings-rou…"   10 seconds ago   Up 9 seconds                      0.0.0.0:8090->80/tcp, [::]:8090->80/tcp
                                        tei-embedding-gaudi-server

TGI

CONTAINER ID   IMAGE                                                   COMMAND                  CREATED          STATUS          PORTS                                                                                                                                                                                 NAMES
353775bfa0dc   opea/nginx:latest                                          "/docker-entrypoint.…"   52 seconds ago   Up 50 seconds   0.0.0.0:8010->80/tcp, [::]:8010->80/tcp                                                                                                                                               chatqna-gaudi-nginx-server
c4f75d75f18e   opea/chatqna-ui:latest                                     "docker-entrypoint.s…"   52 seconds ago   Up 50 seconds   0.0.0.0:5173->5173/tcp, [::]:5173->5173/tcp                                                                                                                                           chatqna-gaudi-ui-server
4c5dc803c8c8   opea/chatqna:latest                                        "python chatqna.py"      52 seconds ago   Up 51 seconds   0.0.0.0:8888->8888/tcp, [::]:8888->8888/tcp                                                                                                                                           chatqna-gaudi-backend-server
6bdfebe016c0   opea/dataprep:latest                                       "sh -c 'python $( [ …"   52 seconds ago   Up 51 seconds   0.0.0.0:6007->5000/tcp, [::]:6007->5000/tcp                                                                                                                                           dataprep-redis-server
6fb5264a8465   opea/retriever:latest                                      "python opea_retriev…"   52 seconds ago   Up 51 seconds   0.0.0.0:7000->7000/tcp, [::]:7000->7000/tcp                                                                                                                                           retriever-redis-server
1f4f4f691d36   ghcr.io/huggingface/tgi-gaudi:2.0.6                     "text-generation-lau…"   55 seconds ago   Up 51 seconds   0.0.0.0:8005->80/tcp, [::]:8005->80/tcp                                                                                                                                               tgi-gaudi-server
9c50dfc17428   ghcr.io/huggingface/tei-gaudi:1.5.0                     "text-embeddings-rou…"   55 seconds ago   Up 51 seconds   0.0.0.0:8808->80/tcp, [::]:8808->80/tcp                                                                                                                                               tei-reranking-gaudi-server
a8de74b4594d   ghcr.io/huggingface/text-embeddings-inference:cpu-1.5   "text-embeddings-rou…"   55 seconds ago   Up 51 seconds   0.0.0.0:8090->80/tcp, [::]:8090->80/tcp                                                                                                                                               tei-embedding-gaudi-server
e01438eafa7d   redis/redis-stack:7.2.0-v9                              "/entrypoint.sh"         55 seconds ago   Up 51 seconds   0.0.0.0:6379->6379/tcp, [::]:6379->6379/tcp, 0.0.0.0:8001->8001/tcp, [::]:8001->8001/tcp                                                                                              redis-vector-db
b8ecf10c0c2d   jaegertracing/all-in-one:latest                         "/go/bin/all-in-one-…"   55 seconds ago   Up 51 seconds   0.0.0.0:4317-4318->4317-4318/tcp, [::]:4317-4318->4317-4318/tcp, 14250/tcp, 0.0.0.0:9411->9411/tcp, [::]:9411->9411/tcp, 0.0.0.0:16686->16686/tcp, [::]:16686->16686/tcp, 14268/tcp   jaeger

Each docker container’s log can also be checked using:

docker logs <CONTAINER_ID OR CONTAINER_NAME>

Validate Microservices¶

This section will guide through the various methods for interacting with the deployed microservices.

TEI Embedding Service¶

The TEI embedding service takes in a string as input, embeds the string into a vector of a specific length determined by the embedding model, and returns this vector.

curl ${host_ip}:8090/embed \
    -X POST \
    -d '{"inputs":"What is Deep Learning?"}' \
    -H 'Content-Type: application/json'

In this example, the embedding model used is BAAI/bge-base-en-v1.5, which has a vector size of 768. Therefore, the output of the curl command is a vector of length 768.

Retriever Microservice¶

To consume the retriever microservice, generate a mock embedding vector with a Python script. The length of the embedding vector is determined by the embedding model. The model is set with the environment variable EMBEDDING_MODEL_ID=”BAAI/bge-base-en-v1.5”, which has a vector size of 768.

Check the vector dimension of the embedding model used and set your_embedding dimension equal to it.

export your_embedding=$(python3 -c "import random; embedding = [random.uniform(-1, 1) for _ in range(768)]; print(embedding)")

curl http://${host_ip}:7000/v1/retrieval \
  -X POST \
  -d "{\"text\":\"test\",\"embedding\":${your_embedding}}" \
  -H 'Content-Type: application/json'

The output of the retriever microservice comprises of the a unique id for the request, initial query or the input to the retrieval microservice, a list of top n retrieved documents relevant to the input query, and top_n where n refers to the number of documents to be returned.

The output is retrieved text that is relevant to the input data:

{"id":"b16024e140e78e39a60e8678622be630","retrieved_docs":[],"initial_query":"test","top_n":1,"metadata":[]}

TEI Reranking Service¶

The TEI Reranking Service reranks the documents returned by the retrieval service. It consumes the query and list of documents and returns the document index in decreasing order of the similarity score. The document corresponding to the index with the highest score is the most relevant document for the input query.

curl http://${host_ip}:8808/rerank \
    -X POST \
    -d '{"query":"What is Deep Learning?", "texts": ["Deep Learning is not...", "Deep learning is..."]}' \
    -H 'Content-Type: application/json'

Sample output:

[{"index":1,"score":0.94238955},{"index":0,"score":0.120219156}]

vLLM and TGI Service¶

During the initial startup, this service will take a few minutes to download the model files and complete the warm-up process. Once this is finished, the service will be ready for use.

vllm

Run the command below to check whether the LLM service is ready. The output should be “Application startup complete.”

docker logs vllm-service 2>&1 | grep complete

Run the command below to use the vLLM service to generate text for the input prompt. Sample output is also shown.

curl http://${host_ip}:8007/v1/completions \
  -H "Content-Type: application/json" \
  -d '{
  "model": "meta-llama/Meta-Llama-3-8B-Instruct",
  "prompt": "What is Deep Learning?",
  "max_tokens": 32,
  "temperature": 0
  }'

{"id":"cmpl-be8e1d681eb045f082a7b26d5dba42ff","object":"text_completion","created":1726269914,"model":"meta-llama/Meta-Llama-3-8B-Instruct","choices":[{"index":0,"text":"\n\nDeep Learning is a subset of Machine Learning that is concerned with algorithms inspired by the structure and function of the brain. It is a part of Artificial","logprobs":null,"finish_reason":"length","stop_reason":null}],"usage":{"prompt_tokens":6,"total_tokens":38,"completion_tokens":32}}d

TGI

Run the command below to check whether the LLM service is ready. The output should be “INFO text_generation_router::server: router/src/server.rs:2311: Connected”

docker logs tgi-service | grep Connected

Run the command below to use the TGI service to generate text for the input prompt. Sample output is also shown.

curl http://${host_ip}:8005/generate \
  -X POST \
  -d '{"inputs":"What is Deep Learning?","parameters":{"max_new_tokens":64, "do_sample": true}}' \
  -H 'Content-Type: application/json'

{"generated_text":"Artificial Intelligence (AI) has become a very popular buzzword in the tech industry. While the phrase conjures images of sentient robots and self-driving cars, our current AI landscape is much more subtle. In fact, it most often manifests in the forms of algorithms that help recognize the faces of"}

Dataprep Microservice¶

The knowledge base can be updated using the dataprep microservice, which extracts text from a variety of data sources, chunks the data, and embeds each chunk using the embedding microservice. Finally, the embedded vectors are stored in the Redis vector database.

nke-10k-2023.pdf is Nike’s annual report on a form 10-K. Run this command to download the file:

wget https://github.com/opea-project/GenAIComps/blob/v1.1/comps/retrievers/redis/data/nke-10k-2023.pdf

Upload the file:

curl -X POST "http://${host_ip}:6007/v1/dataprep" \
     -H "Content-Type: multipart/form-data" \
     -F "files=@./nke-10k-2023.pdf"

HTTP links can also be added to the knowledge base. This command adds the opea.dev website.

curl -X POST "http://${host_ip}:6007/v1/dataprep" \
     -H "Content-Type: multipart/form-data" \
     -F 'link_list=["https://opea.dev"]'

The list of uploaded files can be retrieved using this command:

curl -X POST "http://${host_ip}:6007/v1/dataprep/get_file" \
     -H "Content-Type: application/json"

To delete the file or link, use the following commands:

Delete link¶

# The dataprep service will add a .txt postfix for link file

curl -X POST "http://${host_ip}:6007/v1/dataprep/delete_file" \
     -d '{"file_path": "https://opea.dev.txt"}' \
     -H "Content-Type: application/json"

Delete file¶

curl -X POST "http://${host_ip}:6007/v1/dataprep/delete_file" \
     -d '{"file_path": "nke-10k-2023.pdf"}' \
     -H "Content-Type: application/json"

Delete all uploaded files and links¶

curl -X POST "http://${host_ip}:6007/v1/dataprep/delete_file" \
     -d '{"file_path": "all"}' \
     -H "Content-Type: application/json"

ChatQnA MegaService¶

This will ensure the megaservice is working properly.

curl http://${host_ip}:8888/v1/chatqna -H "Content-Type: application/json" -d '{
     "messages": "What is the revenue of Nike in 2023?"
     }'

Here is the output for reference:

data: b'\n'
data: b'An'
data: b'swer'
data: b':'
data: b' In'
data: b' fiscal'
data: b' '
data: b'2'
data: b'0'
data: b'2'
data: b'3'
data: b','
data: b' N'
data: b'I'
data: b'KE'
data: b','
data: b' Inc'
data: b'.'
data: b' achieved'
data: b' record'
data: b' Rev'
data: b'en'
data: b'ues'
data: b' of'
data: b' $'
data: b'5'
data: b'1'
data: b'.'
data: b'2'
data: b' billion'
data: b'.'
data: b'</s>'
data: [DONE]

NGINX Service¶

This will ensure the NGINX ervice is working properly.

curl http://${host_ip}:${NGINX_PORT}/v1/chatqna \
    -H "Content-Type: application/json" \
    -d '{"messages": "What is the revenue of Nike in 2023?"}'

The output will be similar to that of the ChatQnA megaservice.

Launch UI¶

Basic UI¶

To access the frontend, open the following URL in a web browser: http://${host_ip}:${NGINX_PORT}. By default, the UI runs on port 5173 internally. A different host port can be used to access the frontend by modifying the port mapping in the compose.yaml file as shown below:

  chatqna-gaudi-ui-server:
    image: opea/chatqna-ui:${TAG:-latest}
    ...
    ports:
      - "YOUR_HOST_PORT:5173" # Change YOUR_HOST_PORT to the desired port

After making this change, rebuild and restart the containers for the change to take effect.

Stop the Services¶

Navigate to the docker compose directory for this hardware platform.

cd $WORKSPACE/GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi

To stop and remove all the containers, use the command below:

vllm

docker compose -f compose.yaml down

TGI

docker compose -f compose_tgi.yaml down