From 75573a61b4effdda59c53ba43daaaa3f9bd8bbce Mon Sep 17 00:00:00 2001 From: alexsin368 <109180236+alexsin368@users.noreply.github.com> Date: Wed, 20 Nov 2024 16:07:56 -0800 Subject: [PATCH] reorganize sample guides, add CodeGen top sample guide (#256) * reorganize sample guides, add CodeGen top sample guide Signed-off-by: alexsin368 * include index.rst files in toctrees Signed-off-by: alexsin368 * correct toctree Signed-off-by: alexsin368 * fix indent Signed-off-by: alexsin368 --------- Signed-off-by: alexsin368 --- examples/ChatQnA/ChatQnA_Guide.rst | 14 +++++----- examples/CodeGen/CodeGen_Guide.rst | 45 ++++++++++++++++++++++++++++++ examples/index.rst | 3 +- 3 files changed, 53 insertions(+), 9 deletions(-) create mode 100644 examples/CodeGen/CodeGen_Guide.rst diff --git a/examples/ChatQnA/ChatQnA_Guide.rst b/examples/ChatQnA/ChatQnA_Guide.rst index d217f821..7e9b4779 100644 --- 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 ` -* :doc:`Gaudi AI Accelerator ` -* :doc:`Nvidia GPU ` -* :doc:`AI PC ` +requirements. +.. toctree:: + :maxdepth: 1 + ChatQnA Deployment Options + +---- Troubleshooting *************** diff --git a/examples/CodeGen/CodeGen_Guide.rst b/examples/CodeGen/CodeGen_Guide.rst new file mode 100644 index 00000000..dd64bb49 --- /dev/null +++ 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 diff --git a/examples/index.rst b/examples/index.rst index 5d1e9934..9273bf8a 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -9,9 +9,8 @@ GenAIExamples are designed to give developers an easy entry into generative AI, :maxdepth: 1 ChatQnA/ChatQnA_Guide - ChatQnA/deploy/index AgentQnA/AgentQnA_Guide - CodeGen/deploy/index + CodeGen/CodeGen_Guide ----