README.md

UI and online evaluation

This directory contains docker containerization to run user interface and online evaluation as well as monitoring

How to reproduce

Follow these steps

pip install -r requirements.txt

Enter your groq api key in the .env file to run

# PostgreSQL Configuration
POSTGRES_HOST=localhost
POSTGRES_DB=course_assistant
POSTGRES_USER=your_username
POSTGRES_PASSWORD=your_password
POSTGRES_PORT=5432

# Elasticsearch Configuration
ELASTIC_URL_LOCAL=http://localhost:9200
ELASTIC_URL=http://elasticsearch:9200
ELASTIC_PORT=9200

# Ollama Configuration
# OLLAMA_PORT=11434

# Streamlit Configuration
STREAMLIT_PORT=8501

# Other Configuration
MODEL_NAME=multi-qa-MiniLM-L6-cos-v1
INDEX_NAME=vietnamese-questions
GROQ_API_KEY='Your GROQ_API Key'

Then run the docker-compose command

docker-compose up

After run docker-compose, run this command to index and set up database

python prep.py

Then open port 8501 to open Streamlit app

You can open Grafana at port 3000 with default username and password is admin

(Optional) You can run

python generate_data.py

to generate synthetic data for grafana

How to run Grafana

After you open Grafana at port 3000 and enter default username and password as admin , you will be asked to update password, and you can choose to skip it.

Next, you add data sources by clicking to Data Sources section and choose PostgreSQL

Next, you enter the information
Host: postgres
Database : course_assistant
User : POSTGRES_USER, POSTGRES_PASSWORD in your .env file,
TLS/SSL Mode: disabled

then click Save & test and then back to Home and click Dashboards -> Add visualization -> Select data sources and then use queries to create visualizations