Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update ChatQnA README.md #762

Closed
wants to merge 2 commits into from
Closed

Update ChatQnA README.md #762

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac9135b
Update ChatQnA README.md
xiguiw Sep 6, 2024
0518800
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions ChatQnA/docker/xeon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,34 @@ chaqna-xeon-ui-server
Port 5173 - Open to 0.0.0.0/0
```

You can pull ChatQnA and components docker images form docker hub or build images from source code.

## 🚀 Pull docker images
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to pull the image manually, when you run docker compose, the image will be pull automatically.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, there is no need to pull the Docker images explicitly at all.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hold on this change as some images are behind in terms of approval


```bash
docker pull opea/dataprep-redis:latest
docker pull opea/embedding-tei:latest
docker pull opea/retriever-redis:latest
docker pull opea/reranking-tei:latest
docker pull opea/chatqna:latest
docker pull opea/chatqna-ui:latest
```

### Use TGI as backend

```
docker pull opea/llm-tgi:latest
```

### Use vLLM as backend

```
docker pull opea/vllm:latest
docker pull opea/llm-vllm:latest
```

Go to [Section Check Docker Images)](#Check-Docker-Images)

## 🚀 Build Docker Images
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section should be moved to a backup section. Keep the flow simple for developer to get started.


First of all, you need to build Docker Images locally and install the python package of it.
Expand Down Expand Up @@ -164,6 +192,8 @@ docker build --no-cache -t opea/chatqna-conversation-ui:latest --build-arg https
cd ../../../..
```

## Check Docker Images

Then run the command `docker images`, you will have the following 7 Docker Images:

1. `opea/dataprep-redis:latest`
Expand Down
Loading