Updated ReadMe for ChatQnA

opea-project / GenAIExamples

Generative AI Examples is a collection of GenAI examples such as ChatQnA, Copilot, which illustrate the pipeline capabilities of the Open Platform for Enterprise AI (OPEA) project.

https://opea.dev

Apache License 2.0

173 stars 81 forks source link

Updated ReadMe for ChatQnA #264

Closed srinarayan-srikanthan closed 3 weeks ago

srinarayan-srikanthan commented 3 weeks ago

Description

Updated the readme for chatqna with path fix and added cd instructions for reproducibility.

Issues

PR # 231 and 232

Type of change

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

[x] 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)

Dependencies

N/A

Tests

Describe the tests that you ran to verify your changes.

srinarayan-srikanthan commented 3 weeks ago

I can create similar PR for other examples once this is approved.

dcmiddle commented 3 weeks ago

I think I have all the path fixes here: https://github.com/opea-project/GenAIExamples/pull/260

srinarayan-srikanthan commented 3 weeks ago

Yes i see you have covered it in that PR, one thing that i also added is cd instructions to make sure copy paste instructions work instead of users not having to worry about the current directories.

kevinintel commented 3 weeks ago

Should we merge this PR or https://github.com/opea-project/GenAIExamples/pull/260 ?