Skip to content

Conversation

@alexsin368
Copy link
Collaborator

@alexsin368 alexsin368 commented Apr 15, 2025

  • Remove steps to build images: just use docker compose to pull images instead
  • Add steps for running with vLLM and TGI
  • Update steps to validate microservices, including newly added dataprep
  • Remove extra UI options, only need to show the default one for Gradio
  • Update steps for port forwarding and changing BACKEND_SERVICE_IP for UI to work
  • Fix grammar and improve wording

@alexsin368 alexsin368 added v1.3 documentation Improvements or additions to documentation labels Apr 15, 2025
@yinghu5 yinghu5 requested review from Copilot and yinghu5 April 16, 2025 02:59
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR simplifies and updates the CodeGen tutorial deployment guides by removing redundant steps and improving the clarity of instructions. Key changes include updated port forwarding examples, revised deployment commands for both vLLM and TGI services, and improved language and grammar throughout the tutorials.

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.

File Description
tutorial/CodeGen/deploy/xeon.md Revised instructions, fixed grammar issues, and updated commands for deploying on Xeon.
tutorial/CodeGen/deploy/gaudi.md Updated deployment steps and commands for Gaudi deployments, with updated model details.
Files not reviewed (1)
  • tutorial/CodeGen/CodeGen_Guide.rst: Language not supported

@joshuayao joshuayao added this to OPEA Apr 16, 2025
@joshuayao joshuayao added this to the v1.3 milestone Apr 16, 2025
@joshuayao joshuayao moved this to In review in OPEA Apr 16, 2025
Copy link
Collaborator

@mkbhanda mkbhanda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do a quick check for consistency/recommendation on model (7B versus 32B) for Xeon versus Gaudi. Also add a recommendation on instance size so user will be successful in running the application.

Copy link
Collaborator Author

@alexsin368 alexsin368 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed all comments

Signed-off-by: alexsin368 <[email protected]>
Copy link
Collaborator Author

@alexsin368 alexsin368 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed comments

Copy link
Collaborator

@mkbhanda mkbhanda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mkbhanda mkbhanda merged commit 54dc287 into opea-project:main Apr 18, 2025
4 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in OPEA Apr 18, 2025
@alexsin368 alexsin368 deleted the val_updates_codegen branch April 22, 2025 00:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v1.3

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

7 participants