Merge branch 'main' into codegen

opea-project · Nov 21, 2024 · 9478b92 · 9478b92
2 parents 3e2ae3d + dc92900
commit 9478b92
Show file tree

Hide file tree

Showing 10 changed files with 529 additions and 82 deletions.
diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ else
 endif
 
 # You can set these variables from the command line.
-SPHINXOPTS    ?= -q
+SPHINXOPTS    ?= -q -j auto
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = "OPEA Project"
 BUILDDIR      ?= _build

diff --git 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

diff --git a/examples/AgentQnA/AgentQnA_Guide.rst b/examples/AgentQnA/AgentQnA_Guide.rst
@@ -43,5 +43,12 @@ The worker agent uses the retrieval tool to generate answers to the queries post
 
 Deployment
 **********
+Here are some deployment options, depending on your hardware and environment:
 
-See the :ref:`agentqna-example-deployment`.
+Single Node
++++++++++++++++
+.. toctree::
+   :maxdepth: 1
+
+   Xeon Scalable Processor </GenAIExamples/AgentQnA/docker_compose/intel/cpu/xeon/README.md>
+   Gaudi </GenAIExamples/AgentQnA/docker_compose/intel/hpu/gaudi/README.md>
diff --git a/examples/AgentQnA/deploy/index.rst b/examples/AgentQnA/deploy/index.rst
@@ -6,9 +6,6 @@ AgentQnA Example Deployment Options
 Here are some deployment options, depending on your hardware and environment:
 
 Single Node
-***********
 
-.. toctree::
-   :maxdepth: 1
-
-   Xeon Scalable Processor <xeon>
+- **Xeon Scalable Processor**: `Xeon <https://opea-project.github.io/latest/GenAIExamples/AgentQnA/docker_compose/intel/cpu/xeon/README.html>`_ 
+- **Gaudi**: `Gaudi <https://opea-project.github.io/latest/GenAIExamples/AgentQnA/docker_compose/intel/hpu/gaudi/README.html>`_ 
diff --git a/examples/ChatQnA/ChatQnA_Guide.rst b/examples/ChatQnA/ChatQnA_Guide.rst
@@ -204,16 +204,16 @@ The gateway serves as the interface for users to access. The gateway routes inco
 Deployment
 **********
 
-See the :ref:`chatqna-example-deployment` that includes both single-node and
+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 quick references to the single-node deployment options:
-
-* :doc:`Xeon Scalable Processor <deploy/xeon>`
-* :doc:`Gaudi AI Accelerator <deploy/gaudi>`
-* :doc:`Nvidia GPU <deploy/nvidia>`
-* :doc:`AI PC <deploy/aipc>`
+requirements. 
 
+.. toctree::
+   :maxdepth: 1
 
+   ChatQnA Deployment Options <deploy/index>
+
+----
 
 Troubleshooting
 ***************

diff --git a/examples/ChatQnA/deploy/gaudi.md b/examples/ChatQnA/deploy/gaudi.md
diff --git a/examples/CodeGen/CodeGen_Guide.rst b/examples/CodeGen/CodeGen_Guide.rst
@@ -0,0 +1,45 @@
+.. _Codegen_Guide:
+
+Codegen Sample Guide
+#####################
+
+.. note:: This guide is in its early development and is a work-in-progress with
+   placeholder content.
+
+Overview
+********
+
+The CodeGen example uses specialized AI models that went through training with datasets that 
+encompass repositories, documentation, programming code, and web data. With an understanding 
+of various programming languages, coding patterns, and software development concepts, the 
+CodeGen LLMs assist developers and programmers. The LLMs can be integrated into the developers' 
+Integrated Development Environments (IDEs) to have more contextual awareness to write more 
+refined and relevant code based on the suggestions. 
+
+Purpose
+*******
+* Code Generation: Streamline coding through Code Generation, enabling non-programmers to describe tasks for code creation.
+* Code Completion: Accelerate coding by suggesting contextually relevant snippets as developers type.
+* Code Translation and Modernization: Translate and modernize code across multiple programming languages, aiding interoperability and updating legacy projects.
+* Code Summarization: Extract key insights from codebases, improving readability and developer productivity.
+* Code Refactoring: Offer suggestions for code refactoring, enhancing code performance and efficiency.
+* AI-Assisted Testing: Assist in creating test cases, ensuring code robustness and accelerating development cycles.
+* Error Detection and Debugging: Detect errors in code and provide detailed descriptions and potential fixes, expediting debugging processes.
+
+How It Works
+************
+
+The CodeGen example uses an open-source code generation model with Text Generation Inference (TGI) 
+for serving deployment. It is presented as a Code Copilot application as shown in the diagram below. 
+
+.. figure:: /GenAIExamples/CodeGen/assets/img/codegen_architecture.png
+   :alt: CodeGen Architecture Diagram
+
+Deployment
+**********
+Here are some deployment options, depending on your hardware and environment:
+
+.. toctree::
+   :maxdepth: 1
+
+   CodeGen Deployment Options <deploy/index>