add requirements+README

README.md

@@ -0,0 +1,34 @@
+### Gradio app to run QA on a given website
+
+What does the app do :
+- Get input prompt (text or transcribed audio)
+- Similarity search in a vector DB, returns top k chunks
+- Run llm based on context (using basic prompt - langchain not used yet)
+- Return response and metadata (url, scores, text chunks...)
+
+Setup process:
+- vector store (FAISS) a given website (sitemap) using langchain
+- download a llm
+- containarise stt (faster-whisper) due to os incompatibility
+- build Gradio app
+
+To build Faster-whisper docker image name "fasterwhisper"
+
+`docker build -t . fasterwhisper`
+
+Create python env 'llama'
+```
+conda create --name="llama" python=3.10
+conda activate llama
+pip install -r requirements.txt
+```
+
+To run the app:
+
+`bash run.sh`
+
+To push to hugging face (including large files) use this command: 
+
+`git lfs migrate import --everything`
+
+`git add .; git commit -m "message"; git push -f origin`

requirements.txt

@@ -0,0 +1,9 @@
+faster_whisper==0.6.0
+Flask==2.3.2
+gradio==3.35.2
+langchain==0.0.225
+llama_cpp_python==0.2.7
+Requests==2.31.0
+torch==2.0.1
+transformers==4.30.2
+faiss-cpu==1.7.4