Skip to content

Update and simplify CodeTrans tutorials #353

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.

Sign up for GitHub

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

Merged
ashahba merged 9 commits into from
Apr 18, 2025
Merged

Update and simplify CodeTrans tutorials #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f6d7d19
update intros
alexsin368 Apr 15, 2025
7feb30b
simplify, add vLLM/tgi, update microservice validation, port forwarding
alexsin368 Apr 16, 2025
31e54d3
minor fixes
alexsin368 Apr 16, 2025
c7e6a56
update docker ps output and fix typos
alexsin368 Apr 16, 2025
7278691
Merge branch 'opea-project:main' into val_updates_codetrans
alexsin368 Apr 17, 2025
c8c5d4f
minor updates
alexsin368 Apr 18, 2025
f59634d
fix typo
alexsin368 Apr 18, 2025
564f19c
minor fixes
alexsin368 Apr 18, 2025
5da965f
Merge branch 'opea-project:main' into val_updates_codetrans
alexsin368 Apr 18, 2025
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
17 changes: 6 additions & 11 deletions tutorial/CodeTrans/CodeTrans_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
.. _CodeTrans_Guide:

Code Translations
Code Translation
##############################

.. note:: This guide is in its early development and is a work-in-progress with
placeholder content.

Overview
********

This example showcases a code translation system that converts code from one programming language to another while preserving the original logic and functionality. The primary component is the CodeTrans MegaService, which encompasses an LLM microservice that performs the actual translation.
A lightweight Gateway service and a User Interface allow users to submit their source code in a given language and receive the translated output in another language.
A lightweight gateway service and a user interface allow users to submit their source code in a given language and receive the translated output in another language.

Purpose
*******
Expand All @@ -28,18 +25,16 @@ How It Works

1. A user specifies the source language, the target language, and the snippet of code to be translated. This request is handled by the front-end UI or via a direct API call.

2. The user’s request is sent to the CodeTrans gateway, which orchestrates the call to the LLM microservice. The gateway handles details like constructing prompts and managing responses.

2. The user’s request is sent to the CodeTrans Gateway, which orchestrates the call to the LLM MicroService. The gateway handles details like constructing prompts and managing responses.


3. The large language model processes the user’s code snippet, analyzing syntax and semantics before generating an equivalent snippet in the target language.
3. The large language model processes the user’s code snippet by analyzing syntax and semantics before generating an equivalent snippet in the target language.

4. The gateway formats the model’s output and returns the translated code to the user, either via an API response or rendered within the UI.
4. The gateway formats the model’s output and returns the translated code to the user, via an API response or rendered within the UI.


Deployment
**********
Here are some deployment options, depending on your hardware and environment:
Here are some deployment options, depending on the hardware and environment:

Single Node
+++++++++++++++
Expand Down
Loading