Skip to content

Update DocSum README and environment configuration#1917

Merged
ashahba merged 24 commits into
opea-project:mainfrom
daniel-de-leon-user293:daniel/docsum-dr
May 15, 2025
Merged

Update DocSum README and environment configuration#1917
ashahba merged 24 commits into
opea-project:mainfrom
daniel-de-leon-user293:daniel/docsum-dr

Conversation

@daniel-de-leon-user293

Copy link
Copy Markdown
Contributor

Description

Updates to DocSum documentation and environment configurations

Issues

n/a

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)
  • Others (enhancement, documentation, validation, etc.)

Dependencies

n/a

Tests

Manual walkthrough of the README and DocSum Gaudi unit test

Signed-off-by: Daniel Deleon <daniel.de.leon@intel.com>
@github-actions

github-actions Bot commented May 7, 2025

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

@daniel-de-leon-user293 daniel-de-leon-user293 changed the title Update Update DocSum README and environment configuration May 8, 2025

@MSCetin37 MSCetin37 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

Comment thread DocSum/docker_compose/intel/cpu/xeon/README.md Outdated
Comment thread DocSum/docker_compose/intel/hpu/gaudi/README.md Outdated
Signed-off-by: Daniel Deleon <daniel.de.leon@intel.com>

@ashahba ashahba left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM!

@eero-t eero-t left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why this disables vLLM warmup? On Gaudi warmup is too long for autoscaling to be responsive, and it's rather annoying also in development, but do you have some numbers on what's the runtime performance impact of disabling the warmup for "normal" usage?

@eero-t

eero-t commented May 12, 2025

Copy link
Copy Markdown
Contributor
 + RESPONSE_BODY='Internal Server Error'
+ docker logs docsum-xeon-backend-server
...
 requests.exceptions.ReadTimeout: HTTPConnectionPool(host='10.244.159.134', port=9000): Read timed out. (read timeout=1000)
+ '[' 500 -ne 200 ']'
+ echo '[ docsum-xeon-backend-server ] HTTP status is not 200. Received status was 500'
+ exit 1
[ docsum-xeon-backend-server ] HTTP status is not 200. Received status was 500

=> PR to double the timeout time was merged today, it may be enough to get CI passing for this: opea-project/GenAIComps#1687

Signed-off-by: Daniel Deleon <daniel.de.leon@intel.com>
Signed-off-by: Daniel Deleon <daniel.de.leon@intel.com>
@chensuyue

Copy link
Copy Markdown
Collaborator

Know issue, please wait for fix #1936

Signed-off-by: Daniel Deleon <daniel.de.leon@intel.com>
@daniel-de-leon-user293

Copy link
Copy Markdown
Contributor Author

Why this disables vLLM warmup? On Gaudi warmup is too long for autoscaling to be responsive, and it's rather annoying also in development, but do you have some numbers on what's the runtime performance impact of disabling the warmup for "normal" usage?

Thanks for the review @eero-t! vllm warmup was set to skip by default to reduce that developer friction that you mention. You bring up a valid point, however, that reminds me that the final state of the code should be ready for "normal" usage. And, since I don't currently have any numbers showing a difference in performance with/without vllm warmup, I went ahead and set the default to not skip vllm warmup. I made a note in the README to remind developers they can manually set VLLM_SKIP_WARMUP to true.

@eero-t eero-t left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved, but note that this overlaps with changes in #1942.

Comment thread DocSum/docker_compose/intel/cpu/xeon/README.md Outdated
daniel-de-leon-user293 and others added 3 commits May 13, 2025 10:43
Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>
Signed-off-by: Daniel Deleon <daniel.de.leon@intel.com>
@ashahba ashahba merged commit 3fb59a9 into opea-project:main May 15, 2025
14 checks passed
cogniware-devops pushed a commit to Cogniware-Inc/GenAIExamples that referenced this pull request Dec 19, 2025
Signed-off-by: Daniel Deleon <daniel.de.leon@intel.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Abolfazl Shahbazi <12436063+ashahba@users.noreply.github.com>
Co-authored-by: chen, suyue <suyue.chen@intel.com>
Co-authored-by: Eero Tamminen <eero.t.tamminen@intel.com>
Co-authored-by: Zhenzhong Xu <zhenzhong.xu@intel.com>
Signed-off-by: cogniware-devops <ambarish.desai@cogniware.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants