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

Documentation: DocSum main README motivation #338

Closed
mkbhanda opened this issue Jun 27, 2024 · 1 comment
Closed

Documentation: DocSum main README motivation #338

mkbhanda opened this issue Jun 27, 2024 · 1 comment
Assignees
Labels
aitce documentation Improvements or additions to documentation
Milestone

Comments

@mkbhanda
Copy link
Collaborator

mkbhanda commented Jun 27, 2024

The motivation paragraph-2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

gets prematurelyhttps://github.com/opea-project/GenAIExamples/tree/main/DocSum#readme

Further the HW options figure implies by not mentioning Xeon in the TGI area that one needs Gaudi when that is not the case.

The document also does not at the end branch off into docker versus Kubernetes instructions. I will try to address this last as part of Kubernetes support soon.

@yinghu5 yinghu5 added the aitce label Jul 1, 2024
@yinghu5 yinghu5 added the documentation Improvements or additions to documentation label Jul 2, 2024
@yinghu5 yinghu5 added this to the v0.9 milestone Jul 25, 2024
@yinghu5 yinghu5 added this to OPEA Jul 25, 2024
@yinghu5 yinghu5 modified the milestones: v0.9, v0.8 Jul 25, 2024
yinghu5 added a commit that referenced this issue Aug 19, 2024
According to ##338: 

The motivation paragraph 2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

so Remove the paragraph 1 as it is not related.
yinghu5 added a commit that referenced this issue Aug 19, 2024
…h-1 (#621)

* Update README.md

According to ##338: 

The motivation paragraph 2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

so Remove the paragraph 1 as it is not related.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@yinghu5
Copy link
Collaborator

yinghu5 commented Aug 19, 2024

Hi mkbhanda,

Fixed the first part by #621, please help review and add other parts if needed.

thank you!

@yinghu5 yinghu5 closed this as completed Aug 20, 2024
@github-project-automation github-project-automation bot moved this to Done in OPEA Aug 20, 2024
heavendev715 pushed a commit to heavendev715/AI-examples that referenced this issue Sep 8, 2024
…h-1 (#621)

* Update README.md

According to #opea-project/GenAIExamples#338: 

The motivation paragraph 2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

so Remove the paragraph 1 as it is not related.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
dmsuehir pushed a commit to dmsuehir/GenAIExamples that referenced this issue Sep 11, 2024
…h-1 (opea-project#621)

* Update README.md

According to #opea-project#338: 

The motivation paragraph 2 is more general and perhaps should move up as paragraph-1. Original paragraph-1 gets too specific into legal documents prematurely.

so Remove the paragraph 1 as it is not related.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aitce documentation Improvements or additions to documentation
Projects
Status: Done
Development

No branches or pull requests

2 participants