From a1c33156720bf5dd1ca67b73119404037d309f8e Mon Sep 17 00:00:00 2001 From: alexsin368 Date: Wed, 27 Nov 2024 15:25:56 -0800 Subject: [PATCH] remove extra layer index.rst files from sample guides Signed-off-by: alexsin368 --- examples/AgentQnA/deploy/index.rst | 11 --------- examples/AgentQnA/deploy/xeon.md | 37 ------------------------------ examples/ChatQnA/ChatQnA_Guide.rst | 26 +++++++++++++++++---- examples/ChatQnA/deploy/index.rst | 29 ----------------------- examples/CodeGen/CodeGen_Guide.rst | 2 +- examples/CodeGen/deploy/index.rst | 14 ----------- examples/index.rst | 2 +- 7 files changed, 24 insertions(+), 97 deletions(-) delete mode 100644 examples/AgentQnA/deploy/index.rst delete mode 100644 examples/AgentQnA/deploy/xeon.md delete mode 100644 examples/ChatQnA/deploy/index.rst delete mode 100644 examples/CodeGen/deploy/index.rst diff --git a/examples/AgentQnA/deploy/index.rst b/examples/AgentQnA/deploy/index.rst deleted file mode 100644 index 7ecf527a..00000000 --- a/examples/AgentQnA/deploy/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _agentqna-example-deployment: - -AgentQnA Example Deployment Options -################################### - -Here are some deployment options, depending on your hardware and environment: - -Single Node - -- **Xeon Scalable Processor**: `Xeon `_ -- **Gaudi**: `Gaudi `_ diff --git a/examples/AgentQnA/deploy/xeon.md b/examples/AgentQnA/deploy/xeon.md deleted file mode 100644 index d1d66573..00000000 --- a/examples/AgentQnA/deploy/xeon.md +++ /dev/null @@ -1,37 +0,0 @@ -# Single node on-prem deployment with Docker Compose on Xeon Scalable processors - -1. [Optional] Build `Agent` docker image - -``` -git clone https://github.com/opea-project/GenAIComps.git -cd GenAIComps -docker build -t opea/agent-langchain:latest -f comps/agent/langchain/Dockerfile . -``` - -2. Launch Tool service - -In this example, we will use some of the mock APIs provided in the Meta CRAG KDD Challenge to demonstrate the benefits of gaining additional context from mock knowledge graphs. - -``` -docker run -d -p=8080:8000 docker.io/aicrowd/kdd-cup-24-crag-mock-api:v0 -``` - -3. clone repo -``` -export WORKDIR=$(pwd) -git clone https://github.com/opea-project/GenAIExamples.git - -export TOOLSET_PATH=$WORKDIR/GenAIExamples/AgentQnA/tools/ - -# optional: OPANAI_API_KEY -export OPENAI_API_KEY= -``` - -4. launch `Agent` service - -The configurations of the supervisor agent and the worker agent are defined in the docker-compose yaml file. We currently use openAI GPT-4o-mini as LLM, and we plan to add support for llama3.1-70B-instruct (served by TGI-Gaudi) in a subsequent release. To use openai llm, run command below. - -``` -cd $WORKDIR/GenAIExamples/AgentQnA/docker_compose/intel/cpu/xeon -bash launch_agent_service_openai.sh -``` \ No newline at end of file diff --git a/examples/ChatQnA/ChatQnA_Guide.rst b/examples/ChatQnA/ChatQnA_Guide.rst index 7e9b4779..a9663741 100644 --- a/examples/ChatQnA/ChatQnA_Guide.rst +++ b/examples/ChatQnA/ChatQnA_Guide.rst @@ -204,17 +204,35 @@ The gateway serves as the interface for users to access. The gateway routes inco Deployment ********** -Here are some deployment options, including both single-node and -orchestrated multi-node configurations, and choose the one that best fits your -requirements. +Here are some deployment options depending on your hardware and environment. +It includes both single-node and orchestrated multi-node configurations. +Choose the one that best fits your requirements. + +Single Node +*********** .. toctree:: :maxdepth: 1 - ChatQnA Deployment Options + Xeon Scalable Processor + Gaudi AI Accelerator + Nvidia GPU + AI PC ---- +Kubernetes +********** + +* Xeon & Gaudi with GMC +* Xeon & Gaudi without GMC +* Using Helm Charts + +Cloud Native +************ + +* Red Hat OpenShift Container Platform (RHOCP) + Troubleshooting *************** diff --git a/examples/ChatQnA/deploy/index.rst b/examples/ChatQnA/deploy/index.rst deleted file mode 100644 index 0c3c3e55..00000000 --- a/examples/ChatQnA/deploy/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _chatqna-example-deployment: - -ChatQnA Example Deployment Options -################################## - -Here are some deployment options, depending on your hardware and environment: - -Single Node -*********** - -.. toctree:: - :maxdepth: 1 - - Xeon Scalable Processor - Gaudi AI Accelerator - Nvidia GPU - AI PC - -Kubernetes -********** - -* Xeon & Gaudi with GMC -* Xeon & Gaudi without GMC -* Using Helm Charts - -Cloud Native -************ - -* Red Hat OpenShift Container Platform (RHOCP) diff --git a/examples/CodeGen/CodeGen_Guide.rst b/examples/CodeGen/CodeGen_Guide.rst index dd64bb49..2b1da1bc 100644 --- a/examples/CodeGen/CodeGen_Guide.rst +++ b/examples/CodeGen/CodeGen_Guide.rst @@ -42,4 +42,4 @@ Here are some deployment options, depending on your hardware and environment: .. toctree:: :maxdepth: 1 - CodeGen Deployment Options + Gaudi AI Accelerator diff --git a/examples/CodeGen/deploy/index.rst b/examples/CodeGen/deploy/index.rst deleted file mode 100644 index ac0a37d0..00000000 --- a/examples/CodeGen/deploy/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _codegen-example-deployment: - -CodeGen Example Deployment Options -################################### - -Here are some deployment options, depending on your hardware and environment: - -Single Node -*********** - -.. toctree:: - :maxdepth: 1 - - Gaudi AI Accelerator \ No newline at end of file diff --git a/examples/index.rst b/examples/index.rst index 9273bf8a..c7d72fb3 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -8,8 +8,8 @@ GenAIExamples are designed to give developers an easy entry into generative AI, .. toctree:: :maxdepth: 1 - ChatQnA/ChatQnA_Guide AgentQnA/AgentQnA_Guide + ChatQnA/ChatQnA_Guide CodeGen/CodeGen_Guide ----