From b8cfcfb960e8fbda9208ba988609cff0c4424a22 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 16:38:08 +0800 Subject: [PATCH 01/21] Update index.rst for AgentQnA doc refactor Update index.rst for AgentQnA doc refactor --- examples/AgentQnA/deploy/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/examples/AgentQnA/deploy/index.rst b/examples/AgentQnA/deploy/index.rst index 629d84ae..09689423 100644 --- a/examples/AgentQnA/deploy/index.rst +++ b/examples/AgentQnA/deploy/index.rst @@ -7,8 +7,12 @@ Here are some deployment options, depending on your hardware and environment: Single Node *********** +.. rst-class:: rst-columns .. toctree:: :maxdepth: 1 + :glob: - Xeon Scalable Processor \ No newline at end of file + Xeon Scalable Processor + + Gaudi From 5a31f5c99048ff2cac4f035f7cddb93313a7d936 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 16:53:07 +0800 Subject: [PATCH 02/21] Update index.rst for --- examples/index.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/examples/index.rst b/examples/index.rst index 6524dc1d..1b6db295 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -9,10 +9,11 @@ GenAIExamples are designed to give developers an easy entry into generative AI, :maxdepth: 1 ChatQnA/ChatQnA_Guide - ChatQnA/deploy/index + .. toctree:: + ChatQnA/deploy/index AgentQnA/AgentQnA_Guide - AgentQnA/deploy/index - + .. toctree:: + AgentQnA/deploy/index ---- We're building this documentation from content in the From a5d30d2da5f4f52a8fac80a7c2dbbad81f4b1ed7 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 16:55:45 +0800 Subject: [PATCH 03/21] Update index.rst for AgentQnA doc refactor --- examples/AgentQnA/deploy/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/examples/AgentQnA/deploy/index.rst b/examples/AgentQnA/deploy/index.rst index 09689423..179d1967 100644 --- a/examples/AgentQnA/deploy/index.rst +++ b/examples/AgentQnA/deploy/index.rst @@ -14,5 +14,4 @@ Single Node :glob: Xeon Scalable Processor - - Gaudi + Gaudi From 4060afcf54f885ab9161714e4e04327dac709fcd Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 21:58:32 +0800 Subject: [PATCH 04/21] Update index.rst fix the rst ref link --- examples/AgentQnA/deploy/index.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/examples/AgentQnA/deploy/index.rst b/examples/AgentQnA/deploy/index.rst index 179d1967..f336e9da 100644 --- a/examples/AgentQnA/deploy/index.rst +++ b/examples/AgentQnA/deploy/index.rst @@ -12,6 +12,5 @@ Single Node .. toctree:: :maxdepth: 1 :glob: - - Xeon Scalable Processor - Gaudi +- **Xeon Scalable Processor**: `Xeon `_ +- **Gaudi**: `Gaudi `_ From ea8563f96a45a02cc6ebb1f7a7fb884c6d524a8a Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 21:59:35 +0800 Subject: [PATCH 05/21] Update index.rst --- examples/AgentQnA/deploy/index.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/examples/AgentQnA/deploy/index.rst b/examples/AgentQnA/deploy/index.rst index f336e9da..7ecf527a 100644 --- a/examples/AgentQnA/deploy/index.rst +++ b/examples/AgentQnA/deploy/index.rst @@ -6,11 +6,6 @@ AgentQnA Example Deployment Options Here are some deployment options, depending on your hardware and environment: Single Node -*********** -.. rst-class:: rst-columns -.. toctree:: - :maxdepth: 1 - :glob: - **Xeon Scalable Processor**: `Xeon `_ - **Gaudi**: `Gaudi `_ From 919063c9c1dbc5a42f3b4e8b51020145f7cea94b Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 22:20:06 +0800 Subject: [PATCH 06/21] Update index.rst --- examples/index.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/examples/index.rst b/examples/index.rst index 1b6db295..a712c8b1 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -7,13 +7,10 @@ GenAIExamples are designed to give developers an easy entry into generative AI, .. toctree:: :maxdepth: 1 - + :glob: ChatQnA/ChatQnA_Guide - .. toctree:: - ChatQnA/deploy/index AgentQnA/AgentQnA_Guide - .. toctree:: - AgentQnA/deploy/index + ---- We're building this documentation from content in the From b79c53674bd318982b9d534d81b112a2cbbebe63 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 22:23:44 +0800 Subject: [PATCH 07/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index c8424071..6728d818 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -43,5 +43,5 @@ The worker agent uses the retrieval tool to generate answers to the queries post Deployment ********** - -See the :ref:`agentqna-example-deployment`. \ No newline at end of file +.. toctree:: + AgentQnA/deploy/index From cce9e359b6899631a898950efa131d691de59e7e Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 22:37:01 +0800 Subject: [PATCH 08/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 6728d818..043262ee 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -44,4 +44,5 @@ The worker agent uses the retrieval tool to generate answers to the queries post Deployment ********** .. toctree:: - AgentQnA/deploy/index + :maxdepth: 2 + deploy/index From 12d65e3e28a5c0133bde7af83a80b5be4dda25bd Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 22:46:17 +0800 Subject: [PATCH 09/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 043262ee..74f65454 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -44,5 +44,4 @@ The worker agent uses the retrieval tool to generate answers to the queries post Deployment ********** .. toctree:: - :maxdepth: 2 - deploy/index + deploy/index From 9ebc1b2d841ed1445b6850141e6b77e04e1d406a Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 23:10:29 +0800 Subject: [PATCH 10/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 74f65454..8c799a07 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -44,4 +44,5 @@ The worker agent uses the retrieval tool to generate answers to the queries post Deployment ********** .. toctree:: - deploy/index + :maxdepth: 1 + deploy/index From aa47a17bf606061287c8cb34b993ac1e33d3a88a Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 23:25:39 +0800 Subject: [PATCH 11/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 8c799a07..3777d38d 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -44,5 +44,5 @@ The worker agent uses the retrieval tool to generate answers to the queries post Deployment ********** .. toctree:: - :maxdepth: 1 - deploy/index + + deploy/index From 0ad43bd17eba1e201fb53082e37c5738780ae234 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Fri, 15 Nov 2024 23:33:47 +0800 Subject: [PATCH 12/21] Update index.rst --- examples/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/index.rst b/examples/index.rst index a712c8b1..2f7bea19 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -6,7 +6,7 @@ GenAI Examples GenAIExamples are designed to give developers an easy entry into generative AI, featuring microservice-based samples that simplify the processes of deploying, testing, and scaling GenAI applications. All examples are fully compatible with Docker and Kubernetes, supporting a wide range of hardware platforms such as Gaudi, Xeon, and NVIDIA GPU, and other hardware, ensuring flexibility and efficiency for your GenAI adoption. .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :glob: ChatQnA/ChatQnA_Guide AgentQnA/AgentQnA_Guide From e82c63e0fb674a8f7f251d8333506f9e9c9e89c3 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Mon, 18 Nov 2024 08:47:35 +0800 Subject: [PATCH 13/21] Update AgentQnA_Guide.rst fix the format --- examples/AgentQnA/AgentQnA_Guide.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 3777d38d..288ac842 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -43,6 +43,5 @@ The worker agent uses the retrieval tool to generate answers to the queries post Deployment ********** -.. toctree:: deploy/index From bb18a9e6857ece4d3b182aea3c04afd232d8fe1a Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Mon, 18 Nov 2024 09:03:12 +0800 Subject: [PATCH 14/21] Update index.rst --- examples/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/index.rst b/examples/index.rst index 2f7bea19..a712c8b1 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -6,7 +6,7 @@ GenAI Examples GenAIExamples are designed to give developers an easy entry into generative AI, featuring microservice-based samples that simplify the processes of deploying, testing, and scaling GenAI applications. All examples are fully compatible with Docker and Kubernetes, supporting a wide range of hardware platforms such as Gaudi, Xeon, and NVIDIA GPU, and other hardware, ensuring flexibility and efficiency for your GenAI adoption. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ChatQnA/ChatQnA_Guide AgentQnA/AgentQnA_Guide From 59651490d6e6e738659b713d33e2a102db222e7d Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Mon, 18 Nov 2024 09:09:24 +0800 Subject: [PATCH 15/21] Update index.rst --- examples/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/index.rst b/examples/index.rst index a712c8b1..d245efee 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -7,8 +7,9 @@ GenAIExamples are designed to give developers an easy entry into generative AI, .. toctree:: :maxdepth: 1 - :glob: + ChatQnA/ChatQnA_Guide + ChatQnA/deploy/index AgentQnA/AgentQnA_Guide ---- From 6513f1c28705efe482d149138f959de5377f15d4 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Mon, 18 Nov 2024 17:18:06 +0800 Subject: [PATCH 16/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 288ac842..de1b1db8 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -43,5 +43,10 @@ The worker agent uses the retrieval tool to generate answers to the queries post Deployment ********** - - deploy/index +Here are some deployment options, depending on your hardware and environment: + +Single Node + +- **Xeon Scalable Processor**: `Xeon `_ +- **Gaudi**: `Gaudi `_ + From ae26d90d9fd7f09a8112a2d1f32731fa434e88dd Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Mon, 18 Nov 2024 17:29:42 +0800 Subject: [PATCH 17/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index de1b1db8..a7146d83 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -47,6 +47,6 @@ Here are some deployment options, depending on your hardware and environment: Single Node -- **Xeon Scalable Processor**: `Xeon `_ -- **Gaudi**: `Gaudi `_ +- **Xeon Scalable Processor**: `Xeon `_ +- **Gaudi**: `Gaudi `_ From 41bd74143073009f447e966b6092b94e38bf73cc Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Tue, 19 Nov 2024 11:20:30 +0800 Subject: [PATCH 18/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index a7146d83..0a285bb7 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -46,7 +46,10 @@ Deployment Here are some deployment options, depending on your hardware and environment: Single Node +.. toctree:: ++ :maxdepth: 1 -- **Xeon Scalable Processor**: `Xeon `_ -- **Gaudi**: `Gaudi `_ ++ Xeon Scalable Processor ++ ++ Gaudi From d8b28e97af8a36d110f23f231313bf71a85b2f68 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Tue, 19 Nov 2024 11:38:32 +0800 Subject: [PATCH 19/21] Update examples/AgentQnA/AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 0a285bb7..37216103 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -46,6 +46,7 @@ Deployment Here are some deployment options, depending on your hardware and environment: Single Node ++++++++++++++++ .. toctree:: + :maxdepth: 1 From a837b43726515588fad859a968fb599304aa5729 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Tue, 19 Nov 2024 11:42:10 +0800 Subject: [PATCH 20/21] Update conf.py --- conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/conf.py b/conf.py index 35051272..5ab3c491 100644 --- a/conf.py +++ b/conf.py @@ -70,6 +70,8 @@ # files and directories to ignore when looking for source files. exclude_patterns = [ 'scripts/*', + 'examples/AgentQnA/deploy/index.rst', + 'examples/AgentQnA/deploy/xeon.md' ] try: import sphinx_rtd_theme From c0cd1cc50ac04c8391ec0ac8986aa9a426723c25 Mon Sep 17 00:00:00 2001 From: Ying Hu Date: Tue, 19 Nov 2024 11:49:16 +0800 Subject: [PATCH 21/21] Update AgentQnA_Guide.rst --- examples/AgentQnA/AgentQnA_Guide.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst index 37216103..a4889928 100644 --- a/examples/AgentQnA/AgentQnA_Guide.rst +++ b/examples/AgentQnA/AgentQnA_Guide.rst @@ -48,9 +48,7 @@ Here are some deployment options, depending on your hardware and environment: Single Node +++++++++++++++ .. toctree:: -+ :maxdepth: 1 - -+ Xeon Scalable Processor -+ -+ Gaudi + :maxdepth: 1 + Xeon Scalable Processor + Gaudi