Updated README with instructions

README.md

@@ -1 +1,13 @@
-# dl4ds_tutor
+# dl4ds_tutor
+
+## Setup
+1. conda create -n dl4ds_tutor python=3.9 
+2. conda activate dl4ds_tutor
+3. pip install -r requirements.txt
+4. Create a .env file and add your openai api key as 'OPENAI_API_KEY=XXX'
+
+## Instructions
+1. Add files to `data/`
+2. cd code
+3. chainlit run main.py
+

code/config.yml

@@ -6,7 +6,7 @@ embedding_options:
   db_path : 'vectorstores' # str
   model : 'sentence-transformers/all-MiniLM-L6-v2' # str [sentence-transformers/all-MiniLM-L6-v2, text-embedding-ada-002']
 llm_params: 
-  use_history: False # bool
+  use_history: True # bool
   llm_loader: 'openai' # str [ctransformers, openai]
   openai_params:
     model: 'gpt-4' # str [gpt-3.5-turbo-1106, gpt-4]

docs/README.md

@@ -0,0 +1,2 @@
+# Documentation
+

requirements.txt

@@ -10,4 +10,5 @@ faiss-cpu==1.7.4
 ctransformers==0.2.27
 python-dotenv==1.0.0
 openai==1.6.1
-pymupdf==1.23.8
+pymupdf==1.23.8
+chainlit==0.7.700