Skip to content

Documentation and diagram update for MultimodalQnA phase 3 enhancements#58

Merged
dmsuehir merged 5 commits into
mmqna-phase3from
dina/phase3-docs
Feb 20, 2025
Merged

Documentation and diagram update for MultimodalQnA phase 3 enhancements#58
dmsuehir merged 5 commits into
mmqna-phase3from
dina/phase3-docs

Conversation

@dmsuehir
Copy link
Copy Markdown
Collaborator

Description

This PR updates:

  • The mermaid diagram in the main MultimodalQnA README to more accurately reflect the Microservices being used.
  • Adds a blurb about the function of the Microservices that I added to the diagram (whisper and speecht5)
  • Based on our blog review meeting, I added a directory structure diagram for docker_compose.
  • There were some command that didn't work out of the box. For example, trying to source the set_env.sh file from a different directory gave an error, so changed it to first cd to that directory.
  • For the proxy environment vars, the set_env.sh files were doing things like export http_proxy=${your_http_proxy}, however the main README does not say to set your_http_proxy as an env var (it says to set the real var http_proxy, etc). The README files in docker_compose did mention your_no_proxy so I changed those to just be no_proxy. I checked other examples like ChatQnA and their set_env.sh does not try to set proxy envs, so hopefully these are fine to remove.
  • Updated the Gaudi driver version mentioned, because the embedding container is built from the v1.18 base (source) and the tgi-gaudi container is version v2.3.1 which supports synapse 1.19 but our machines have v1.18 and it works there as well.

Issues

RFC: https://github.com/opea-project/docs/blob/main/community/rfcs/24-10-02-GenAIExamples-001-Image_and_Audio_Support_in_MultimodalQnA.md
Issue: opea-project#1549

Type of change

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

  • Others (enhancement, documentation, validation, etc.)

Dependencies

N/A

Tests

Manually tested README commands

Signed-off-by: dmsuehir <dina.s.jones@intel.com>
Signed-off-by: dmsuehir <dina.s.jones@intel.com>
Signed-off-by: dmsuehir <dina.s.jones@intel.com>
@dmsuehir dmsuehir requested a review from mhbuehler as a code owner February 20, 2025 00:26
Copy link
Copy Markdown
Collaborator

@okhleif-10 okhleif-10 left a comment

Choose a reason for hiding this comment

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

Looks much better and cleaner this way. Diagram makes sense. LGTM

Comment thread MultimodalQnA/README.md Outdated
Comment thread MultimodalQnA/docker_compose/intel/cpu/xeon/README.md
Signed-off-by: dmsuehir <dina.s.jones@intel.com>
Copy link
Copy Markdown
Collaborator

@HarshaRamayanam HarshaRamayanam left a comment

Choose a reason for hiding this comment

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

Thanks. LGTM

Copy link
Copy Markdown
Owner

@mhbuehler mhbuehler left a comment

Choose a reason for hiding this comment

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

NICE!

@dmsuehir dmsuehir merged commit 6faf0bb into mmqna-phase3 Feb 20, 2025
@dmsuehir dmsuehir deleted the dina/phase3-docs branch February 20, 2025 22:00
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.

4 participants