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.

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

Jump to bottom

Sample Guide Cleanup post 1.2 Release #293

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Sample Guide Cleanup post 1.2 Release #293

wants to merge 13 commits into from
+994 −939

Conversation

alexsin368
Copy link
Collaborator

Updates to the following sample guides: ChatQnA, CodeGen, CodeTrans, DocSum

Changes:

  • Use absolute paths instead of relative paths to avoid failures when running commands
  • Update steps to download a specific release version of OPEA
  • Update models used in each example
  • ChatQnA: since vLLM is the default model serving engine, updated instructions accordingly
  • Made all code blocks with "bash" for readability

yinghu5
yinghu5 approved these changes Feb 5, 2025
View reviewed changes
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

thank you, LGTM!

@alexsin368 alexsin368 force-pushed the sample_guide_version_cleanup branch from b5ce7f8 to fa60efe Compare February 6, 2025 00:33
@alexsin368
chatqna sample guide repo version cleanup
c8e5c99 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
update where default llm service is vllm
27f369f 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
fix UI docker image tags
6831db6 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
update codegen sample guides to use specified release versions
8c4f192 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
remove ITDC from intro
0bf0434 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
update intros
bec2ff6 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
typo
811a3a1 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
update to use specified release versions
90fa80c 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
update models used in examples
27b0987 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
update docsum sample guides to specify release versions
3f82370 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
navigate into workspace, add bash to code blocks for readability, use…
15d81af 
… absolute paths

Signed-off-by: alexsin368 <[email protected]>
@alexsin368
fix hyperlinks and use relative path for Getting Started Guide
96f29e7 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368
fix broken paths to sections in doc
8263462 
Signed-off-by: alexsin368 <[email protected]>
@alexsin368 alexsin368 force-pushed the sample_guide_version_cleanup branch from fa60efe to 8263462 Compare February 12, 2025 03:21
yinghu5
yinghu5 approved these changes Feb 12, 2025
View reviewed changes
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NeoZhangJianyu NeoZhangJianyu NeoZhangJianyu left review comments

@yinghu5 yinghu5 yinghu5 approved these changes

@chensuyue chensuyue Awaiting requested review from chensuyue chensuyue is a code owner

@ftian1 ftian1 Awaiting requested review from ftian1 ftian1 is a code owner

@mkbhanda mkbhanda Awaiting requested review from mkbhanda mkbhanda is a code owner

@preethivenkatesh preethivenkatesh Awaiting requested review from preethivenkatesh preethivenkatesh is a code owner

@chickenrae chickenrae Awaiting requested review from chickenrae chickenrae is a code owner

@tomlenth tomlenth Awaiting requested review from tomlenth tomlenth is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alexsin368 @yinghu5 @NeoZhangJianyu