Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorganize sample guides, add CodeGen top sample guide #256

Merged
merged 6 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions examples/ChatQnA/ChatQnA_Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
***************
Expand Down
45 changes: 45 additions & 0 deletions examples/CodeGen/CodeGen_Guide.rst
Original file line number Diff line number Diff line change
@@ -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>
3 changes: 1 addition & 2 deletions examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

----

Expand Down