diff --git a/examples/CodeGen/CodeGen_Guide.rst b/examples/CodeGen/CodeGen_Guide.rst new file mode 100644 index 00000000..de915e7c --- /dev/null +++ b/examples/CodeGen/CodeGen_Guide.rst @@ -0,0 +1,48 @@ +.. _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: + +Single Node ++++++++++++++++ +.. toctree:: + :maxdepth: 1 + + Xeon Scalable Processor + Gaudi AI Accelerator diff --git a/examples/index.rst b/examples/index.rst index d9392887..9273bf8a 100644 --- a/examples/index.rst +++ b/examples/index.rst @@ -9,10 +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/gaudi.md - CodeGen/deploy/index + CodeGen/CodeGen_Guide ----