Skip to content

Commit

Permalink
Add released docker_images_list.md (opea-project#432)
Browse files Browse the repository at this point in the history
Signed-off-by: zepan <[email protected]>
  • Loading branch information
ZePan110 authored Jul 26, 2024
1 parent 8d0c8fb commit 6b5489a
Showing 1 changed file with 153 additions and 0 deletions.
153 changes: 153 additions & 0 deletions docker_images_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
# Description

A list of released OPEA docker images in https://hub.docker.com/, contains all relevant images from the GenAIExamples, GenAIComps and GenAIInfra projects. Please expect more public available images in the future release.

Take ChatQnA for example. ChatQnA is a chatbot application service based on the Retrieval Augmented Generation (RAG) architecture. It consists of <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/embedding-tei">opea/embedding-tei</a></td>, <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/retriever-redis">opea/retriever-redis</a></td>, <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/reranking-tei">opea/reranking-tei</a></td>, <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/llm-tgi">opea/llm-tgi</a></td>, <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/dataprep-redis">opea/dataprep-redis</a></td>, <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/chatqna">opea/chatqna</a></td>, <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/chatqna-ui">opea/chatqna-ui</a></td> and <td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/chatqna-conversation-ui">opea/chatqna-conversation-ui</a></td> (Optional) multiple microservices. Other services are similar, see the corresponding README for details.

# Example images

<table class="tg"><thead>
<tr>
<th class="tg-cly1">Example Images</th>
<th class="tg-cly1">Dockerfile</th>
<th class="tg-cly1">Description</th>
</tr></thead>
<tbody>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/chatqna">opea/chatqna</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image served as a chatqna gateway and interacted with users by understanding their questions and providing relevant answers.</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/chatqna-ui">opea/chatqna-ui</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/docker/ui/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image acted as the chatqna UI entry for facilitating interaction with users for question answering</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/chatqna-conversation-ui">opea/chatqna-conversation-ui</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/docker/ui/docker/Dockerfile.react">Link</a></td>
<td class="tg-cly1">The purpose of the docker image is to provide a user interface for chat-based Q&A using React. It allows for interaction with users and supports continuing conversations with a history that is stored in the browser's local storage.</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/docsum">opea/docsum</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/DocSum/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image served as a docsum gateway to provide service of capturing the main points and essential details of the original text</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/docsum-ui">opea/docsum-ui</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/DocSum/docker/ui/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image acted as the docsum UI entry for facilitating interaction with users for document summarization</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/codetrans">opea/codetrans</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/CodeTrans/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image served as a codetrans gateway to provide service of converting source code written in one programming language into an equivalent version in another programming language</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/codetrans-ui">opea/codetrans-ui</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/CodeTrans/docker/ui/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image acted as the codetrans UI entry for facilitating interaction with users for translating one programming language to another one</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/codegen">opea/codegen</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image served as the codegen gateway to provide service of the automatic creation of source code from a higher-level representation</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/codegen-ui">opea/codegen-ui</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/docker/ui/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image acted as the codegen UI entry for facilitating interaction with users for automatically generating code from user's description</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/searchqna/tags">opea/searchqna</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIExamples/blob/main/SearchQnA/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image served as the searchqna gateway to provide service of retrieving accurate and relevant answers to user queries from a knowledge base or dataset</td>
</tr>
</tbody></table>

# Microservice images

<table class="tg"><thead>
<tr>
<th class="tg-cly1">Microservice Images</th>
<th class="tg-cly1">Dockerfile</th>
<th class="tg-cly1">Description</th>
</tr></thead>
<tbody>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/tei-gaudi/tags">opea/tei-gaudi</a></td>
<td class="tg-yk8o"><a href="https://github.com/huggingface/tei-gaudi/blob/habana-main/Dockerfile-hpu">Link</a></td>
<td class="tg-cly1">The docker image powered by HuggingFace Text Embedding Inference (TEI) on Gaudi2 for deploying and serving Embedding Models</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/web-retriever-chroma">opea/web-retriever-chroma</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/tree/main/comps/web_retrievers/langchain/chroma/docker">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA retrieval microservice based on chroma vectordb for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/retriever-redis">opea/retriever-redis</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/retrievers/langchain/redis/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA retrieval microservice based on redis vectordb for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/reranking-tei">opea/reranking-tei</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/reranks/tei/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA reranking microservice based on tei docker image for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/llm-tgi">opea/llm-tgi</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/llms/text-generation/tgi/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA LLM microservice upon TGI docker image for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/llm-docsum-tgi">opea/llm-docsum-tgi</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/llms/summarization/tgi/Dockerfile">Link</a></td>
<td class="tg-cly1">This docker image is designed to build a document summarization microservice using the HuggingFace Text Generation Inference(TGI) framework. The microservice accepts document input and generates a document summary.</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/llm-vllm">opea/llm-vllm</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/llms/text-generation/vllm/docker/Dockerfile.microservice">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA LLM microservice upon vLLM docker image for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/llm-ray">opea/llm-ray</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/llms/text-generation/ray_serve/docker/Dockerfile.microservice">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA LLM microservice based on Ray for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/guardrails-pii-detection">opea/guardrails-pii-detection</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/guardrails/pii_detection/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA guardrail microservice to provide PII detection for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/embedding-tei">opea/embedding-tei</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/embeddings/langchain/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA embedding microservice upon tei docker image for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/dataprep-on-ray-redis">opea/dataprep-on-ray-redis</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/dataprep/redis/langchain_ray/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA dataprep microservice based on redis vectordb and optimized ray for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/dataprep-redis">opea/dataprep-redis</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/dataprep/redis/langchain/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image exposed the OPEA dataprep microservice based on redis vectordb for GenAI application use</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/knowledge_graphs">opea/knowledge_graphs</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIComps/blob/main/comps/knowledgegraphs/langchain/docker/Dockerfile">Link</a></td>
<td class="tg-cly1">The docker image served as knowledge graph gateway to enhance question answering with graph knowledge searching.</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/gmcrouter">opea/gmcrouter</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIInfra/blob/main/microservices-connector/Dockerfile.manager">Link</a></td>
<td class="tg-cly1">The docker image served as one of key parts of the OPEA GenAI Microservice Connector(GMC) to route the traffic among the microservices defined in GMC
</td>
</tr>
<tr>
<td class="tg-yk8o"><a href="https://hub.docker.com/r/opea/gmcmanager">opea/gmcmanager</a></td>
<td class="tg-yk8o"><a href="https://github.com/opea-project/GenAIInfra/blob/main/microservices-connector/Dockerfile.router">Link</a></td>
<td class="tg-cly1">The docker image served as one of key parts of the OPEA GenAI Microservice Connector(GMC) to be controller manager to handle GMC CRD</td>
</tr>
</tbody></table>

0 comments on commit 6b5489a

Please sign in to comment.