From 7f9971ee8ed776f523996378abf2ca60e14d9c60 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 5 Sep 2024 09:56:07 +0000 Subject: [PATCH] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .../docker/compose/ChatQnA-compose.yaml | 6 +-- .../docker/compose/CodeGen-compose.yaml | 6 +-- .../docker/compose/CodeTrans-compose.yaml | 2 +- .../docker/compose/DocSum-compose.yaml | 4 +- .../docker/compose/FaqGen-compose.yaml | 4 +- .../docker/compose/SearchQnA-compose.yaml | 2 +- .../docker/compose/Translation-compose.yaml | 2 +- README.md | 4 +- Translation/docker_image_build/build.yaml | 2 +- docker_images_list.md | 52 +++++++++---------- 10 files changed, 42 insertions(+), 42 deletions(-) diff --git a/.github/workflows/docker/compose/ChatQnA-compose.yaml b/.github/workflows/docker/compose/ChatQnA-compose.yaml index defefb2294..993f0694d0 100644 --- a/.github/workflows/docker/compose/ChatQnA-compose.yaml +++ b/.github/workflows/docker/compose/ChatQnA-compose.yaml @@ -5,16 +5,16 @@ services: chatqna: build: - context: + context: dockerfile: ./Dockerfile image: ${REGISTRY:-opea}/chatqna:${TAG:-latest} chatqna-ui: build: - context: + context: dockerfile: Dockerfile_ui image: ${REGISTRY:-opea}/chatqna-ui:${TAG:-latest} chatqna-conversation-ui: build: - context: + context: dockerfile: Dockerfile_ui.react image: ${REGISTRY:-opea}/chatqna-conversation-ui:${TAG:-latest} diff --git a/.github/workflows/docker/compose/CodeGen-compose.yaml b/.github/workflows/docker/compose/CodeGen-compose.yaml index 959a514725..74ee6728ab 100644 --- a/.github/workflows/docker/compose/CodeGen-compose.yaml +++ b/.github/workflows/docker/compose/CodeGen-compose.yaml @@ -5,16 +5,16 @@ services: codegen: build: - context: + context: dockerfile: ./Dockerfile image: ${REGISTRY:-opea}/codegen:${TAG:-latest} codegen-ui: build: - context: + context: dockerfile: Dockerfile_ui image: ${REGISTRY:-opea}/codegen-ui:${TAG:-latest} codegen-react-ui: build: - context: + context: dockerfile: Dockerfile_ui.react image: ${REGISTRY:-opea}/codegen-conversation-ui:${TAG:-latest} diff --git a/.github/workflows/docker/compose/CodeTrans-compose.yaml b/.github/workflows/docker/compose/CodeTrans-compose.yaml index 64faa968e7..b40b226927 100644 --- a/.github/workflows/docker/compose/CodeTrans-compose.yaml +++ b/.github/workflows/docker/compose/CodeTrans-compose.yaml @@ -10,6 +10,6 @@ services: image: ${REGISTRY:-opea}/codetrans:${TAG:-latest} codetrans-ui: build: - context: + context: dockerfile: Dockerfile_ui image: ${REGISTRY:-opea}/codetrans-ui:${TAG:-latest} diff --git a/.github/workflows/docker/compose/DocSum-compose.yaml b/.github/workflows/docker/compose/DocSum-compose.yaml index 0f155e7bbd..cd1a790574 100644 --- a/.github/workflows/docker/compose/DocSum-compose.yaml +++ b/.github/workflows/docker/compose/DocSum-compose.yaml @@ -10,11 +10,11 @@ services: image: ${REGISTRY:-opea}/docsum:${TAG:-latest} docsum-ui: build: - context: + context: dockerfile: Dockerfile_ui image: ${REGISTRY:-opea}/docsum-ui:${TAG:-latest} docsum-react-ui: build: - context: + context: dockerfile: Dockerfile_ui.react image: ${REGISTRY:-opea}/docsum-react-ui:${TAG:-latest} diff --git a/.github/workflows/docker/compose/FaqGen-compose.yaml b/.github/workflows/docker/compose/FaqGen-compose.yaml index 4f180306a6..3cab47f711 100644 --- a/.github/workflows/docker/compose/FaqGen-compose.yaml +++ b/.github/workflows/docker/compose/FaqGen-compose.yaml @@ -10,11 +10,11 @@ services: image: ${REGISTRY:-opea}/faqgen:${TAG:-latest} faqgen-ui: build: - context: + context: dockerfile: Dockerfile_ui image: ${REGISTRY:-opea}/faqgen-ui:${TAG:-latest} faqgen-react-ui: build: - context: + context: dockerfile: Dockerfile_ui.react image: ${REGISTRY:-opea}/faqgen-react-ui:${TAG:-latest} diff --git a/.github/workflows/docker/compose/SearchQnA-compose.yaml b/.github/workflows/docker/compose/SearchQnA-compose.yaml index 0a5f0151d5..0a393d136a 100644 --- a/.github/workflows/docker/compose/SearchQnA-compose.yaml +++ b/.github/workflows/docker/compose/SearchQnA-compose.yaml @@ -10,6 +10,6 @@ services: image: ${REGISTRY:-opea}/searchqna:${TAG:-latest} searchqna-ui: build: - context: + context: dockerfile: Dockerfile_ui image: ${REGISTRY:-opea}/searchqna-ui:${TAG:-latest} diff --git a/.github/workflows/docker/compose/Translation-compose.yaml b/.github/workflows/docker/compose/Translation-compose.yaml index 1bc48a8357..73dc0e8477 100644 --- a/.github/workflows/docker/compose/Translation-compose.yaml +++ b/.github/workflows/docker/compose/Translation-compose.yaml @@ -10,6 +10,6 @@ services: image: ${REGISTRY:-opea}/translation:${TAG:-latest} translation-ui: build: - context: + context: dockerfile: Dockerfile_ui image: ${REGISTRY:-opea}/translation-ui:${TAG:-latest} diff --git a/README.md b/README.md index 7d286b97ac..60d05496e0 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ Deployment are based on released docker images by default, check [docker image l #### Deploy Examples -| Use Case | Docker Compose
Deployment on Xeon | Docker Compose
Deployment on Gaudi | Kubernetes with GMC | Kubernetes with Manifests | Kubernetes with Helm Charts | -| ----------- | ------------------------------------------------------ | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | +| Use Case | Docker Compose
Deployment on Xeon | Docker Compose
Deployment on Gaudi | Kubernetes with GMC | Kubernetes with Manifests | Kubernetes with Helm Charts | +| ----------- | ------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | ChatQnA | [Xeon Instructions](ChatQnA/docker_compose/Intel/CPU/README.md) | [Gaudi Instructions](ChatQnA/docker_compose/Intel/HPU/README.md) | [ChatQnA with GMC](ChatQnA/kubernetes/README.md) | [ChatQnA with Manifests](ChatQnA/kubernetes/manifests/README.md) | [ChatQnA with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/chatqna/README.md) | | CodeGen | [Xeon Instructions](CodeGen/docker_compose/Intel/CPU/README.md) | [Gaudi Instructions](CodeGen/docker_compose/Intel/HPU/README.md) | [CodeGen with GMC](CodeGen/kubernetes/README.md) | [CodeGen with Manifests](CodeGen/kubernetes/manifests/README.md) | [CodeGen with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codegen/README.md) | | CodeTrans | [Xeon Instructions](CodeTrans/docker_compose/Intel/CPU/README.md) | [Gaudi Instructions](CodeTrans/docker_compose/Intel/HPU/README.md) | [CodeTrans with GMC](CodeTrans/kubernetes/README.md) | [CodeTrans with Manifests](CodeTrans/kubernetes/manifests/README.md) | [CodeTrans with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codetrans/README.md) | diff --git a/Translation/docker_image_build/build.yaml b/Translation/docker_image_build/build.yaml index 407aa8d997..ac2300cd5a 100644 --- a/Translation/docker_image_build/build.yaml +++ b/Translation/docker_image_build/build.yaml @@ -12,7 +12,7 @@ services: image: ${REGISTRY:-opea}/translation:${TAG:-latest} translation-ui: build: - context: + context: dockerfile: ../Dockerfile_ui extends: translation image: ${REGISTRY:-opea}/translation-ui:${TAG:-latest} diff --git a/docker_images_list.md b/docker_images_list.md index e87aceb263..e287e9a75e 100644 --- a/docker_images_list.md +++ b/docker_images_list.md @@ -6,32 +6,32 @@ Take ChatQnA for example. ChatQnA is a chatbot application service based on the ## Example images -| Example Images | Dockerfile | Description | -| ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [opea/audioqna](https://hub.docker.com/r/opea/audioqna) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/AudioQnA/docker/Dockerfile) | The docker image served as a chatqna gateway and using language modeling to generate answers to user queries by converting audio input to text, and then using text-to-speech (TTS) to convert those answers back to speech for interaction. | -| [opea/chatqna](https://hub.docker.com/r/opea/chatqna) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/docker/Dockerfile) | The docker image served as a chatqna gateway and interacted with users by understanding their questions and providing relevant answers. | -| [opea/chatqna-ui](https://hub.docker.com/r/opea/chatqna-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/Dockerfile_ui) | The docker image acted as the chatqna UI entry for facilitating interaction with users for question answering | -| [opea/chatqna-conversation-ui](https://hub.docker.com/r/opea/chatqna-conversation-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/Dockerfile_ui.react) | 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. | -| [opea/chatqna-guardrails](https://hub.docker.com/r/opea/chatqna-guardrails) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/docker/Dockerfile_guardrails) | This docker image is used to encapsulate chatqna's LLM service to secure model inputs and outputs. Guardrails proactively prevents models from interacting with insecure content and signals in time to stop insecure behavior. | -| [opea/chatqna-without-rerank](https://hub.docker.com/r/opea/chatqna-without-rerank) | | | -| [opea/chat-conversation-service](https://hub.docker.com/r/opea/chat-conversation-service) | | | -| [opea/chat-conversation-ui-service](https://hub.docker.com/r/opea/chat-conversation-ui-service) | | | -| [opea/chat-history-service](https://hub.docker.com/r/opea/chat-history-service) | | | -| [opea/codegen](https://hub.docker.com/r/opea/codegen) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/docker/Dockerfile) | The docker image served as the codegen gateway to provide service of the automatic creation of source code from a higher-level representation | -| [opea/codegen-ui](https://hub.docker.com/r/opea/codegen-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/Dockerfile_ui) | The docker image acted as the codegen UI entry for facilitating interaction with users for automatically generating code from user's description | -| [opea/codegen-react-ui](https://hub.docker.com/r/opea/codegen-react-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/Dockerfile_ui.react) | The purpose of the docker image is to provide a user interface for Codegen using React. It allows generating the appropriate code based on the current user input. | -| [opea/codetrans](https://hub.docker.com/r/opea/codetrans) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeTrans/docker/Dockerfile) | 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 | -| [opea/codetrans-ui](https://hub.docker.com/r/opea/codetrans-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeTrans/Dockerfile_ui) | The docker image acted as the codetrans UI entry for facilitating interaction with users for translating one programming language to another one | -| [opea/docsum](https://hub.docker.com/r/opea/docsum) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/DocSum/docker/Dockerfile) | The docker image served as a docsum gateway to provide service of capturing the main points and essential details of the original text | -| [opea/docsum-ui](https://hub.docker.com/r/opea/docsum-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/DocSum/Dockerfile_ui) | The docker image acted as the docsum UI entry for facilitating interaction with users for document summarization | -| [opea/docsum-react-ui](https://hub.docker.com/r/opea/docsum-react-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/DocSum/Dockerfile_ui.react) | The purpose of the docker image is to provide a user interface for document summary using React. It allows upload a file or paste text and then click on “Generate Summary” to get a condensed summary of the generated content and automatically scroll to the bottom of the summary. | -| [opea/faqgen](https://hub.docker.com/r/opea/faqgen) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/FaqGen/docker/Dockerfile) | The docker image served as a faqgen gateway and automatically generating comprehensive, natural sounding Frequently Asked Questions (FAQs) from documents, legal texts, customer inquiries and other sources. | -| [opea/faqgen-ui](https://hub.docker.com/r/opea/faqgen-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/FaqGen/Dockerfile_ui) | The docker image serves as the docsum UI entry point for easy interaction with users, generating FAQs by pasting in question text. | -| [opea/faqgen-react-ui](https://hub.docker.com/r/opea/faqgen-react-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/FaqGen/Dockerfile_ui.react) | The purpose of the docker image is to provide a user interface for Generate FAQs using React. It allows generating FAQs by uploading files or pasting text. | -| [opea/searchqna](https://hub.docker.com/r/opea/searchqna/tags) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/SearchQnA/docker/Dockerfile) | 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 | -| [opea/searchqna-ui](https://hub.docker.com/r/opea/searchqna-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/SearchQnA/Dockerfile_ui) | The docker image acted as the searchqna UI entry for facilitating interaction with users for question answering | -| [opea/translation](https://hub.docker.com/r/opea/translation) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/Translation/docker/Dockerfile) | The docker image served as the translation gateway to provide service of language translation | -| [opea/translation-ui](https://hub.docker.com/r/opea/translation-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/Translation/Dockerfile_ui) | The docker image acted as the translation UI entry for facilitating interaction with users for language translation | +| Example Images | Dockerfile | Description | +| ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [opea/audioqna](https://hub.docker.com/r/opea/audioqna) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/AudioQnA/docker/Dockerfile) | The docker image served as a chatqna gateway and using language modeling to generate answers to user queries by converting audio input to text, and then using text-to-speech (TTS) to convert those answers back to speech for interaction. | +| [opea/chatqna](https://hub.docker.com/r/opea/chatqna) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/docker/Dockerfile) | The docker image served as a chatqna gateway and interacted with users by understanding their questions and providing relevant answers. | +| [opea/chatqna-ui](https://hub.docker.com/r/opea/chatqna-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/Dockerfile_ui) | The docker image acted as the chatqna UI entry for facilitating interaction with users for question answering | +| [opea/chatqna-conversation-ui](https://hub.docker.com/r/opea/chatqna-conversation-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/Dockerfile_ui.react) | 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. | +| [opea/chatqna-guardrails](https://hub.docker.com/r/opea/chatqna-guardrails) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/ChatQnA/docker/Dockerfile_guardrails) | This docker image is used to encapsulate chatqna's LLM service to secure model inputs and outputs. Guardrails proactively prevents models from interacting with insecure content and signals in time to stop insecure behavior. | +| [opea/chatqna-without-rerank](https://hub.docker.com/r/opea/chatqna-without-rerank) | | | +| [opea/chat-conversation-service](https://hub.docker.com/r/opea/chat-conversation-service) | | | +| [opea/chat-conversation-ui-service](https://hub.docker.com/r/opea/chat-conversation-ui-service) | | | +| [opea/chat-history-service](https://hub.docker.com/r/opea/chat-history-service) | | | +| [opea/codegen](https://hub.docker.com/r/opea/codegen) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/docker/Dockerfile) | The docker image served as the codegen gateway to provide service of the automatic creation of source code from a higher-level representation | +| [opea/codegen-ui](https://hub.docker.com/r/opea/codegen-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/Dockerfile_ui) | The docker image acted as the codegen UI entry for facilitating interaction with users for automatically generating code from user's description | +| [opea/codegen-react-ui](https://hub.docker.com/r/opea/codegen-react-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeGen/Dockerfile_ui.react) | The purpose of the docker image is to provide a user interface for Codegen using React. It allows generating the appropriate code based on the current user input. | +| [opea/codetrans](https://hub.docker.com/r/opea/codetrans) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeTrans/docker/Dockerfile) | 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 | +| [opea/codetrans-ui](https://hub.docker.com/r/opea/codetrans-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/CodeTrans/Dockerfile_ui) | The docker image acted as the codetrans UI entry for facilitating interaction with users for translating one programming language to another one | +| [opea/docsum](https://hub.docker.com/r/opea/docsum) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/DocSum/docker/Dockerfile) | The docker image served as a docsum gateway to provide service of capturing the main points and essential details of the original text | +| [opea/docsum-ui](https://hub.docker.com/r/opea/docsum-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/DocSum/Dockerfile_ui) | The docker image acted as the docsum UI entry for facilitating interaction with users for document summarization | +| [opea/docsum-react-ui](https://hub.docker.com/r/opea/docsum-react-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/DocSum/Dockerfile_ui.react) | The purpose of the docker image is to provide a user interface for document summary using React. It allows upload a file or paste text and then click on “Generate Summary” to get a condensed summary of the generated content and automatically scroll to the bottom of the summary. | +| [opea/faqgen](https://hub.docker.com/r/opea/faqgen) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/FaqGen/docker/Dockerfile) | The docker image served as a faqgen gateway and automatically generating comprehensive, natural sounding Frequently Asked Questions (FAQs) from documents, legal texts, customer inquiries and other sources. | +| [opea/faqgen-ui](https://hub.docker.com/r/opea/faqgen-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/FaqGen/Dockerfile_ui) | The docker image serves as the docsum UI entry point for easy interaction with users, generating FAQs by pasting in question text. | +| [opea/faqgen-react-ui](https://hub.docker.com/r/opea/faqgen-react-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/FaqGen/Dockerfile_ui.react) | The purpose of the docker image is to provide a user interface for Generate FAQs using React. It allows generating FAQs by uploading files or pasting text. | +| [opea/searchqna](https://hub.docker.com/r/opea/searchqna/tags) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/SearchQnA/docker/Dockerfile) | 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 | +| [opea/searchqna-ui](https://hub.docker.com/r/opea/searchqna-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/SearchQnA/Dockerfile_ui) | The docker image acted as the searchqna UI entry for facilitating interaction with users for question answering | +| [opea/translation](https://hub.docker.com/r/opea/translation) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/Translation/docker/Dockerfile) | The docker image served as the translation gateway to provide service of language translation | +| [opea/translation-ui](https://hub.docker.com/r/opea/translation-ui) | [Link](https://github.com/opea-project/GenAIExamples/blob/main/Translation/Dockerfile_ui) | The docker image acted as the translation UI entry for facilitating interaction with users for language translation | ## Microservice images