diff --git a/README.md b/README.md index fc0f08afa8..3013f9edb6 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,15 @@ GenAIExamples are designed to give developers an easy entry into generative AI, Below are some highlighted GenAI use cases across various application scenarios: -| Scenario | Use Case | -| ------------------ | ---------------------------------------------------------------------- | -| Question Answering | [ChatQnA](ChatQnA) ✨: Chatbot with Retrieval Augmented Generation (RAG).
[VisualQnA](VisualQnA) ✨: Visual Question-answering. | -| Image Generation | [Text2Image](Text2Image) ✨: Text-to-image generation. | -| Content Summarization | [DocSum](DocSum): Document Summarization Application. | -| FAQ Generation | [FaqGen](FaqGen): Frequently asked questions (FAQs) generation from your documents, legal texts, customer queries etc. | -| Code Generation | [CodeGen](CodeGen): Gen-AI Powered Code Generator. | -| Information Retrieval | [DocIndexRetriever](DocIndexRetriever): Document Retrieval with Retrieval Augmented Generation (RAG). | -| Fine-tuning | [InstructionTuning](InstructionTuning): Application of Instruction Tuning. | +| Scenario | Use Case | +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| Question Answering | [ChatQnA](ChatQnA) ✨: Chatbot with Retrieval Augmented Generation (RAG).
[VisualQnA](VisualQnA) ✨: Visual Question-answering. | +| Image Generation | [Text2Image](Text2Image) ✨: Text-to-image generation. | +| Content Summarization | [DocSum](DocSum): Document Summarization Application. | +| FAQ Generation | [FaqGen](FaqGen): Frequently asked questions (FAQs) generation from your documents, legal texts, customer queries etc. | +| Code Generation | [CodeGen](CodeGen): Gen-AI Powered Code Generator. | +| Information Retrieval | [DocIndexRetriever](DocIndexRetriever): Document Retrieval with Retrieval Augmented Generation (RAG). | +| Fine-tuning | [InstructionTuning](InstructionTuning): Application of Instruction Tuning. | For the full list of the available use cases and their supported deployment type, please refer [here](#deploy-examples). @@ -53,26 +53,26 @@ 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 Manifests | Kubernetes with Helm Charts | Kubernetes with GMC | -| ----------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | -| ChatQnA | [Xeon Instructions](ChatQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](ChatQnA/docker_compose/intel/hpu/gaudi/README.md) | [ChatQnA with Manifests](ChatQnA/kubernetes/intel/README.md) | [ChatQnA with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/chatqna/README.md) | [ChatQnA with GMC](ChatQnA/kubernetes/intel/README_gmc.md) | -| CodeGen | [Xeon Instructions](CodeGen/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](CodeGen/docker_compose/intel/hpu/gaudi/README.md) | [CodeGen with Manifests](CodeGen/kubernetes/intel/README.md) | [CodeGen with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codegen/README.md) | [CodeGen with GMC](CodeGen/kubernetes/intel/README_gmc.md) | -| CodeTrans | [Xeon Instructions](CodeTrans/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](CodeTrans/docker_compose/intel/hpu/gaudi/README.md) | [CodeTrans with Manifests](CodeTrans/kubernetes/intel/README.md) | [CodeTrans with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codetrans/README.md) | [CodeTrans with GMC](CodeTrans/kubernetes/intel/README_gmc.md) | -| DocSum | [Xeon Instructions](DocSum/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](DocSum/docker_compose/intel/hpu/gaudi/README.md) | [DocSum with Manifests](DocSum/kubernetes/intel/README.md) | [DocSum with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md) | [DocSum with GMC](DocSum/kubernetes/intel/README_gmc.md) | -| SearchQnA | [Xeon Instructions](SearchQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](SearchQnA/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | [SearchQnA with GMC](SearchQnA/kubernetes/intel/README_gmc.md) | -| FaqGen | [Xeon Instructions](FaqGen/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](FaqGen/docker_compose/intel/hpu/gaudi/README.md) | [FaqGen with Manifests](FaqGen/kubernetes/intel/README.md) | Not Supported | [FaqGen with GMC](FaqGen/kubernetes/intel/README_gmc.md) | -| Translation | [Xeon Instructions](Translation/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](Translation/docker_compose/intel/hpu/gaudi/README.md) | [Translation with Manifests](Translation/kubernetes/intel/README.md) | Not Supported | [Translation with GMC](Translation/kubernetes/intel/README_gmc.md) | -| AudioQnA | [Xeon Instructions](AudioQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](AudioQnA/docker_compose/intel/hpu/gaudi/README.md) | [AudioQnA with Manifests](AudioQnA/kubernetes/intel/README.md) | Not Supported | [AudioQnA with GMC](AudioQnA/kubernetes/intel/README_gmc.md) | -| VisualQnA | [Xeon Instructions](VisualQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](VisualQnA/docker_compose/intel/hpu/gaudi/README.md) | [VisualQnA with Manifests](VisualQnA/kubernetes/intel/README.md) | Not Supported | [VisualQnA with GMC](VisualQnA/kubernetes/intel/README_gmc.md) | -| ProductivitySuite | [Xeon Instructions](ProductivitySuite/docker_compose/intel/cpu/xeon/README.md) | Not Supported | [ProductivitySuite with Manifests](ProductivitySuite/kubernetes/intel/README.md) | Not Supported | Not Supported | -| AgentQnA | [Xeon Instructions](AgentQnA/docker_compose/intel/cpu/xeon) | [Gaudi Instructions](AgentQnA/docker_compose/intel/hpu/gaudi) | Not Supported | Not Supported | Not Supported | -| DocIndexRetriever | [Xeon Instructions](DocIndexRetriever/docker_compose/intel/cpu/xeon/README.md ) | [Gaudi Instructions](DocIndexRetriever/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | Not Supported | -| InstructionTuning | [Xeon Instructions](InstructionTuning/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](InstructionTuning/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | Not Supported | -| RerankFinetuning | [Xeon Instructions](RerankFinetuning/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](RerankFinetuning/docker_compose/intel/hpu/gaudi/README.md ) | Not Supported | Not Supported | Not Supported | -| VideoQnA | [Xeon Instructions](VideoQnA/docker_compose/intel/cpu/xeon/README.md) | Not Supported | Not Supported | Not Supported | Not Supported | -| MultimodalQnA | [Xeon Instructions](MultimodalQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](MultimodalQnA/docker_compose/intel/hpu/gaudi/README.md ) | Not Supported | Not Supported | Not Supported | -| DBQnA | [Xeon Instructions](DBQnA/docker_compose/intel/cpu/xeon/README.md) | Not Supported | Not Supported | Not Supported | Not Supported | - +| Use Case | Docker Compose
Deployment on Xeon | Docker Compose
Deployment on Gaudi | Kubernetes with Manifests | Kubernetes with Helm Charts | Kubernetes with GMC | +| ----------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------- | --- | --- | +| ChatQnA | [Xeon Instructions](ChatQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](ChatQnA/docker_compose/intel/hpu/gaudi/README.md) | [ChatQnA with Manifests](ChatQnA/kubernetes/intel/README.md) | [ChatQnA with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/chatqna/README.md) | [ChatQnA with GMC](ChatQnA/kubernetes/intel/README_gmc.md) | +| CodeGen | [Xeon Instructions](CodeGen/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](CodeGen/docker_compose/intel/hpu/gaudi/README.md) | [CodeGen with Manifests](CodeGen/kubernetes/intel/README.md) | [CodeGen with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codegen/README.md) | [CodeGen with GMC](CodeGen/kubernetes/intel/README_gmc.md) | +| CodeTrans | [Xeon Instructions](CodeTrans/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](CodeTrans/docker_compose/intel/hpu/gaudi/README.md) | [CodeTrans with Manifests](CodeTrans/kubernetes/intel/README.md) | [CodeTrans with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/codetrans/README.md) | [CodeTrans with GMC](CodeTrans/kubernetes/intel/README_gmc.md) | +| DocSum | [Xeon Instructions](DocSum/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](DocSum/docker_compose/intel/hpu/gaudi/README.md) | [DocSum with Manifests](DocSum/kubernetes/intel/README.md) | [DocSum with Helm Charts](https://github.com/opea-project/GenAIInfra/tree/main/helm-charts/docsum/README.md) | [DocSum with GMC](DocSum/kubernetes/intel/README_gmc.md) | +| SearchQnA | [Xeon Instructions](SearchQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](SearchQnA/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | [SearchQnA with GMC](SearchQnA/kubernetes/intel/README_gmc.md) | +| FaqGen | [Xeon Instructions](FaqGen/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](FaqGen/docker_compose/intel/hpu/gaudi/README.md) | [FaqGen with Manifests](FaqGen/kubernetes/intel/README.md) | Not Supported | [FaqGen with GMC](FaqGen/kubernetes/intel/README_gmc.md) | +| Translation | [Xeon Instructions](Translation/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](Translation/docker_compose/intel/hpu/gaudi/README.md) | [Translation with Manifests](Translation/kubernetes/intel/README.md) | Not Supported | [Translation with GMC](Translation/kubernetes/intel/README_gmc.md) | +| AudioQnA | [Xeon Instructions](AudioQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](AudioQnA/docker_compose/intel/hpu/gaudi/README.md) | [AudioQnA with Manifests](AudioQnA/kubernetes/intel/README.md) | Not Supported | [AudioQnA with GMC](AudioQnA/kubernetes/intel/README_gmc.md) | +| VisualQnA | [Xeon Instructions](VisualQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](VisualQnA/docker_compose/intel/hpu/gaudi/README.md) | [VisualQnA with Manifests](VisualQnA/kubernetes/intel/README.md) | Not Supported | [VisualQnA with GMC](VisualQnA/kubernetes/intel/README_gmc.md) | +| ProductivitySuite | [Xeon Instructions](ProductivitySuite/docker_compose/intel/cpu/xeon/README.md) | Not Supported | [ProductivitySuite with Manifests](ProductivitySuite/kubernetes/intel/README.md) | Not Supported | Not Supported | +| AgentQnA | [Xeon Instructions](AgentQnA/docker_compose/intel/cpu/xeon) | [Gaudi Instructions](AgentQnA/docker_compose/intel/hpu/gaudi) | Not Supported | Not Supported | Not Supported | +| DocIndexRetriever | [Xeon Instructions](DocIndexRetriever/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](DocIndexRetriever/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | Not Supported | +| InstructionTuning | [Xeon Instructions](InstructionTuning/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](InstructionTuning/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | Not Supported | +| RerankFinetuning | [Xeon Instructions](RerankFinetuning/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](RerankFinetuning/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | Not Supported | +| VideoQnA | [Xeon Instructions](VideoQnA/docker_compose/intel/cpu/xeon/README.md) | Not Supported | Not Supported | Not Supported | Not Supported | +| MultimodalQnA | [Xeon Instructions](MultimodalQnA/docker_compose/intel/cpu/xeon/README.md) | [Gaudi Instructions](MultimodalQnA/docker_compose/intel/hpu/gaudi/README.md) | Not Supported | Not Supported | Not Supported | +| DBQnA | [Xeon Instructions](DBQnA/docker_compose/intel/cpu/xeon/README.md) | Not Supported | Not Supported | Not Supported | Not Supported | +| | ## Supported Examples diff --git a/supported_examples.md b/supported_examples.md index 28afae616d..67f160d581 100644 --- a/supported_examples.md +++ b/supported_examples.md @@ -105,8 +105,8 @@ This document introduces the supported examples of GenAIExamples. The supported [VisualQnA](./VisualQnA/README.md) is an example of chatbot for question and answering based on the images. -| LVM | HW | Description | -| --------------------------------------------------------------------------------------------- | ------ | ----------- | +| LVM | HW | Description | +| --------------------------------------------------------------------------------------------- | ----------- | ----------- | | [llava-hf/llava-v1.6-mistral-7b-hf](https://huggingface.co/llava-hf/llava-v1.6-mistral-7b-hf) | Xeon/Gaudi2 | Chatbot | ### VideoQnA @@ -126,8 +126,8 @@ By default, the embedding and LVM models are set to a default value as listed be By default, the base model is set to a default value as listed below: -| Service | Base Model | HW | Description | -| ----------------- | ------------------------------------------------------------------------- | ---- | ------------------------------- | +| Service | Base Model | HW | Description | +| ----------------- | ------------------------------------------------------------------------- | ----------- | ------------------------------- | | Rerank Finetuning | [BAAI/bge-reranker-large](https://huggingface.co/BAAI/bge-reranker-large) | Xeon/Gaudi2 | Rerank model finetuning service | ### InstructionTuning @@ -136,8 +136,8 @@ The [Instruction Tuning](./InstructionTuning/README.md) example is designed to f By default, the base model is set to a default value as listed below: -| Service | Base Model | HW | Description | -| ----------------- | ------------------------------------------------------------------------------------- | ---------- | ------------------------------------ | +| Service | Base Model | HW | Description | +| ----------------- | ------------------------------------------------------------------------------------- | ----------- | ------------------------------------ | | InstructionTuning | [meta-llama/Llama-2-7b-chat-hf](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf) | Xeon/Gaudi2 | LLM model Instruction Tuning service | ### DocIndexRetriever @@ -187,9 +187,9 @@ The [AudioQnA](./AudioQnA/README.md) example demonstrates the integration of Gen ### MultimodalQnA [MultimodalQnA](./MultimodalQnA/README.md) addresses your questions by dynamically fetching the most pertinent multimodal information (frames, transcripts, and/or captions) from your collection of videos. -| Framework | Embedding | LVM | Vector Database | HW | Description | +| Framework | Embedding | LVM | Vector Database | HW | Description | |----------------------------------------|-------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|----------------------------|--------|--------------------| -| [LangChain](https://www.langchain.com) | [BridgeTower/bridgetower-large](https://huggingface.co/BridgeTower/bridgetower-large-itm-mlm-gaudi) | [llava-hf/llava-1.5-7b-hf](https://huggingface.co/llava-hf/llava-1.5-7b-hf) | [Redis](https://redis.io/) | Xeon | Multimodal chatbot | +| [LangChain](https://www.langchain.com) | [BridgeTower/bridgetower-large](https://huggingface.co/BridgeTower/bridgetower-large-itm-mlm-gaudi) | [llava-hf/llava-1.5-7b-hf](https://huggingface.co/llava-hf/llava-1.5-7b-hf) | [Redis](https://redis.io/) | Xeon | Multimodal chatbot | | [LangChain](https://www.langchain.com) | [BridgeTower/bridgetower-large](https://huggingface.co/BridgeTower/bridgetower-large-itm-mlm-gaudi) | [llava-hf/llava-v1.6-vicuna-13b-hf](https://huggingface.co/llava-hf/llava-v1.6-vicuna-13b-hf) | [Redis](https://redis.io/) | Gaudi2 | Multimodal chatbot | ### ProductivitySuite @@ -199,7 +199,7 @@ The [AudioQnA](./AudioQnA/README.md) example demonstrates the integration of Gen ### DBQnA [DBQnA](./DBQnA/README.md) converts your natural language query into an SQL query, automatically executes the generated query on the database and delivers real-time query results. -| Framework | LLM | Database | HW | Description | +| Framework | LLM | Database | HW | Description | |----------------------------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------|------|----------------------------| | [LangChain](https://www.langchain.com) | [mistralai/Mistral-7B-Instruct-v0.3](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.3) | [PostgresDB](https://www.postgresql.org/) | Xeon | Natural language SQL agent |